insideout10 / wordlift-plugin

src/wordlift_constants.php

Indentation +31 added lines, -31 removed lines

@@ -5,14 +5,14 @@ 
 
 // Define the basic options for HTTP calls to REDLINK.
 define( 'WL_REDLINK_API_HTTP_OPTIONS', serialize( array(
-	'timeout'         => 300,
-	'redirection'     => 5,
-	'httpversion'     => '1.1',
-	'blocking'        => true,
-	'cookies'         => array(),
-	'sslverify'       => ( 'false' === getenv( 'WL_SSL_VERIFY_ENABLED' ) ) ? false : true,
-	'sslcertificates' => dirname( __FILE__ ) . '/ssl/ca-bundle.crt',
-	'decompress'      => false
+    'timeout'         => 300,
+    'redirection'     => 5,
+    'httpversion'     => '1.1',
+    'blocking'        => true,
+    'cookies'         => array(),
+    'sslverify'       => ( 'false' === getenv( 'WL_SSL_VERIFY_ENABLED' ) ) ? false : true,
+    'sslcertificates' => dirname( __FILE__ ) . '/ssl/ca-bundle.crt',
+    'decompress'      => false
 ) ) );
 
 // Create a unique ID for this request, useful to hook async HTTP requests.
@@ -36,14 +36,14 @@ 
  */
 function wl_prefixes() {
 
-	$items    = wl_prefixes_list();
-	$prefixes = array();
+    $items    = wl_prefixes_list();
+    $prefixes = array();
 
-	foreach ( $items as $item ) {
-		$prefixes[ $item['prefix'] ] = $item['namespace'];
-	}
+    foreach ( $items as $item ) {
+        $prefixes[ $item['prefix'] ] = $item['namespace'];
+    }
 
-	return $prefixes;
+    return $prefixes;
 
 }
 
@@ -56,22 +56,22 @@ 
  */
 function wl_predicates() {
 
-	return array(
-		'a',
-		'dct:references',
-		'dct:relation',
-		'dct:title',
-		'dct:subject',
-		'owl:sameAs',
-		'rdfs:label',
-		'schema:author',
-		'schema:dateModified',
-		'schema:datePublished',
-		'schema:locationCreated',
-		'schema:description',
-		'schema:image',
-		'schema:interactionCount',
-		'schema:url'
-	);
+    return array(
+        'a',
+        'dct:references',
+        'dct:relation',
+        'dct:title',
+        'dct:subject',
+        'owl:sameAs',
+        'rdfs:label',
+        'schema:author',
+        'schema:dateModified',
+        'schema:datePublished',
+        'schema:locationCreated',
+        'schema:description',
+        'schema:image',
+        'schema:interactionCount',
+        'schema:url'
+    );
 
 }

src/modules/analyzer/wordlift_analyzer.php

Indentation +37 added lines, -37 removed lines

@@ -10,14 +10,14 @@ 
  */
 function wl_ajax_analyze_action() {
 
-	if ( $analysis = wl_analyze_content( file_get_contents( "php://input" ) ) ) {
-		header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
-		echo( $analysis );
-		wp_die();
-	}
+    if ( $analysis = wl_analyze_content( file_get_contents( "php://input" ) ) ) {
+        header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
+        echo( $analysis );
+        wp_die();
+    }
 
-	status_header( 500 );
-	wp_send_json( __( 'An error occurred while request an analysis to the remote service. Please try again later.', 'wordlift' ) );
+    status_header( 500 );
+    wp_send_json( __( 'An error occurred while request an analysis to the remote service. Please try again later.', 'wordlift' ) );
 
 }
 
@@ -37,43 +37,43 @@ 
  */
 function wl_analyze_content( $content ) {
 
-	// Get the analyzer URL.
-	$url = wl_configuration_get_analyzer_url();
+    // Get the analyzer URL.
+    $url = wl_configuration_get_analyzer_url();
 
-	// Set the content type to the request content type or to text/plain by default.
-	$content_type = isset( $_SERVER['CONTENT_TYPE'] ) ? $_SERVER['CONTENT_TYPE'] : 'text/plain';
+    // Set the content type to the request content type or to text/plain by default.
+    $content_type = isset( $_SERVER['CONTENT_TYPE'] ) ? $_SERVER['CONTENT_TYPE'] : 'text/plain';
 
-	// Prepare the request.
-	$args = array_merge_recursive( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
-		'method'      => 'POST',
-		'headers'     => array(
-			'Accept'       => 'application/json',
-			'Content-type' => $content_type
-		),
-		// we need to downgrade the HTTP version in this case since chunked encoding is dumping numbers in the response.
-		'httpversion' => '1.0',
-		'body'        => $content
-	) );
+    // Prepare the request.
+    $args = array_merge_recursive( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
+        'method'      => 'POST',
+        'headers'     => array(
+            'Accept'       => 'application/json',
+            'Content-type' => $content_type
+        ),
+        // we need to downgrade the HTTP version in this case since chunked encoding is dumping numbers in the response.
+        'httpversion' => '1.0',
+        'body'        => $content
+    ) );
 
-	$response = wp_remote_post( $url, $args );
+    $response = wp_remote_post( $url, $args );
 
-	// If an error has been raised, return the error.
-	if ( is_wp_error( $response ) || 200 !== (int) $response['response']['code'] ) {
+    // If an error has been raised, return the error.
+    if ( is_wp_error( $response ) || 200 !== (int) $response['response']['code'] ) {
 
-		$body = ( is_wp_error( $response ) ? $response->get_error_message() : $response['body'] );
+        $body = ( is_wp_error( $response ) ? $response->get_error_message() : $response['body'] );
 
-		wl_write_log( "error [ url :: $url ][ args :: " );
-		wl_write_log( var_export( $args, TRUE ) );
-		wl_write_log( '][ response :: ' );
-		wl_write_log( "\n" . var_export( $response, TRUE ) );
-		wl_write_log( "][ body :: " );
-		wl_write_log( "\n" . $body );
-		wl_write_log( "]" );
+        wl_write_log( "error [ url :: $url ][ args :: " );
+        wl_write_log( var_export( $args, TRUE ) );
+        wl_write_log( '][ response :: ' );
+        wl_write_log( "\n" . var_export( $response, TRUE ) );
+        wl_write_log( "][ body :: " );
+        wl_write_log( "\n" . $body );
+        wl_write_log( "]" );
 
-		return NULL;
-	}
+        return NULL;
+    }
 
-	wl_write_log( "[ url :: $url ][ response code :: " . $response['response']['code'] . " ]" );
+    wl_write_log( "[ url :: $url ][ response code :: " . $response['response']['code'] . " ]" );
 
-	return $response['body'];
+    return $response['body'];
 }

Spacing +21 added lines, -21 removed lines

@@ -10,18 +10,18 @@ 
  */
 function wl_ajax_analyze_action() {
 
-	if ( $analysis = wl_analyze_content( file_get_contents( "php://input" ) ) ) {
-		header( 'Content-Type: application/json; charset=' . get_option( 'blog_charset' ) );
-		echo( $analysis );
+	if ($analysis = wl_analyze_content(file_get_contents("php://input"))) {
+		header('Content-Type: application/json; charset='.get_option('blog_charset'));
+		echo($analysis);
 		wp_die();
 	}
 
-	status_header( 500 );
-	wp_send_json( __( 'An error occurred while request an analysis to the remote service. Please try again later.', 'wordlift' ) );
+	status_header(500);
+	wp_send_json(__('An error occurred while request an analysis to the remote service. Please try again later.', 'wordlift'));
 
 }
 
-add_action( 'wp_ajax_wordlift_analyze', 'wl_ajax_analyze_action' );
+add_action('wp_ajax_wordlift_analyze', 'wl_ajax_analyze_action');
 
 /**
  * Analyze the provided content. The analysis will make use of the method *wl_ajax_analyze_action*
@@ -35,16 +35,16 @@ 
  *
  * @return string Returns null on failure, or the WP_Error, or a WP_Response with the response.
  */
-function wl_analyze_content( $content ) {
+function wl_analyze_content($content) {
 
 	// Get the analyzer URL.
 	$url = wl_configuration_get_analyzer_url();
 
 	// Set the content type to the request content type or to text/plain by default.
-	$content_type = isset( $_SERVER['CONTENT_TYPE'] ) ? $_SERVER['CONTENT_TYPE'] : 'text/plain';
+	$content_type = isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : 'text/plain';
 
 	// Prepare the request.
-	$args = array_merge_recursive( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
+	$args = array_merge_recursive(unserialize(WL_REDLINK_API_HTTP_OPTIONS), array(
 		'method'      => 'POST',
 		'headers'     => array(
 			'Accept'       => 'application/json',
@@ -53,27 +53,27 @@ 
 		// we need to downgrade the HTTP version in this case since chunked encoding is dumping numbers in the response.
 		'httpversion' => '1.0',
 		'body'        => $content
-	) );
+	));
 
-	$response = wp_remote_post( $url, $args );
+	$response = wp_remote_post($url, $args);
 
 	// If an error has been raised, return the error.
-	if ( is_wp_error( $response ) || 200 !== (int) $response['response']['code'] ) {
+	if (is_wp_error($response) || 200 !== (int) $response['response']['code']) {
 
-		$body = ( is_wp_error( $response ) ? $response->get_error_message() : $response['body'] );
+		$body = (is_wp_error($response) ? $response->get_error_message() : $response['body']);
 
-		wl_write_log( "error [ url :: $url ][ args :: " );
-		wl_write_log( var_export( $args, TRUE ) );
-		wl_write_log( '][ response :: ' );
-		wl_write_log( "\n" . var_export( $response, TRUE ) );
-		wl_write_log( "][ body :: " );
-		wl_write_log( "\n" . $body );
-		wl_write_log( "]" );
+		wl_write_log("error [ url :: $url ][ args :: ");
+		wl_write_log(var_export($args, TRUE));
+		wl_write_log('][ response :: ');
+		wl_write_log("\n".var_export($response, TRUE));
+		wl_write_log("][ body :: ");
+		wl_write_log("\n".$body);
+		wl_write_log("]");
 
 		return NULL;
 	}
 
-	wl_write_log( "[ url :: $url ][ response code :: " . $response['response']['code'] . " ]" );
+	wl_write_log("[ url :: $url ][ response code :: ".$response['response']['code']." ]");
 
 	return $response['body'];
 }

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

Indentation +782 added lines, -782 removed lines

@@ -7,789 +7,789 @@
  */
 class Wordlift_Schema_Service {
 
-	/**
-	 * The 'location created' field name.
-	 *
-	 * @since 3.5.0
-	 */
-	const FIELD_LOCATION_CREATED = 'wl_location_created';
-
-	/**
-	 * The 'topic' field name.
-	 *
-	 * @since 3.5.0
-	 */
-	const FIELD_TOPIC = 'wl_topic';
-
-	/**
-	 * The 'author' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_AUTHOR = 'wl_author';
-
-	/**
-	 * The 'same as' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_SAME_AS = 'entity_same_as';
-
-	/**
-	 * The 'date start' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_DATE_START = 'wl_cal_date_start';
-
-	/**
-	 * The 'date end' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_DATE_END = 'wl_cal_date_end';
-
-	/**
-	 * The 'location' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_LOCATION = 'wl_location';
-
-	/**
-	 * The 'founder' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_FOUNDER = 'wl_founder';
-
-	/**
-	 * The 'knows' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_KNOWS = 'wl_knows';
-
-	/**
-	 * The 'birth date' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_BIRTH_DATE = 'wl_birth_date';
-
-	/**
-	 * The 'birth place' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_BIRTH_PLACE = 'wl_birth_place';
-
-	/**
-	 * The 'latitude' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_GEO_LATITUDE = 'wl_geo_latitude';
-
-	/**
-	 * The 'longitude' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_GEO_LONGITUDE = 'wl_geo_longitude';
-
-	/**
-	 * The 'streetAddress' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_ADDRESS = 'wl_address';
-
-	/**
-	 * The 'postOfficeBoxNumber' field name.
-	 *
-	 * @since 3.3.0
-	 */
-	const FIELD_ADDRESS_PO_BOX = 'wl_address_post_office_box';
-
-	/**
-	 * The 'postalCode' field name.
-	 *
-	 * @since 3.3.0
-	 */
-	const FIELD_ADDRESS_POSTAL_CODE = 'wl_address_postal_code';
-
-	/**
-	 * The 'addressLocality' field name.
-	 *
-	 * @since 3.3.0
-	 */
-	const FIELD_ADDRESS_LOCALITY = 'wl_address_locality';
-	/**
-	 * The 'addressRegion' field name.
-	 *
-	 * @since 3.3.0
-	 */
-	const FIELD_ADDRESS_REGION = 'wl_address_region';
-
-	/**
-	 * The 'addressCountry' field name.
-	 *
-	 * @since 3.3.0
-	 */
-	const FIELD_ADDRESS_COUNTRY = 'wl_address_country';
-
-	/**
-	 * The 'entity type' field name.
-	 *
-	 * @since 3.1.0
-	 */
-	const FIELD_ENTITY_TYPE = 'wl_entity_type_uri';
-
-	/**
-	 * The 'email' field name.
-	 *
-	 * @since 3.2.0
-	 */
-	const FIELD_EMAIL = 'wl_email';
-
-	/**
-	 * The 'affiliation' field name.
-	 *
-	 * @since 3.2.0
-	 */
-	const FIELD_AFFILIATION = 'wl_affiliation';
-
-	/**
-	 * The 'URI' data type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const DATA_TYPE_URI = 'uri';
-
-	/**
-	 * The 'date' data type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const DATA_TYPE_DATE = 'date';
-
-	/**
-	 * The 'double' data type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const DATA_TYPE_DOUBLE = 'double';
-
-	/**
-	 * The 'string' data type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const DATA_TYPE_STRING = 'string';
-
-	/**
-	 * The 'integer' data type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const DATA_TYPE_INTEGER = 'int';
-
-	/**
-	 * The 'boolean' data type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const DATA_TYPE_BOOLEAN = 'bool';
-
-	/**
-	 * The schema.org Event type URI.
-	 *
-	 * @since 3.1.0
-	 */
-	const SCHEMA_EVENT_TYPE = 'http://schema.org/Event';
-
-	/**
-	 * The Schema service singleton instance.
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var \Wordlift_Schema_Service $instance The Schema service singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * WordLift's schema.
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var array $schema WordLift's schema.
-	 */
-	private $schema;
-
-	/**
-	 * The Log service.
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log_service The Log service.
-	 */
-	private $log_service;
-
-	/**
-	 * Wordlift_Schema_Service constructor.
-	 *
-	 * @since 3.1.0
-	 */
-	public function __construct() {
-
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Schema_Service' );
-
-		// Create a singleton instance of the Schema service, useful to provide static functions to global functions.
-		self::$instance = $this;
-
-		// Set the taxonomy data.
-		// Note: parent types must be defined before child types.
-		$this->schema = array(
-			'thing'         => $this->get_thing_schema(),
-			'creative-work' => $this->get_creative_work_schema(),
-			'event'         => $this->get_event_schema(),
-			'organization'  => $this->get_organization_schema(),
-			'person'        => $this->get_person_schema(),
-			'place'         => $this->get_place_schema(),
-			'localbusiness' => $this->get_local_business_schema()
-		);
-
-	}
-
-	/**
-	 * Get a reference to the Schema service.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @return Wordlift_Schema_Service A reference to the Schema service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the properties for a field with the specified key. The key is used as
-	 * meta key when the field's value is stored in WordPress meta data table.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $key The field's key.
-	 *
-	 * @return null|array An array of field's properties or null if the field is not found.
-	 */
-	public function get_field( $key ) {
-
-		// Parse each schema's fields until we find the one we're looking for, then
-		// return its properties.
-		foreach ( $this->schema as $_ => $schema ) {
-
-			if ( ! isset( $schema['custom_fields'] ) ) {
-				break;
-			}
-
-			foreach ( $schema['custom_fields'] as $field => $props ) {
-				if ( $key === $field ) {
-					return $props;
-				}
-			}
-		}
-
-		return NULL;
-	}
-
-	/**
-	 * Get the WordLift's schema.
-	 *
-	 * @param string $name The schema name.
-	 *
-	 * @return array|null An array with the schema configuration or NULL if the schema is not found.
-	 *
-	 * @since 3.1.0
-	 */
-	public function get_schema( $name ) {
-
-		// $this->log_service->trace( "Get schema [ name :: $name ]" );
-
-		// Check if the schema exists and, if not, return NULL.
-		if ( ! isset( $this->schema[ $name ] ) ) {
-			return NULL;
-		}
-
-		// Return the requested schema.
-		return $this->schema[ $name ];
-	}
-
-	/**
-	 * Get the WordLift's schema trough schema type uri.
-	 *
-	 * @param string $uri The schema uri.
-	 *
-	 * @return array|null An array with the schema configuration or NULL if the schema is not found.
-	 *
-	 * @since 3.3.0
-	 */
-	public function get_schema_by_uri( $uri ) {
-
-		foreach ( $this->schema as $name => $schema ) {
-			if ( $schema['uri'] === $uri ) {
-				return $schema;
-			}
-		}
-
-		return NULL;
-
-		// Return the requested schema.
-		return $this->schema[ $name ];
-	}
-
-	/**
-	 * Get the 'thing' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_thing_schema() {
-
-		return array(
-			'css_class'          => 'wl-thing',
-			'uri'                => 'http://schema.org/Thing',
-			'same_as'            => array( '*' ),
-			// set as default.
-			'custom_fields'      => array(
-				self::FIELD_SAME_AS                            => array(
-					'predicate'   => 'http://schema.org/sameAs',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/Thing',
-					'constraints' => array(
-						'cardinality' => INF
-					),
-					'input_field' => 'sameas'   // we need a custom metabox
-				),
-				// Add the schema:url property.
-				Wordlift_Schema_Url_Property_Service::META_KEY => Wordlift_Schema_Url_Property_Service::get_instance()
-				                                                                                      ->get_compat_definition()
-			),
-			// {{sameAs}} not present in the microdata template,
-			// because it is treated separately in *wl_content_embed_item_microdata*
-			'microdata_template' => '',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-	}
-
-	/**
-	 * Get the 'creative work' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_creative_work_schema() {
-
-		$schema = array(
-			'label'              => 'CreativeWork',
-			'description'        => 'A creative work (or a Music Album).',
-			'parents'            => array( 'thing' ),
-			// give term slug as parent
-			'css_class'          => 'wl-creative-work',
-			'uri'                => 'http://schema.org/CreativeWork',
-			'same_as'            => array(
-				'http://schema.org/MusicAlbum',
-				'http://schema.org/Product'
-			),
-			'custom_fields'      => array(
-				self::FIELD_AUTHOR => array(
-					'predicate'   => 'http://schema.org/author',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/Person',
-					'constraints' => array(
-						'uri_type'    => array( 'Person', 'Organization' ),
-						'cardinality' => INF
-					)
-				),
-			),
-			'microdata_template' => '{{author}}',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-		// Merge the custom fields with those provided by the thing schema.
-		$thing_schema            = $this->get_thing_schema();
-		$schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
-
-		return $schema;
-	}
-
-	/**
-	 * Get the 'event' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_event_schema() {
-
-		$schema = array(
-			'label'              => 'Event',
-			'description'        => 'An event . ',
-			'parents'            => array( 'thing' ),
-			'css_class'          => 'wl-event',
-			'uri'                => self::SCHEMA_EVENT_TYPE,
-			'same_as'            => array( 'http://dbpedia.org/ontology/Event' ),
-			'custom_fields'      => array(
-				self::FIELD_DATE_START => array(
-					'predicate'   => 'http://schema.org/startDate',
-					'type'        => self::DATA_TYPE_DATE,
-					'export_type' => 'xsd:datetime',
-					'constraints' => ''
-				),
-				self::FIELD_DATE_END   => array(
-					'predicate'   => 'http://schema.org/endDate',
-					'type'        => self::DATA_TYPE_DATE,
-					'export_type' => 'xsd:datetime',
-					'constraints' => ''
-				),
-				self::FIELD_LOCATION   => array(
-					'predicate'   => 'http://schema.org/location',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/PostalAddress',
-					'constraints' => array(
-						'uri_type'    => array( 'Place', 'LocalBusiness' ),
-						'cardinality' => INF
-					)
-				)
-			),
-			'microdata_template' =>
-				'{{startDate}}
+    /**
+     * The 'location created' field name.
+     *
+     * @since 3.5.0
+     */
+    const FIELD_LOCATION_CREATED = 'wl_location_created';
+
+    /**
+     * The 'topic' field name.
+     *
+     * @since 3.5.0
+     */
+    const FIELD_TOPIC = 'wl_topic';
+
+    /**
+     * The 'author' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_AUTHOR = 'wl_author';
+
+    /**
+     * The 'same as' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_SAME_AS = 'entity_same_as';
+
+    /**
+     * The 'date start' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_DATE_START = 'wl_cal_date_start';
+
+    /**
+     * The 'date end' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_DATE_END = 'wl_cal_date_end';
+
+    /**
+     * The 'location' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_LOCATION = 'wl_location';
+
+    /**
+     * The 'founder' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_FOUNDER = 'wl_founder';
+
+    /**
+     * The 'knows' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_KNOWS = 'wl_knows';
+
+    /**
+     * The 'birth date' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_BIRTH_DATE = 'wl_birth_date';
+
+    /**
+     * The 'birth place' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_BIRTH_PLACE = 'wl_birth_place';
+
+    /**
+     * The 'latitude' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_GEO_LATITUDE = 'wl_geo_latitude';
+
+    /**
+     * The 'longitude' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_GEO_LONGITUDE = 'wl_geo_longitude';
+
+    /**
+     * The 'streetAddress' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_ADDRESS = 'wl_address';
+
+    /**
+     * The 'postOfficeBoxNumber' field name.
+     *
+     * @since 3.3.0
+     */
+    const FIELD_ADDRESS_PO_BOX = 'wl_address_post_office_box';
+
+    /**
+     * The 'postalCode' field name.
+     *
+     * @since 3.3.0
+     */
+    const FIELD_ADDRESS_POSTAL_CODE = 'wl_address_postal_code';
+
+    /**
+     * The 'addressLocality' field name.
+     *
+     * @since 3.3.0
+     */
+    const FIELD_ADDRESS_LOCALITY = 'wl_address_locality';
+    /**
+     * The 'addressRegion' field name.
+     *
+     * @since 3.3.0
+     */
+    const FIELD_ADDRESS_REGION = 'wl_address_region';
+
+    /**
+     * The 'addressCountry' field name.
+     *
+     * @since 3.3.0
+     */
+    const FIELD_ADDRESS_COUNTRY = 'wl_address_country';
+
+    /**
+     * The 'entity type' field name.
+     *
+     * @since 3.1.0
+     */
+    const FIELD_ENTITY_TYPE = 'wl_entity_type_uri';
+
+    /**
+     * The 'email' field name.
+     *
+     * @since 3.2.0
+     */
+    const FIELD_EMAIL = 'wl_email';
+
+    /**
+     * The 'affiliation' field name.
+     *
+     * @since 3.2.0
+     */
+    const FIELD_AFFILIATION = 'wl_affiliation';
+
+    /**
+     * The 'URI' data type name.
+     *
+     * @since 3.1.0
+     */
+    const DATA_TYPE_URI = 'uri';
+
+    /**
+     * The 'date' data type name.
+     *
+     * @since 3.1.0
+     */
+    const DATA_TYPE_DATE = 'date';
+
+    /**
+     * The 'double' data type name.
+     *
+     * @since 3.1.0
+     */
+    const DATA_TYPE_DOUBLE = 'double';
+
+    /**
+     * The 'string' data type name.
+     *
+     * @since 3.1.0
+     */
+    const DATA_TYPE_STRING = 'string';
+
+    /**
+     * The 'integer' data type name.
+     *
+     * @since 3.1.0
+     */
+    const DATA_TYPE_INTEGER = 'int';
+
+    /**
+     * The 'boolean' data type name.
+     *
+     * @since 3.1.0
+     */
+    const DATA_TYPE_BOOLEAN = 'bool';
+
+    /**
+     * The schema.org Event type URI.
+     *
+     * @since 3.1.0
+     */
+    const SCHEMA_EVENT_TYPE = 'http://schema.org/Event';
+
+    /**
+     * The Schema service singleton instance.
+     *
+     * @since 3.1.0
+     * @access private
+     * @var \Wordlift_Schema_Service $instance The Schema service singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * WordLift's schema.
+     *
+     * @since 3.1.0
+     * @access private
+     * @var array $schema WordLift's schema.
+     */
+    private $schema;
+
+    /**
+     * The Log service.
+     *
+     * @since 3.1.0
+     * @access private
+     * @var \Wordlift_Log_Service $log_service The Log service.
+     */
+    private $log_service;
+
+    /**
+     * Wordlift_Schema_Service constructor.
+     *
+     * @since 3.1.0
+     */
+    public function __construct() {
+
+        $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Schema_Service' );
+
+        // Create a singleton instance of the Schema service, useful to provide static functions to global functions.
+        self::$instance = $this;
+
+        // Set the taxonomy data.
+        // Note: parent types must be defined before child types.
+        $this->schema = array(
+            'thing'         => $this->get_thing_schema(),
+            'creative-work' => $this->get_creative_work_schema(),
+            'event'         => $this->get_event_schema(),
+            'organization'  => $this->get_organization_schema(),
+            'person'        => $this->get_person_schema(),
+            'place'         => $this->get_place_schema(),
+            'localbusiness' => $this->get_local_business_schema()
+        );
+
+    }
+
+    /**
+     * Get a reference to the Schema service.
+     *
+     * @since 3.1.0
+     *
+     * @return Wordlift_Schema_Service A reference to the Schema service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the properties for a field with the specified key. The key is used as
+     * meta key when the field's value is stored in WordPress meta data table.
+     *
+     * @since 3.6.0
+     *
+     * @param string $key The field's key.
+     *
+     * @return null|array An array of field's properties or null if the field is not found.
+     */
+    public function get_field( $key ) {
+
+        // Parse each schema's fields until we find the one we're looking for, then
+        // return its properties.
+        foreach ( $this->schema as $_ => $schema ) {
+
+            if ( ! isset( $schema['custom_fields'] ) ) {
+                break;
+            }
+
+            foreach ( $schema['custom_fields'] as $field => $props ) {
+                if ( $key === $field ) {
+                    return $props;
+                }
+            }
+        }
+
+        return NULL;
+    }
+
+    /**
+     * Get the WordLift's schema.
+     *
+     * @param string $name The schema name.
+     *
+     * @return array|null An array with the schema configuration or NULL if the schema is not found.
+     *
+     * @since 3.1.0
+     */
+    public function get_schema( $name ) {
+
+        // $this->log_service->trace( "Get schema [ name :: $name ]" );
+
+        // Check if the schema exists and, if not, return NULL.
+        if ( ! isset( $this->schema[ $name ] ) ) {
+            return NULL;
+        }
+
+        // Return the requested schema.
+        return $this->schema[ $name ];
+    }
+
+    /**
+     * Get the WordLift's schema trough schema type uri.
+     *
+     * @param string $uri The schema uri.
+     *
+     * @return array|null An array with the schema configuration or NULL if the schema is not found.
+     *
+     * @since 3.3.0
+     */
+    public function get_schema_by_uri( $uri ) {
+
+        foreach ( $this->schema as $name => $schema ) {
+            if ( $schema['uri'] === $uri ) {
+                return $schema;
+            }
+        }
+
+        return NULL;
+
+        // Return the requested schema.
+        return $this->schema[ $name ];
+    }
+
+    /**
+     * Get the 'thing' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_thing_schema() {
+
+        return array(
+            'css_class'          => 'wl-thing',
+            'uri'                => 'http://schema.org/Thing',
+            'same_as'            => array( '*' ),
+            // set as default.
+            'custom_fields'      => array(
+                self::FIELD_SAME_AS                            => array(
+                    'predicate'   => 'http://schema.org/sameAs',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/Thing',
+                    'constraints' => array(
+                        'cardinality' => INF
+                    ),
+                    'input_field' => 'sameas'   // we need a custom metabox
+                ),
+                // Add the schema:url property.
+                Wordlift_Schema_Url_Property_Service::META_KEY => Wordlift_Schema_Url_Property_Service::get_instance()
+                                                                                                        ->get_compat_definition()
+            ),
+            // {{sameAs}} not present in the microdata template,
+            // because it is treated separately in *wl_content_embed_item_microdata*
+            'microdata_template' => '',
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+    }
+
+    /**
+     * Get the 'creative work' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_creative_work_schema() {
+
+        $schema = array(
+            'label'              => 'CreativeWork',
+            'description'        => 'A creative work (or a Music Album).',
+            'parents'            => array( 'thing' ),
+            // give term slug as parent
+            'css_class'          => 'wl-creative-work',
+            'uri'                => 'http://schema.org/CreativeWork',
+            'same_as'            => array(
+                'http://schema.org/MusicAlbum',
+                'http://schema.org/Product'
+            ),
+            'custom_fields'      => array(
+                self::FIELD_AUTHOR => array(
+                    'predicate'   => 'http://schema.org/author',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/Person',
+                    'constraints' => array(
+                        'uri_type'    => array( 'Person', 'Organization' ),
+                        'cardinality' => INF
+                    )
+                ),
+            ),
+            'microdata_template' => '{{author}}',
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+        // Merge the custom fields with those provided by the thing schema.
+        $thing_schema            = $this->get_thing_schema();
+        $schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
+
+        return $schema;
+    }
+
+    /**
+     * Get the 'event' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_event_schema() {
+
+        $schema = array(
+            'label'              => 'Event',
+            'description'        => 'An event . ',
+            'parents'            => array( 'thing' ),
+            'css_class'          => 'wl-event',
+            'uri'                => self::SCHEMA_EVENT_TYPE,
+            'same_as'            => array( 'http://dbpedia.org/ontology/Event' ),
+            'custom_fields'      => array(
+                self::FIELD_DATE_START => array(
+                    'predicate'   => 'http://schema.org/startDate',
+                    'type'        => self::DATA_TYPE_DATE,
+                    'export_type' => 'xsd:datetime',
+                    'constraints' => ''
+                ),
+                self::FIELD_DATE_END   => array(
+                    'predicate'   => 'http://schema.org/endDate',
+                    'type'        => self::DATA_TYPE_DATE,
+                    'export_type' => 'xsd:datetime',
+                    'constraints' => ''
+                ),
+                self::FIELD_LOCATION   => array(
+                    'predicate'   => 'http://schema.org/location',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/PostalAddress',
+                    'constraints' => array(
+                        'uri_type'    => array( 'Place', 'LocalBusiness' ),
+                        'cardinality' => INF
+                    )
+                )
+            ),
+            'microdata_template' =>
+                '{{startDate}}
                                 {{endDate}}
                                 {{location}}',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-		// Merge the custom fields with those provided by the thing schema.
-		$thing_schema            = $this->get_thing_schema();
-		$schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
-
-		return $schema;
-	}
-
-	/**
-	 * Get the 'organization' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_organization_schema() {
-
-		$schema = array(
-			'label'              => 'Organization',
-			'description'        => 'An organization, including a government or a newspaper.',
-			'parents'            => array( 'thing' ),
-			'css_class'          => 'wl-organization',
-			'uri'                => 'http://schema.org/Organization',
-			'same_as'            => array(
-				'http://rdf.freebase.com/ns/organization.organization',
-				'http://rdf.freebase.com/ns/government.government',
-				'http://schema.org/Newspaper'
-			),
-			'custom_fields'      => array(
-				self::FIELD_FOUNDER             => array(
-					'predicate'   => 'http://schema.org/founder',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/Person',
-					'constraints' => array(
-						'uri_type'    => 'Person',
-						'cardinality' => INF
-					)
-				),
-				self::FIELD_ADDRESS             => array(
-					'predicate'   => 'http://schema.org/streetAddress',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_PO_BOX      => array(
-					'predicate'   => 'http://schema.org/postOfficeBoxNumber',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_POSTAL_CODE => array(
-					'predicate'   => 'http://schema.org/postalCode',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_LOCALITY    => array(
-					'predicate'   => 'http://schema.org/addressLocality',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_REGION      => array(
-					'predicate'   => 'http://schema.org/addressRegion',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_COUNTRY     => array(
-					'predicate'   => 'http://schema.org/addressCountry',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_EMAIL               => array(
-					'predicate'   => 'http://schema.org/email',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => ''
-				),
-				'wl_schema_telephone'           => array(
-					'predicate'   => 'http://schema.org/telephone',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => ''
-				),
-			),
-			'microdata_template' => '{{founder}}'
-			                        . '<span itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">{{streetAddress}}{{postOfficeBoxNumber}}{{postalCode}}{{addressLocality}}{{addressRegion}}{{addressCountry}}{{email}}</span>',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-		// Merge the custom fields with those provided by the thing schema.
-		$thing_schema            = $this->get_thing_schema();
-		$schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
-
-		return $schema;
-	}
-
-	/**
-	 * Get the 'person' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_person_schema() {
-
-		$schema = array(
-			'label'              => 'Person',
-			'description'        => 'A person (or a music artist).',
-			'parents'            => array( 'thing' ),
-			'css_class'          => 'wl-person',
-			'uri'                => 'http://schema.org/Person',
-			'same_as'            => array(
-				'http://rdf.freebase.com/ns/people.person',
-				'http://rdf.freebase.com/ns/music.artist',
-				'http://dbpedia.org/class/yago/LivingPeople'
-			),
-			'custom_fields'      => array(
-				self::FIELD_KNOWS       => array(
-					'predicate'   => 'http://schema.org/knows',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/Person',
-					'constraints' => array(
-						'uri_type'    => 'Person',
-						'cardinality' => INF
-					)
-				),
-				self::FIELD_BIRTH_DATE  => array(
-					'predicate'   => 'http://schema.org/birthDate',
-					'type'        => self::DATA_TYPE_DATE,
-					'export_type' => 'xsd:date',
-					'constraints' => ''
-				),
-				self::FIELD_BIRTH_PLACE => array(
-					'predicate'   => 'http://schema.org/birthPlace',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/Place',
-					'constraints' => array(
-						'uri_type' => 'Place'
-					)
-				),
-				self::FIELD_AFFILIATION => array(
-					'predicate'   => 'http://schema.org/affiliation',
-					'type'        => self::DATA_TYPE_URI,
-					'export_type' => 'http://schema.org/Organization',
-					'constraints' => array(
-						'uri_type'    => array(
-							'Organization',
-							'LocalBusiness'
-						),
-						'cardinality' => INF
-					)
-				),
-				self::FIELD_EMAIL       => array(
-					'predicate'   => 'http://schema.org/email',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => array(
-						'cardinality' => INF
-					)
-				)
-			),
-			'microdata_template' => '{{birthDate}}{{birthPlace}}{{knows}}{{affiliation}}{{email}}',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-		// Merge the custom fields with those provided by the thing schema.
-		$thing_schema            = $this->get_thing_schema();
-		$schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
-
-		return $schema;
-
-	}
-
-	/**
-	 * Get the 'place' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_place_schema() {
-
-		$schema = array(
-			'label'              => 'Place',
-			'description'        => 'A place.',
-			'parents'            => array( 'thing' ),
-			'css_class'          => 'wl-place',
-			'uri'                => 'http://schema.org/Place',
-			'same_as'            => array(
-				'http://rdf.freebase.com/ns/location.location',
-				'http://www.opengis.net/gml/_Feature'
-			),
-			'custom_fields'      => array(
-				self::FIELD_GEO_LATITUDE        => array(
-					'predicate'   => 'http://schema.org/latitude',
-					'type'        => self::DATA_TYPE_DOUBLE,
-					'export_type' => 'xsd:double',
-					'constraints' => '',
-					'input_field' => 'coordinates'   // to build custom metabox
-				),
-				self::FIELD_GEO_LONGITUDE       => array(
-					'predicate'   => 'http://schema.org/longitude',
-					'type'        => self::DATA_TYPE_DOUBLE,
-					'export_type' => 'xsd:double',
-					'constraints' => '',
-					'input_field' => 'coordinates'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS             => array(
-					'predicate'   => 'http://schema.org/streetAddress',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_PO_BOX      => array(
-					'predicate'   => 'http://schema.org/postOfficeBoxNumber',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_POSTAL_CODE => array(
-					'predicate'   => 'http://schema.org/postalCode',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_LOCALITY    => array(
-					'predicate'   => 'http://schema.org/addressLocality',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_REGION      => array(
-					'predicate'   => 'http://schema.org/addressRegion',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				),
-				self::FIELD_ADDRESS_COUNTRY     => array(
-					'predicate'   => 'http://schema.org/addressCountry',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					'input_field' => 'address'   // to build custom metabox
-				)
-			),
-			'microdata_template' => '<span itemprop="geo" itemscope itemtype="http://schema.org/GeoCoordinates">{{latitude}}{{longitude}}</span>'
-			                        . '<span itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">{{streetAddress}}{{postOfficeBoxNumber}}{{postalCode}}{{addressLocality}}{{addressRegion}}{{addressCountry}}</span>',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-		// Merge the custom fields with those provided by the thing schema.
-		$thing_schema            = $this->get_thing_schema();
-		$schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
-
-		return $schema;
-	}
-
-	/**
-	 * Get the 'local business' schema.
-	 *
-	 * @return array An array with the schema configuration.
-	 *
-	 * @since 3.1.0
-	 */
-	private function get_local_business_schema() {
-
-		$schema = array(
-			'label'              => 'LocalBusiness',
-			'description'        => 'A local business.',
-			'parents'            => array( 'place', 'organization' ),
-			'css_class'          => 'wl-local-business',
-			'uri'                => 'http://schema.org/LocalBusiness',
-			'same_as'            => array(
-				'http://rdf.freebase.com/ns/business/business_location',
-				'https://schema.org/Store'
-			),
-			'custom_fields'      => array(),
-			'microdata_template' => '<span itemprop="geo" itemscope itemtype="http://schema.org/GeoCoordinates">{{latitude}}{{longitude}}</span>'
-			                        . '<span itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">{{streetAddress}}{{postOfficeBoxNumber}}{{postalCode}}{{addressLocality}}{{addressRegion}}{{addressCountry}}</span>'
-			                        . '{{founder}}'
-			                        . '{{email}}',
-			'templates'          => array(
-				'subtitle' => '{{id}}'
-			)
-		);
-
-		// Merge the custom fields with those provided by the place and organization schema.
-		$place_schema            = $this->get_place_schema();
-		$organization_schema     = $this->get_organization_schema();
-		$schema['custom_fields'] = array_merge( $schema['custom_fields'], $place_schema['custom_fields'], $organization_schema['custom_fields'] );
-
-		return $schema;
-	}
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+        // Merge the custom fields with those provided by the thing schema.
+        $thing_schema            = $this->get_thing_schema();
+        $schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
+
+        return $schema;
+    }
+
+    /**
+     * Get the 'organization' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_organization_schema() {
+
+        $schema = array(
+            'label'              => 'Organization',
+            'description'        => 'An organization, including a government or a newspaper.',
+            'parents'            => array( 'thing' ),
+            'css_class'          => 'wl-organization',
+            'uri'                => 'http://schema.org/Organization',
+            'same_as'            => array(
+                'http://rdf.freebase.com/ns/organization.organization',
+                'http://rdf.freebase.com/ns/government.government',
+                'http://schema.org/Newspaper'
+            ),
+            'custom_fields'      => array(
+                self::FIELD_FOUNDER             => array(
+                    'predicate'   => 'http://schema.org/founder',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/Person',
+                    'constraints' => array(
+                        'uri_type'    => 'Person',
+                        'cardinality' => INF
+                    )
+                ),
+                self::FIELD_ADDRESS             => array(
+                    'predicate'   => 'http://schema.org/streetAddress',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_PO_BOX      => array(
+                    'predicate'   => 'http://schema.org/postOfficeBoxNumber',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_POSTAL_CODE => array(
+                    'predicate'   => 'http://schema.org/postalCode',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_LOCALITY    => array(
+                    'predicate'   => 'http://schema.org/addressLocality',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_REGION      => array(
+                    'predicate'   => 'http://schema.org/addressRegion',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_COUNTRY     => array(
+                    'predicate'   => 'http://schema.org/addressCountry',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_EMAIL               => array(
+                    'predicate'   => 'http://schema.org/email',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => ''
+                ),
+                'wl_schema_telephone'           => array(
+                    'predicate'   => 'http://schema.org/telephone',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => ''
+                ),
+            ),
+            'microdata_template' => '{{founder}}'
+                                    . '<span itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">{{streetAddress}}{{postOfficeBoxNumber}}{{postalCode}}{{addressLocality}}{{addressRegion}}{{addressCountry}}{{email}}</span>',
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+        // Merge the custom fields with those provided by the thing schema.
+        $thing_schema            = $this->get_thing_schema();
+        $schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
+
+        return $schema;
+    }
+
+    /**
+     * Get the 'person' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_person_schema() {
+
+        $schema = array(
+            'label'              => 'Person',
+            'description'        => 'A person (or a music artist).',
+            'parents'            => array( 'thing' ),
+            'css_class'          => 'wl-person',
+            'uri'                => 'http://schema.org/Person',
+            'same_as'            => array(
+                'http://rdf.freebase.com/ns/people.person',
+                'http://rdf.freebase.com/ns/music.artist',
+                'http://dbpedia.org/class/yago/LivingPeople'
+            ),
+            'custom_fields'      => array(
+                self::FIELD_KNOWS       => array(
+                    'predicate'   => 'http://schema.org/knows',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/Person',
+                    'constraints' => array(
+                        'uri_type'    => 'Person',
+                        'cardinality' => INF
+                    )
+                ),
+                self::FIELD_BIRTH_DATE  => array(
+                    'predicate'   => 'http://schema.org/birthDate',
+                    'type'        => self::DATA_TYPE_DATE,
+                    'export_type' => 'xsd:date',
+                    'constraints' => ''
+                ),
+                self::FIELD_BIRTH_PLACE => array(
+                    'predicate'   => 'http://schema.org/birthPlace',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/Place',
+                    'constraints' => array(
+                        'uri_type' => 'Place'
+                    )
+                ),
+                self::FIELD_AFFILIATION => array(
+                    'predicate'   => 'http://schema.org/affiliation',
+                    'type'        => self::DATA_TYPE_URI,
+                    'export_type' => 'http://schema.org/Organization',
+                    'constraints' => array(
+                        'uri_type'    => array(
+                            'Organization',
+                            'LocalBusiness'
+                        ),
+                        'cardinality' => INF
+                    )
+                ),
+                self::FIELD_EMAIL       => array(
+                    'predicate'   => 'http://schema.org/email',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => array(
+                        'cardinality' => INF
+                    )
+                )
+            ),
+            'microdata_template' => '{{birthDate}}{{birthPlace}}{{knows}}{{affiliation}}{{email}}',
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+        // Merge the custom fields with those provided by the thing schema.
+        $thing_schema            = $this->get_thing_schema();
+        $schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
+
+        return $schema;
+
+    }
+
+    /**
+     * Get the 'place' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_place_schema() {
+
+        $schema = array(
+            'label'              => 'Place',
+            'description'        => 'A place.',
+            'parents'            => array( 'thing' ),
+            'css_class'          => 'wl-place',
+            'uri'                => 'http://schema.org/Place',
+            'same_as'            => array(
+                'http://rdf.freebase.com/ns/location.location',
+                'http://www.opengis.net/gml/_Feature'
+            ),
+            'custom_fields'      => array(
+                self::FIELD_GEO_LATITUDE        => array(
+                    'predicate'   => 'http://schema.org/latitude',
+                    'type'        => self::DATA_TYPE_DOUBLE,
+                    'export_type' => 'xsd:double',
+                    'constraints' => '',
+                    'input_field' => 'coordinates'   // to build custom metabox
+                ),
+                self::FIELD_GEO_LONGITUDE       => array(
+                    'predicate'   => 'http://schema.org/longitude',
+                    'type'        => self::DATA_TYPE_DOUBLE,
+                    'export_type' => 'xsd:double',
+                    'constraints' => '',
+                    'input_field' => 'coordinates'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS             => array(
+                    'predicate'   => 'http://schema.org/streetAddress',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_PO_BOX      => array(
+                    'predicate'   => 'http://schema.org/postOfficeBoxNumber',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_POSTAL_CODE => array(
+                    'predicate'   => 'http://schema.org/postalCode',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_LOCALITY    => array(
+                    'predicate'   => 'http://schema.org/addressLocality',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_REGION      => array(
+                    'predicate'   => 'http://schema.org/addressRegion',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                ),
+                self::FIELD_ADDRESS_COUNTRY     => array(
+                    'predicate'   => 'http://schema.org/addressCountry',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    'input_field' => 'address'   // to build custom metabox
+                )
+            ),
+            'microdata_template' => '<span itemprop="geo" itemscope itemtype="http://schema.org/GeoCoordinates">{{latitude}}{{longitude}}</span>'
+                                    . '<span itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">{{streetAddress}}{{postOfficeBoxNumber}}{{postalCode}}{{addressLocality}}{{addressRegion}}{{addressCountry}}</span>',
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+        // Merge the custom fields with those provided by the thing schema.
+        $thing_schema            = $this->get_thing_schema();
+        $schema['custom_fields'] = array_merge( $schema['custom_fields'], $thing_schema['custom_fields'] );
+
+        return $schema;
+    }
+
+    /**
+     * Get the 'local business' schema.
+     *
+     * @return array An array with the schema configuration.
+     *
+     * @since 3.1.0
+     */
+    private function get_local_business_schema() {
+
+        $schema = array(
+            'label'              => 'LocalBusiness',
+            'description'        => 'A local business.',
+            'parents'            => array( 'place', 'organization' ),
+            'css_class'          => 'wl-local-business',
+            'uri'                => 'http://schema.org/LocalBusiness',
+            'same_as'            => array(
+                'http://rdf.freebase.com/ns/business/business_location',
+                'https://schema.org/Store'
+            ),
+            'custom_fields'      => array(),
+            'microdata_template' => '<span itemprop="geo" itemscope itemtype="http://schema.org/GeoCoordinates">{{latitude}}{{longitude}}</span>'
+                                    . '<span itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">{{streetAddress}}{{postOfficeBoxNumber}}{{postalCode}}{{addressLocality}}{{addressRegion}}{{addressCountry}}</span>'
+                                    . '{{founder}}'
+                                    . '{{email}}',
+            'templates'          => array(
+                'subtitle' => '{{id}}'
+            )
+        );
+
+        // Merge the custom fields with those provided by the place and organization schema.
+        $place_schema            = $this->get_place_schema();
+        $organization_schema     = $this->get_organization_schema();
+        $schema['custom_fields'] = array_merge( $schema['custom_fields'], $place_schema['custom_fields'], $organization_schema['custom_fields'] );
+
+        return $schema;
+    }
 
 }

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

Indentation +835 added lines, -835 removed lines

@@ -7,845 +7,845 @@
  */
 class Wordlift_Entity_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log_service The Log service.
-	 */
-	private $log_service;
-
-	/**
-	 * The UI service.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	private $ui_service;
-
-	/**
-	 * The Schema service.
-	 *
-	 * @since 3.3.0
-	 * @access private
-	 * @var \Wordlift_Schema_Service $schema_service The Schema service.
-	 */
-	private $schema_service;
-
-	/**
-	 * The Notice service.
-	 *
-	 * @since 3.3.0
-	 * @access private
-	 * @var \Wordlift_Notice_Service $notice_service The Notice service.
-	 */
-	private $notice_service;
-
-	/**
-	 * The entity post type name.
-	 *
-	 * @since 3.1.0
-	 */
-	const TYPE_NAME = 'entity';
-
-	/**
-	 * Entity rating max.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_MAX = 7;
-
-	/**
-	 * Entity rating score meta key.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_RAW_SCORE_META_KEY = '_wl_entity_rating_raw_score';
-
-	/**
-	 * Entity rating warnings meta key.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNINGS_META_KEY = '_wl_entity_rating_warnings';
-
-	/**
-	 * Entity warning has related post identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_RELATED_POSTS = 'There are no related posts for the current entity.';
-
-	/**
-	 * Entity warning has content post identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_CONTENT_POST = 'This entity has not description.';
-
-	/**
-	 * Entity warning has related entities identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_RELATED_ENTITIES = 'There are no related entities for the current entity.';
-
-	/**
-	 * Entity warning is published identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_IS_PUBLISHED = 'This entity is not published. It will not appear within analysis results.';
-
-	/**
-	 * Entity warning has thumbnail identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_THUMBNAIL = 'This entity has no featured image yet.';
-
-	/**
-	 * Entity warning has same as identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_SAME_AS = 'There are no sameAs configured for this entity.';
-
-	/**
-	 * Entity warning has completed metadata identifier.
-	 *
-	 * @since 3.3.0
-	 */
-	const RATING_WARNING_HAS_COMPLETED_METADATA = 'Schema.org metadata for this entity are not completed.';
-
-	/**
-	 * The alternative label meta key.
-	 *
-	 * @since 3.2.0
-	 */
-	const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
-
-	/**
-	 * The alternative label input template.
-	 *
-	 * @since 3.2.0
-	 */
-	// TODO: this should be moved to a class that deals with HTML code.
-	const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
+    /**
+     * The Log service.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var \Wordlift_Log_Service $log_service The Log service.
+     */
+    private $log_service;
+
+    /**
+     * The UI service.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var \Wordlift_UI_Service $ui_service The UI service.
+     */
+    private $ui_service;
+
+    /**
+     * The Schema service.
+     *
+     * @since 3.3.0
+     * @access private
+     * @var \Wordlift_Schema_Service $schema_service The Schema service.
+     */
+    private $schema_service;
+
+    /**
+     * The Notice service.
+     *
+     * @since 3.3.0
+     * @access private
+     * @var \Wordlift_Notice_Service $notice_service The Notice service.
+     */
+    private $notice_service;
+
+    /**
+     * The entity post type name.
+     *
+     * @since 3.1.0
+     */
+    const TYPE_NAME = 'entity';
+
+    /**
+     * Entity rating max.
+     *
+     * @since 3.3.0
+     */
+    const RATING_MAX = 7;
+
+    /**
+     * Entity rating score meta key.
+     *
+     * @since 3.3.0
+     */
+    const RATING_RAW_SCORE_META_KEY = '_wl_entity_rating_raw_score';
+
+    /**
+     * Entity rating warnings meta key.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNINGS_META_KEY = '_wl_entity_rating_warnings';
+
+    /**
+     * Entity warning has related post identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_RELATED_POSTS = 'There are no related posts for the current entity.';
+
+    /**
+     * Entity warning has content post identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_CONTENT_POST = 'This entity has not description.';
+
+    /**
+     * Entity warning has related entities identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_RELATED_ENTITIES = 'There are no related entities for the current entity.';
+
+    /**
+     * Entity warning is published identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_IS_PUBLISHED = 'This entity is not published. It will not appear within analysis results.';
+
+    /**
+     * Entity warning has thumbnail identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_THUMBNAIL = 'This entity has no featured image yet.';
+
+    /**
+     * Entity warning has same as identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_SAME_AS = 'There are no sameAs configured for this entity.';
+
+    /**
+     * Entity warning has completed metadata identifier.
+     *
+     * @since 3.3.0
+     */
+    const RATING_WARNING_HAS_COMPLETED_METADATA = 'Schema.org metadata for this entity are not completed.';
+
+    /**
+     * The alternative label meta key.
+     *
+     * @since 3.2.0
+     */
+    const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label';
+
+    /**
+     * The alternative label input template.
+     *
+     * @since 3.2.0
+     */
+    // TODO: this should be moved to a class that deals with HTML code.
+    const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label">
                 <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label>
                 <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text">
                 <button class="button wl-delete-button">%s</button>
                 </div>';
 
-	/**
-	 * A singleton instance of the Entity service.
-	 *
-	 * @since 3.2.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Entity_Service instance.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param \Wordlift_UI_Service $ui_service The UI service.
-	 */
-	public function __construct( $ui_service, $schema_service, $notice_service ) {
-
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
-
-		// Set the UI service.
-		$this->ui_service = $ui_service;
-
-		// Set the Schema service.
-		$this->schema_service = $schema_service;
-
-		// Set the Schema service.
-		$this->notice_service = $notice_service;
-
-		// Set the singleton instance.
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Entity service.
-	 *
-	 * @since 3.2.0
-	 * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get rating max
-	 *
-	 * @since 3.3.0
-	 *
-	 * @return int Max rating according to performed checks.
-	 */
-	public static function get_rating_max() {
-		return self::RATING_MAX;
-	}
-
-	/**
-	 * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to
-	 * its specific function).
-	 *
-	 * @since 3.1.0
-	 *
-	 * @return array An array of post IDs.
-	 */
-	public function get_all_related_to_last_50_published_posts() {
-
-		// Global timeline. Get entities from the latest posts.
-		$latest_posts_ids = get_posts( array(
-			'numberposts' => 50,
-			'fields'      => 'ids', //only get post IDs
-			'post_type'   => 'post',
-			'post_status' => 'publish'
-		) );
-
-		if ( empty( $latest_posts_ids ) ) {
-			// There are no posts.
-			return array();
-		}
-
-		// Collect entities related to latest posts
-		$entity_ids = array();
-		foreach ( $latest_posts_ids as $id ) {
-			$entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array(
-				'status' => 'publish'
-			) ) );
-		}
-
-		return $entity_ids;
-	}
-
-	/**
-	 * Determines whether a post is an entity or not.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param int $post_id A post id.
-	 *
-	 * @return bool Return true if the post is an entity otherwise false.
-	 */
-	public function is_entity( $post_id ) {
-
-		return ( self::TYPE_NAME === get_post_type( $post_id ) );
-	}
-
-	/**
-	 * Get the proper classification scope for a given entity post
-	 *
-	 * @since 3.5.0
-	 *
-	 * @param integer $post_id An entity post id.
-	 *
-	 * @return string Returns an uri.
-	 */
-	public function get_classification_scope_for( $post_id ) {
-
-		if ( FALSE === $this->is_entity( $post_id ) ) {
-			return NULL;
-		}
-		// Retrieve the entity type
-		$entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
-		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
-				return $cb['id'];
-			}
-		}
-
-		// or null
-		return NULL;
-
-	}
-
-	/**
-	 * Build an entity uri for a given title
-	 * The uri is composed using a given post_type and a title
-	 * If already exists an entity e2 with a given uri a numeric suffix is added
-	 * If a schema type is given entities with same label and same type are overridden
-	 *
-	 * @since 3.5.0
-	 *
-	 * @param string $title A post title.
-	 * @param string $post_type A post type. Default value is 'entity'
-	 * @param string $schema_type A schema org type.
-	 * @param integer $increment_digit A digit used to call recursively the same function.
-	 *
-	 * @return string Returns an uri.
-	 */
-	public function build_uri( $title, $post_type, $schema_type = NULL, $increment_digit = 0 ) {
-
-		// Get the entity slug suffix digit
-		$suffix_digit = $increment_digit + 1;
-		// Get a sanitized uri for a given title
-		$entity_slug = ( 0 == $increment_digit ) ?
-			wl_sanitize_uri_path( $title ) :
-			wl_sanitize_uri_path( $title . '_' . $suffix_digit );
-
-		// Compose a candidated uri
-		$new_entity_uri = sprintf( '%s/%s/%s',
-			wl_configuration_get_redlink_dataset_uri(),
-			$post_type,
-			$entity_slug
-		);
-
-		$this->log_service->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
-
-		global $wpdb;
-		// Check if the candidated uri already is used
-		$stmt = $wpdb->prepare(
-			"SELECT post_id FROM $wpdb->postmeta WHERE meta_key = %s AND meta_value = %s LIMIT 1",
-			WL_ENTITY_URL_META_NAME,
-			$new_entity_uri
-		);
-
-		// Perform the query
-		$post_id = $wpdb->get_var( $stmt );
-
-		// If the post does not exist, then the new uri is returned 	
-		if ( ! is_numeric( $post_id ) ) {
-			$this->log_service->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" );
-
-			return $new_entity_uri;
-		}
-		// If schema_type is equal to schema org type of post x, then the new uri is returned 
-		$schema_post_type = wl_entity_type_taxonomy_get_type( $post_id );
-
-		if ( $schema_type === $schema_post_type['css_class'] ) {
-			$this->log_service->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" );
-
-			return $new_entity_uri;
-		}
-
-		// Otherwise the same function is called recorsively
-		return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit );
-	}
-
-	public function is_used( $post_id ) {
-
-		if ( FALSE === $this->is_entity( $post_id ) ) {
-			return NULL;
-		}
-		// Retrieve the post
-		$entity = get_post( $post_id );
-
-		global $wpdb;
-		// Retrieve Wordlift relation instances table name
-		$table_name = wl_core_get_relation_instances_table_name();
-
-		// Check is it's referenced / related to another post / entity
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
-			$entity->ID
-		);
-
-		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
-		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
-			return TRUE;
-		}
-
-		// Check if the entity uri is used as meta_value
-		$stmt = $wpdb->prepare(
-			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
-			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
-		);
-		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
-
-		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
-			return TRUE;
-		}
-
-		// If we are here, it means the current entity is not used at the moment
-		return FALSE;
-	}
-
-	/**
-	 * Determines whether a given uri is an internal uri or not.
-	 *
-	 * @since 3.3.2
-	 *
-	 * @param int $uri An uri.
-	 *
-	 * @return true if the uri internal to the current dataset otherwise false.
-	 */
-	public function is_internal_uri( $uri ) {
-
-		return ( 0 === strrpos( $uri, wl_configuration_get_redlink_dataset_uri() ) );
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 */
-	public function get_entity_post_by_uri( $uri ) {
-
-		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
-			return NULL;
-		}
-
-		$query_args = array(
-			'posts_per_page' => 1,
-			'post_status'    => 'any',
-			'post_type'      => self::TYPE_NAME,
-			'meta_query'     => array(
-				array(
-					'key'     => WL_ENTITY_URL_META_NAME,
-					'value'   => $uri,
-					'compare' => '='
-				)
-			)
-		);
-
-		// Only if the current uri is not an internal uri 
-		// entity search is performed also looking at sameAs values
-		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal_uri( $uri ) ) {
-
-			$query_args['meta_query']['relation'] = 'OR';
-			$query_args['meta_query'][]           = array(
-				'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
-				'value'   => $uri,
-				'compare' => '='
-			);
-		}
-
-		$query = new WP_Query( $query_args );
-
-		// Get the matching entity posts.
-		$posts = $query->get_posts();
-
-		// Return null if no post is found.
-		if ( 0 === count( $posts ) ) {
-			return NULL;
-		}
-
-		// Return the found post.
-		return $posts[0];
-	}
-
-	/**
-	 * Fires once a post has been saved. This function uses the $_REQUEST, therefore
-	 * we check that the post we're saving is the current post.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/363
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id Post ID.
-	 * @param WP_Post $post Post object.
-	 * @param bool $update Whether this is an existing post being updated or not.
-	 */
-	public function save_post( $post_id, $post, $update ) {
-
-		// We're setting the alternative label that have been provided via the UI
-		// (in fact we're using $_REQUEST), while save_post may be also called
-		// programmatically by some other function: we need to check therefore if
-		// the $post_id in the save_post call matches the post id set in the request.
-		//
-		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-
-		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
-
-		// Set the alternative labels.
-		$this->set_alternative_labels( $post_id, $alt_labels );
-
-	}
-
-	/**
-	 * Set the alternative labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $alt_labels An array of labels.
-	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
-
-		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
-		}
-
-		$this->log_service->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
-
-		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-
-		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
-			}
-		}
-
-	}
-
-	/**
-	 * Retrieve the alternate labels.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param int $post_id Post id.
-	 *
-	 * @return mixed An array  of alternative labels.
-	 */
-	public function get_alternative_labels( $post_id ) {
-
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
-	}
-
-	/**
-	 * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param WP_Post $post Post object.
-	 */
-	public function edit_form_before_permalink( $post ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-
-		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
-
-		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
-
-			echo $this->get_alternative_label_input( $alt_label );
-
-		};
-
-		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
-
-	}
-
-	/**
-	 * Add admin notices for the current entity depending on the current rating.
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param WP_Post $post Post object.
-	 */
-	public function in_admin_header() {
-
-		// Return safely if get_current_screen() is not defined (yet)
-		if ( FALSE === function_exists( 'get_current_screen' ) ) {
-			return;
-		}
-
-		$screen = get_current_screen();
-		// If there is any valid screen nothing to do
-		if ( NULL === $screen ) {
-			return $clauses;
-		}
-
-		// If you're not in the entity post edit page, return.
-		if ( self::TYPE_NAME !== $screen->id ) {
-			return;
-		}
-		// Retrieve the current global post
-		global $post;
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
-			return;
-		}
-		// Retrieve an updated rating for the current entity
-		$rating = $this->get_rating_for( $post->ID, TRUE );
-		// If there is at least 1 warning
-		if ( isset( $rating['warnings'] ) && 0 < count( $rating['warnings'] ) ) {
-			// TODO - Pass Wordlift_Notice_Service trough the service constructor 
-			$this->notice_service->add_suggestion( $rating['warnings'] );
-		}
-
-	}
-
-	/**
-	 * Set rating for a given entity
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return int An array representing the rating obj.
-	 */
-	public function set_rating_for( $post_id ) {
-
-		// Calculate rating for the given post
-		$rating = $this->calculate_rating_for( $post_id );
-		// Store the rating on db as post meta
-		// Please notice that RATING_RAW_SCORE_META_KEY 
-		// is saved on a different meta to allow score sorting
-		// Both meta are managed as unique
-		// https://codex.wordpress.org/Function_Reference/update_post_meta
-		update_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score'] );
-		update_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings'] );
-
-		$this->log_service->trace( sprintf( "Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score'] ) );
-
-		// Finally returns the rating 
-		return $rating;
-	}
-
-	/**
-	 * Get or calculate rating for a given entity
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $post_id The entity post id.
-	 * @param $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj.
-	 *
-	 * @return int An array representing the rating obj.
-	 */
-	public function get_rating_for( $post_id, $force_reload = FALSE ) {
-
-		// If forced reload is required or rating is missing ..
-		if ( $force_reload ) {
-			$this->log_service->trace( "Force rating reload [ post_id :: $post_id ]" );
-
-			return $this->set_rating_for( $post_id );
-		}
-
-		$current_raw_score = get_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, TRUE );
-
-		if ( ! is_numeric( $current_raw_score ) ) {
-			$this->log_service->trace( "Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]" );
-
-			return $this->set_rating_for( $post_id );
-		}
-		$current_warnings = get_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, TRUE );
-
-		// Finally return score and warnings
-		return array(
-			'raw_score'           => $current_raw_score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $current_raw_score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $current_raw_score ),
-			'warnings'            => $current_warnings,
-		);
-
-	}
-
-	/**
-	 * Calculate rating for a given entity
-	 * Rating depends from following criteria
-	 *
-	 * 1. Is the current entity related to at least 1 post?
-	 * 2. Is the current entity content post not empty?
-	 * 3. Is the current entity related to at least 1 entity?
-	 * 4. Is the entity published?
-	 * 5. There is a a thumbnail associated to the entity?
-	 * 6. Has the entity a sameas defined?
-	 * 7. Are all schema.org required metadata compiled?
-	 *
-	 * Each positive check means +1 in terms of rating score
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return int An array representing the rating obj.
-	 */
-	public function calculate_rating_for( $post_id ) {
-
-		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post_id ) ) {
-			return;
-		}
-		// Retrieve the post object
-		$post = get_post( $post_id );
-		// Rating value
-		$score = 0;
-		// Store warning messages
-		$warnings = array();
-
-		// Is the current entity related to at least 1 post?
-		( 0 < count( wl_core_get_related_post_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_RELATED_POSTS, 'wordlift' ) );
-
-		// Is the post content not empty?
-		( ! empty( $post->post_content ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_CONTENT_POST, 'wordlift' ) );
-
-		// Is the current entity related to at least 1 entity?
-		// Was the current entity already disambiguated?
-		( 0 < count( wl_core_get_related_entity_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_RELATED_ENTITIES, 'wordlift' ) );
-
-		// Is the entity published?
-		( 'publish' === get_post_status( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_IS_PUBLISHED, 'wordlift' ) );
-
-		// Has a thumbnail?
-		( has_post_thumbnail( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_THUMBNAIL, 'wordlift' ) );
-
-		// Get all post meta keys for the current post		
-		global $wpdb;
-		$query = $wpdb->prepare(
-			"SELECT DISTINCT(meta_key) FROM $wpdb->postmeta  WHERE post_id = %d", $post->ID
-		);
-
-		// Check intersection between available meta keys 
-		// and expected ones arrays to detect missing values
-		$available_meta_keys = $wpdb->get_col( $query );
-
-		// If each expected key is contained in available keys array ...
-		( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_SAME_AS, 'wordlift' ) );
-
-		$schema = wl_entity_type_taxonomy_get_type( $post_id );
-
-		$expected_meta_keys = ( NULL === $schema['custom_fields'] ) ?
-			array() :
-			array_keys( $schema['custom_fields'] );
-
-		$intersection = array_intersect( $expected_meta_keys, $available_meta_keys );
-		// If each expected key is contained in available keys array ...
-		( count( $intersection ) === count( $expected_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_COMPLETED_METADATA, 'wordlift' ) );
-
-		// Finally return score and warnings
-		return array(
-			'raw_score'           => $score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $score ),
-			'warnings'            => $warnings,
-		);
-
-	}
-
-	/**
-	 * Get the URI for the entity with the specified post id.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param int $post_id The entity post id.
-	 *
-	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
-	 */
-	public function get_uri( $post_id ) {
-
-		// If a null is given, nothing to do
-		if ( NULL == $post_id ) {
-			return NULL;
-		}
-
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, TRUE );
-
-		// If the dataset uri is not properly configured, null is returned
-		if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
-			return NULL;
-		}
-
-		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
-		}
-
-		return $uri;
-	}
-
-	/**
-	 * Get as rating as input and convert in a traffic-light rating
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $score The rating score for a given entity.
-	 *
-	 * @return string The input HTML code.
-	 */
-	private function convert_raw_score_to_traffic_light( $score ) {
-		// RATING_MAX : $score = 3 : x 
-		// See http://php.net/manual/en/function.round.php
-		$rating = round( ( $score * 3 ) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP );
-
-		// If rating is 0, return 1, otherwise return rating
-		return ( 0 == $rating ) ? 1 : $rating;
-
-	}
-
-	/**
-	 * Get as rating as input and convert in a traffic-light rating
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param int $score The rating score for a given entity.
-	 *
-	 * @return string The input HTML code.
-	 */
-	public function convert_raw_score_to_percentage( $score ) {
-		// RATING_MAX : $score = 100 : x 
-		return round( ( $score * 100 ) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP );
-	}
-
-	/**
-	 * Get the alternative label input HTML code.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $value The input value.
-	 *
-	 * @return string The input HTML code.
-	 */
-	private function get_alternative_label_input( $value = '' ) {
-
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
-	}
-
-	/**
-	 * Get the number of entity posts published in this blog.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return int The number of published entity posts.
-	 */
-	public function count() {
-
-		$count = wp_count_posts( self::TYPE_NAME );
-
-		return $count->publish;
-	}
+    /**
+     * A singleton instance of the Entity service.
+     *
+     * @since 3.2.0
+     * @access private
+     * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Entity_Service instance.
+     *
+     * @since 3.2.0
+     *
+     * @param \Wordlift_UI_Service $ui_service The UI service.
+     */
+    public function __construct( $ui_service, $schema_service, $notice_service ) {
+
+        $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+
+        // Set the UI service.
+        $this->ui_service = $ui_service;
+
+        // Set the Schema service.
+        $this->schema_service = $schema_service;
+
+        // Set the Schema service.
+        $this->notice_service = $notice_service;
+
+        // Set the singleton instance.
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Entity service.
+     *
+     * @since 3.2.0
+     * @return \Wordlift_Entity_Service The singleton instance of the Entity service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Get rating max
+     *
+     * @since 3.3.0
+     *
+     * @return int Max rating according to performed checks.
+     */
+    public static function get_rating_max() {
+        return self::RATING_MAX;
+    }
+
+    /**
+     * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to
+     * its specific function).
+     *
+     * @since 3.1.0
+     *
+     * @return array An array of post IDs.
+     */
+    public function get_all_related_to_last_50_published_posts() {
+
+        // Global timeline. Get entities from the latest posts.
+        $latest_posts_ids = get_posts( array(
+            'numberposts' => 50,
+            'fields'      => 'ids', //only get post IDs
+            'post_type'   => 'post',
+            'post_status' => 'publish'
+        ) );
+
+        if ( empty( $latest_posts_ids ) ) {
+            // There are no posts.
+            return array();
+        }
+
+        // Collect entities related to latest posts
+        $entity_ids = array();
+        foreach ( $latest_posts_ids as $id ) {
+            $entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array(
+                'status' => 'publish'
+            ) ) );
+        }
+
+        return $entity_ids;
+    }
+
+    /**
+     * Determines whether a post is an entity or not.
+     *
+     * @since 3.1.0
+     *
+     * @param int $post_id A post id.
+     *
+     * @return bool Return true if the post is an entity otherwise false.
+     */
+    public function is_entity( $post_id ) {
+
+        return ( self::TYPE_NAME === get_post_type( $post_id ) );
+    }
+
+    /**
+     * Get the proper classification scope for a given entity post
+     *
+     * @since 3.5.0
+     *
+     * @param integer $post_id An entity post id.
+     *
+     * @return string Returns an uri.
+     */
+    public function get_classification_scope_for( $post_id ) {
+
+        if ( FALSE === $this->is_entity( $post_id ) ) {
+            return NULL;
+        }
+        // Retrieve the entity type
+        $entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id );
+        $entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+        // Retrieve classification boxes configuration
+        $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
+        foreach ( $classification_boxes as $cb ) {
+            if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+                return $cb['id'];
+            }
+        }
+
+        // or null
+        return NULL;
+
+    }
+
+    /**
+     * Build an entity uri for a given title
+     * The uri is composed using a given post_type and a title
+     * If already exists an entity e2 with a given uri a numeric suffix is added
+     * If a schema type is given entities with same label and same type are overridden
+     *
+     * @since 3.5.0
+     *
+     * @param string $title A post title.
+     * @param string $post_type A post type. Default value is 'entity'
+     * @param string $schema_type A schema org type.
+     * @param integer $increment_digit A digit used to call recursively the same function.
+     *
+     * @return string Returns an uri.
+     */
+    public function build_uri( $title, $post_type, $schema_type = NULL, $increment_digit = 0 ) {
+
+        // Get the entity slug suffix digit
+        $suffix_digit = $increment_digit + 1;
+        // Get a sanitized uri for a given title
+        $entity_slug = ( 0 == $increment_digit ) ?
+            wl_sanitize_uri_path( $title ) :
+            wl_sanitize_uri_path( $title . '_' . $suffix_digit );
+
+        // Compose a candidated uri
+        $new_entity_uri = sprintf( '%s/%s/%s',
+            wl_configuration_get_redlink_dataset_uri(),
+            $post_type,
+            $entity_slug
+        );
+
+        $this->log_service->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
+
+        global $wpdb;
+        // Check if the candidated uri already is used
+        $stmt = $wpdb->prepare(
+            "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = %s AND meta_value = %s LIMIT 1",
+            WL_ENTITY_URL_META_NAME,
+            $new_entity_uri
+        );
+
+        // Perform the query
+        $post_id = $wpdb->get_var( $stmt );
+
+        // If the post does not exist, then the new uri is returned 	
+        if ( ! is_numeric( $post_id ) ) {
+            $this->log_service->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" );
+
+            return $new_entity_uri;
+        }
+        // If schema_type is equal to schema org type of post x, then the new uri is returned 
+        $schema_post_type = wl_entity_type_taxonomy_get_type( $post_id );
+
+        if ( $schema_type === $schema_post_type['css_class'] ) {
+            $this->log_service->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" );
+
+            return $new_entity_uri;
+        }
+
+        // Otherwise the same function is called recorsively
+        return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit );
+    }
+
+    public function is_used( $post_id ) {
+
+        if ( FALSE === $this->is_entity( $post_id ) ) {
+            return NULL;
+        }
+        // Retrieve the post
+        $entity = get_post( $post_id );
+
+        global $wpdb;
+        // Retrieve Wordlift relation instances table name
+        $table_name = wl_core_get_relation_instances_table_name();
+
+        // Check is it's referenced / related to another post / entity
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $table_name WHERE  object_id = %d",
+            $entity->ID
+        );
+
+        // Perform the query
+        $relation_instances = (int) $wpdb->get_var( $stmt );
+        // If there is at least one relation instance for the current entity, then it's used
+        if ( 0 < $relation_instances ) {
+            return TRUE;
+        }
+
+        // Check if the entity uri is used as meta_value
+        $stmt = $wpdb->prepare(
+            "SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
+            $entity->ID,
+            wl_get_entity_uri( $entity->ID )
+        );
+        // Perform the query
+        $meta_instances = (int) $wpdb->get_var( $stmt );
+
+        // If there is at least one meta that refers the current entity uri, then current entity is used
+        if ( 0 < $meta_instances ) {
+            return TRUE;
+        }
+
+        // If we are here, it means the current entity is not used at the moment
+        return FALSE;
+    }
+
+    /**
+     * Determines whether a given uri is an internal uri or not.
+     *
+     * @since 3.3.2
+     *
+     * @param int $uri An uri.
+     *
+     * @return true if the uri internal to the current dataset otherwise false.
+     */
+    public function is_internal_uri( $uri ) {
+
+        return ( 0 === strrpos( $uri, wl_configuration_get_redlink_dataset_uri() ) );
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @since 3.2.0
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     */
+    public function get_entity_post_by_uri( $uri ) {
+
+        // Check if we've been provided with a value otherwise return null.
+        if ( empty( $uri ) ) {
+            return NULL;
+        }
+
+        $query_args = array(
+            'posts_per_page' => 1,
+            'post_status'    => 'any',
+            'post_type'      => self::TYPE_NAME,
+            'meta_query'     => array(
+                array(
+                    'key'     => WL_ENTITY_URL_META_NAME,
+                    'value'   => $uri,
+                    'compare' => '='
+                )
+            )
+        );
+
+        // Only if the current uri is not an internal uri 
+        // entity search is performed also looking at sameAs values
+        // This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
+        if ( ! $this->is_internal_uri( $uri ) ) {
+
+            $query_args['meta_query']['relation'] = 'OR';
+            $query_args['meta_query'][]           = array(
+                'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
+                'value'   => $uri,
+                'compare' => '='
+            );
+        }
+
+        $query = new WP_Query( $query_args );
+
+        // Get the matching entity posts.
+        $posts = $query->get_posts();
+
+        // Return null if no post is found.
+        if ( 0 === count( $posts ) ) {
+            return NULL;
+        }
+
+        // Return the found post.
+        return $posts[0];
+    }
+
+    /**
+     * Fires once a post has been saved. This function uses the $_REQUEST, therefore
+     * we check that the post we're saving is the current post.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/363
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id Post ID.
+     * @param WP_Post $post Post object.
+     * @param bool $update Whether this is an existing post being updated or not.
+     */
+    public function save_post( $post_id, $post, $update ) {
+
+        // We're setting the alternative label that have been provided via the UI
+        // (in fact we're using $_REQUEST), while save_post may be also called
+        // programmatically by some other function: we need to check therefore if
+        // the $post_id in the save_post call matches the post id set in the request.
+        //
+        // If this is not the current post being saved or if it's not an entity, return.
+        if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+
+        // Get the alt labels from the request (or empty array).
+        $alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+
+        // Set the alternative labels.
+        $this->set_alternative_labels( $post_id, $alt_labels );
+
+    }
+
+    /**
+     * Set the alternative labels.
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id The post id.
+     * @param array $alt_labels An array of labels.
+     */
+    public function set_alternative_labels( $post_id, $alt_labels ) {
+
+        // Force $alt_labels to be an array
+        if ( ! is_array( $alt_labels ) ) {
+            $alt_labels = array( $alt_labels );
+        }
+
+        $this->log_service->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+
+        // Delete all the existing alternate labels.
+        delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+
+        // Set the alternative labels.
+        foreach ( $alt_labels as $alt_label ) {
+            if ( ! empty( $alt_label ) ) {
+                add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+            }
+        }
+
+    }
+
+    /**
+     * Retrieve the alternate labels.
+     *
+     * @since 3.2.0
+     *
+     * @param int $post_id Post id.
+     *
+     * @return mixed An array  of alternative labels.
+     */
+    public function get_alternative_labels( $post_id ) {
+
+        return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+    }
+
+    /**
+     * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0).
+     *
+     * @since 3.2.0
+     *
+     * @param WP_Post $post Post object.
+     */
+    public function edit_form_before_permalink( $post ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+
+        // Print the input template.
+        $this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+
+        // Print all the currently set alternative labels.
+        foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+
+            echo $this->get_alternative_label_input( $alt_label );
+
+        };
+
+        // Print the button.
+        $this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+
+    }
+
+    /**
+     * Add admin notices for the current entity depending on the current rating.
+     *
+     * @since 3.3.0
+     *
+     * @param WP_Post $post Post object.
+     */
+    public function in_admin_header() {
+
+        // Return safely if get_current_screen() is not defined (yet)
+        if ( FALSE === function_exists( 'get_current_screen' ) ) {
+            return;
+        }
+
+        $screen = get_current_screen();
+        // If there is any valid screen nothing to do
+        if ( NULL === $screen ) {
+            return $clauses;
+        }
+
+        // If you're not in the entity post edit page, return.
+        if ( self::TYPE_NAME !== $screen->id ) {
+            return;
+        }
+        // Retrieve the current global post
+        global $post;
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post->ID ) ) {
+            return;
+        }
+        // Retrieve an updated rating for the current entity
+        $rating = $this->get_rating_for( $post->ID, TRUE );
+        // If there is at least 1 warning
+        if ( isset( $rating['warnings'] ) && 0 < count( $rating['warnings'] ) ) {
+            // TODO - Pass Wordlift_Notice_Service trough the service constructor 
+            $this->notice_service->add_suggestion( $rating['warnings'] );
+        }
+
+    }
+
+    /**
+     * Set rating for a given entity
+     *
+     * @since 3.3.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return int An array representing the rating obj.
+     */
+    public function set_rating_for( $post_id ) {
+
+        // Calculate rating for the given post
+        $rating = $this->calculate_rating_for( $post_id );
+        // Store the rating on db as post meta
+        // Please notice that RATING_RAW_SCORE_META_KEY 
+        // is saved on a different meta to allow score sorting
+        // Both meta are managed as unique
+        // https://codex.wordpress.org/Function_Reference/update_post_meta
+        update_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score'] );
+        update_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings'] );
+
+        $this->log_service->trace( sprintf( "Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score'] ) );
+
+        // Finally returns the rating 
+        return $rating;
+    }
+
+    /**
+     * Get or calculate rating for a given entity
+     *
+     * @since 3.3.0
+     *
+     * @param int $post_id The entity post id.
+     * @param $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj.
+     *
+     * @return int An array representing the rating obj.
+     */
+    public function get_rating_for( $post_id, $force_reload = FALSE ) {
+
+        // If forced reload is required or rating is missing ..
+        if ( $force_reload ) {
+            $this->log_service->trace( "Force rating reload [ post_id :: $post_id ]" );
+
+            return $this->set_rating_for( $post_id );
+        }
+
+        $current_raw_score = get_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, TRUE );
+
+        if ( ! is_numeric( $current_raw_score ) ) {
+            $this->log_service->trace( "Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]" );
+
+            return $this->set_rating_for( $post_id );
+        }
+        $current_warnings = get_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, TRUE );
+
+        // Finally return score and warnings
+        return array(
+            'raw_score'           => $current_raw_score,
+            'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $current_raw_score ),
+            'percentage_score'    => $this->convert_raw_score_to_percentage( $current_raw_score ),
+            'warnings'            => $current_warnings,
+        );
+
+    }
+
+    /**
+     * Calculate rating for a given entity
+     * Rating depends from following criteria
+     *
+     * 1. Is the current entity related to at least 1 post?
+     * 2. Is the current entity content post not empty?
+     * 3. Is the current entity related to at least 1 entity?
+     * 4. Is the entity published?
+     * 5. There is a a thumbnail associated to the entity?
+     * 6. Has the entity a sameas defined?
+     * 7. Are all schema.org required metadata compiled?
+     *
+     * Each positive check means +1 in terms of rating score
+     *
+     * @since 3.3.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return int An array representing the rating obj.
+     */
+    public function calculate_rating_for( $post_id ) {
+
+        // If it's not an entity, return.
+        if ( ! $this->is_entity( $post_id ) ) {
+            return;
+        }
+        // Retrieve the post object
+        $post = get_post( $post_id );
+        // Rating value
+        $score = 0;
+        // Store warning messages
+        $warnings = array();
+
+        // Is the current entity related to at least 1 post?
+        ( 0 < count( wl_core_get_related_post_ids( $post->ID ) ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_HAS_RELATED_POSTS, 'wordlift' ) );
+
+        // Is the post content not empty?
+        ( ! empty( $post->post_content ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_HAS_CONTENT_POST, 'wordlift' ) );
+
+        // Is the current entity related to at least 1 entity?
+        // Was the current entity already disambiguated?
+        ( 0 < count( wl_core_get_related_entity_ids( $post->ID ) ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_HAS_RELATED_ENTITIES, 'wordlift' ) );
+
+        // Is the entity published?
+        ( 'publish' === get_post_status( $post->ID ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_IS_PUBLISHED, 'wordlift' ) );
+
+        // Has a thumbnail?
+        ( has_post_thumbnail( $post->ID ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_HAS_THUMBNAIL, 'wordlift' ) );
+
+        // Get all post meta keys for the current post		
+        global $wpdb;
+        $query = $wpdb->prepare(
+            "SELECT DISTINCT(meta_key) FROM $wpdb->postmeta  WHERE post_id = %d", $post->ID
+        );
+
+        // Check intersection between available meta keys 
+        // and expected ones arrays to detect missing values
+        $available_meta_keys = $wpdb->get_col( $query );
+
+        // If each expected key is contained in available keys array ...
+        ( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_HAS_SAME_AS, 'wordlift' ) );
+
+        $schema = wl_entity_type_taxonomy_get_type( $post_id );
+
+        $expected_meta_keys = ( NULL === $schema['custom_fields'] ) ?
+            array() :
+            array_keys( $schema['custom_fields'] );
+
+        $intersection = array_intersect( $expected_meta_keys, $available_meta_keys );
+        // If each expected key is contained in available keys array ...
+        ( count( $intersection ) === count( $expected_meta_keys ) ) ?
+            $score ++ :
+            array_push( $warnings, __( self::RATING_WARNING_HAS_COMPLETED_METADATA, 'wordlift' ) );
+
+        // Finally return score and warnings
+        return array(
+            'raw_score'           => $score,
+            'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $score ),
+            'percentage_score'    => $this->convert_raw_score_to_percentage( $score ),
+            'warnings'            => $warnings,
+        );
+
+    }
+
+    /**
+     * Get the URI for the entity with the specified post id.
+     *
+     * @since 3.6.0
+     *
+     * @param int $post_id The entity post id.
+     *
+     * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
+     */
+    public function get_uri( $post_id ) {
+
+        // If a null is given, nothing to do
+        if ( NULL == $post_id ) {
+            return NULL;
+        }
+
+        $uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, TRUE );
+
+        // If the dataset uri is not properly configured, null is returned
+        if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
+            return NULL;
+        }
+
+        // Set the URI if it isn't set yet.
+        $post_status = get_post_status( $post_id );
+        if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
+            $uri = wl_build_entity_uri( $post_id );
+            wl_set_entity_uri( $post_id, $uri );
+        }
+
+        return $uri;
+    }
+
+    /**
+     * Get as rating as input and convert in a traffic-light rating
+     *
+     * @since 3.3.0
+     *
+     * @param int $score The rating score for a given entity.
+     *
+     * @return string The input HTML code.
+     */
+    private function convert_raw_score_to_traffic_light( $score ) {
+        // RATING_MAX : $score = 3 : x 
+        // See http://php.net/manual/en/function.round.php
+        $rating = round( ( $score * 3 ) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP );
+
+        // If rating is 0, return 1, otherwise return rating
+        return ( 0 == $rating ) ? 1 : $rating;
+
+    }
+
+    /**
+     * Get as rating as input and convert in a traffic-light rating
+     *
+     * @since 3.3.0
+     *
+     * @param int $score The rating score for a given entity.
+     *
+     * @return string The input HTML code.
+     */
+    public function convert_raw_score_to_percentage( $score ) {
+        // RATING_MAX : $score = 100 : x 
+        return round( ( $score * 100 ) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP );
+    }
+
+    /**
+     * Get the alternative label input HTML code.
+     *
+     * @since 3.2.0
+     *
+     * @param string $value The input value.
+     *
+     * @return string The input HTML code.
+     */
+    private function get_alternative_label_input( $value = '' ) {
+
+        return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+    }
+
+    /**
+     * Get the number of entity posts published in this blog.
+     *
+     * @since 3.6.0
+     *
+     * @return int The number of published entity posts.
+     */
+    public function count() {
+
+        $count = wp_count_posts( self::TYPE_NAME );
+
+        return $count->publish;
+    }
 
 }

Spacing +127 added lines, -136 removed lines

@@ -155,9 +155,9 @@ 
 	 *
 	 * @param \Wordlift_UI_Service $ui_service The UI service.
 	 */
-	public function __construct( $ui_service, $schema_service, $notice_service ) {
+	public function __construct($ui_service, $schema_service, $notice_service) {
 
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' );
+		$this->log_service = Wordlift_Log_Service::get_logger('Wordlift_Entity_Service');
 
 		// Set the UI service.
 		$this->ui_service = $ui_service;
@@ -206,24 +206,24 @@ 
 	public function get_all_related_to_last_50_published_posts() {
 
 		// Global timeline. Get entities from the latest posts.
-		$latest_posts_ids = get_posts( array(
+		$latest_posts_ids = get_posts(array(
 			'numberposts' => 50,
 			'fields'      => 'ids', //only get post IDs
 			'post_type'   => 'post',
 			'post_status' => 'publish'
-		) );
+		));
 
-		if ( empty( $latest_posts_ids ) ) {
+		if (empty($latest_posts_ids)) {
 			// There are no posts.
 			return array();
 		}
 
 		// Collect entities related to latest posts
 		$entity_ids = array();
-		foreach ( $latest_posts_ids as $id ) {
-			$entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array(
+		foreach ($latest_posts_ids as $id) {
+			$entity_ids = array_merge($entity_ids, wl_core_get_related_entity_ids($id, array(
 				'status' => 'publish'
-			) ) );
+			)));
 		}
 
 		return $entity_ids;
@@ -238,9 +238,9 @@ 
 	 *
 	 * @return bool Return true if the post is an entity otherwise false.
 	 */
-	public function is_entity( $post_id ) {
+	public function is_entity($post_id) {
 
-		return ( self::TYPE_NAME === get_post_type( $post_id ) );
+		return (self::TYPE_NAME === get_post_type($post_id));
 	}
 
 	/**
@@ -252,18 +252,18 @@ 
 	 *
 	 * @return string Returns an uri.
 	 */
-	public function get_classification_scope_for( $post_id ) {
+	public function get_classification_scope_for($post_id) {
 
-		if ( FALSE === $this->is_entity( $post_id ) ) {
+		if (FALSE === $this->is_entity($post_id)) {
 			return NULL;
 		}
 		// Retrieve the entity type
-		$entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id );
-		$entity_type     = str_replace( 'wl-', '', $entity_type_arr['css_class'] );
+		$entity_type_arr = wl_entity_type_taxonomy_get_type($post_id);
+		$entity_type     = str_replace('wl-', '', $entity_type_arr['css_class']);
 		// Retrieve classification boxes configuration
-		$classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES );
-		foreach ( $classification_boxes as $cb ) {
-			if ( in_array( $entity_type, $cb['registeredTypes'] ) ) {
+		$classification_boxes = unserialize(WL_CORE_POST_CLASSIFICATION_BOXES);
+		foreach ($classification_boxes as $cb) {
+			if (in_array($entity_type, $cb['registeredTypes'])) {
 				return $cb['id'];
 			}
 		}
@@ -288,23 +288,22 @@ 
 	 *
 	 * @return string Returns an uri.
 	 */
-	public function build_uri( $title, $post_type, $schema_type = NULL, $increment_digit = 0 ) {
+	public function build_uri($title, $post_type, $schema_type = NULL, $increment_digit = 0) {
 
 		// Get the entity slug suffix digit
 		$suffix_digit = $increment_digit + 1;
 		// Get a sanitized uri for a given title
-		$entity_slug = ( 0 == $increment_digit ) ?
-			wl_sanitize_uri_path( $title ) :
-			wl_sanitize_uri_path( $title . '_' . $suffix_digit );
+		$entity_slug = (0 == $increment_digit) ?
+			wl_sanitize_uri_path($title) : wl_sanitize_uri_path($title.'_'.$suffix_digit);
 
 		// Compose a candidated uri
-		$new_entity_uri = sprintf( '%s/%s/%s',
+		$new_entity_uri = sprintf('%s/%s/%s',
 			wl_configuration_get_redlink_dataset_uri(),
 			$post_type,
 			$entity_slug
 		);
 
-		$this->log_service->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" );
+		$this->log_service->trace("Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]");
 
 		global $wpdb;
 		// Check if the candidated uri already is used
@@ -315,34 +314,34 @@ 
 		);
 
 		// Perform the query
-		$post_id = $wpdb->get_var( $stmt );
+		$post_id = $wpdb->get_var($stmt);
 
 		// If the post does not exist, then the new uri is returned 	
-		if ( ! is_numeric( $post_id ) ) {
-			$this->log_service->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" );
+		if ( ! is_numeric($post_id)) {
+			$this->log_service->trace("Going to return uri [ new_entity_uri :: $new_entity_uri ]");
 
 			return $new_entity_uri;
 		}
 		// If schema_type is equal to schema org type of post x, then the new uri is returned 
-		$schema_post_type = wl_entity_type_taxonomy_get_type( $post_id );
+		$schema_post_type = wl_entity_type_taxonomy_get_type($post_id);
 
-		if ( $schema_type === $schema_post_type['css_class'] ) {
-			$this->log_service->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" );
+		if ($schema_type === $schema_post_type['css_class']) {
+			$this->log_service->trace("An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]");
 
 			return $new_entity_uri;
 		}
 
 		// Otherwise the same function is called recorsively
-		return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit );
+		return $this->build_uri($title, $post_type, $schema_type, ++ $increment_digit);
 	}
 
-	public function is_used( $post_id ) {
+	public function is_used($post_id) {
 
-		if ( FALSE === $this->is_entity( $post_id ) ) {
+		if (FALSE === $this->is_entity($post_id)) {
 			return NULL;
 		}
 		// Retrieve the post
-		$entity = get_post( $post_id );
+		$entity = get_post($post_id);
 
 		global $wpdb;
 		// Retrieve Wordlift relation instances table name
@@ -355,9 +354,9 @@ 
 		);
 
 		// Perform the query
-		$relation_instances = (int) $wpdb->get_var( $stmt );
+		$relation_instances = (int) $wpdb->get_var($stmt);
 		// If there is at least one relation instance for the current entity, then it's used
-		if ( 0 < $relation_instances ) {
+		if (0 < $relation_instances) {
 			return TRUE;
 		}
 
@@ -365,13 +364,13 @@ 
 		$stmt = $wpdb->prepare(
 			"SELECT COUNT(*) FROM $wpdb->postmeta WHERE post_id != %d AND meta_value = %s",
 			$entity->ID,
-			wl_get_entity_uri( $entity->ID )
+			wl_get_entity_uri($entity->ID)
 		);
 		// Perform the query
-		$meta_instances = (int) $wpdb->get_var( $stmt );
+		$meta_instances = (int) $wpdb->get_var($stmt);
 
 		// If there is at least one meta that refers the current entity uri, then current entity is used
-		if ( 0 < $meta_instances ) {
+		if (0 < $meta_instances) {
 			return TRUE;
 		}
 
@@ -388,9 +387,9 @@ 
 	 *
 	 * @return true if the uri internal to the current dataset otherwise false.
 	 */
-	public function is_internal_uri( $uri ) {
+	public function is_internal_uri($uri) {
 
-		return ( 0 === strrpos( $uri, wl_configuration_get_redlink_dataset_uri() ) );
+		return (0 === strrpos($uri, wl_configuration_get_redlink_dataset_uri()));
 	}
 
 	/**
@@ -402,10 +401,10 @@ 
 	 *
 	 * @return WP_Post|null A WP_Post instance or null if not found.
 	 */
-	public function get_entity_post_by_uri( $uri ) {
+	public function get_entity_post_by_uri($uri) {
 
 		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
+		if (empty($uri)) {
 			return NULL;
 		}
 
@@ -425,7 +424,7 @@ 
 		// Only if the current uri is not an internal uri 
 		// entity search is performed also looking at sameAs values
 		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal_uri( $uri ) ) {
+		if ( ! $this->is_internal_uri($uri)) {
 
 			$query_args['meta_query']['relation'] = 'OR';
 			$query_args['meta_query'][]           = array(
@@ -435,13 +434,13 @@ 
 			);
 		}
 
-		$query = new WP_Query( $query_args );
+		$query = new WP_Query($query_args);
 
 		// Get the matching entity posts.
 		$posts = $query->get_posts();
 
 		// Return null if no post is found.
-		if ( 0 === count( $posts ) ) {
+		if (0 === count($posts)) {
 			return NULL;
 		}
 
@@ -461,7 +460,7 @@ 
 	 * @param WP_Post $post Post object.
 	 * @param bool $update Whether this is an existing post being updated or not.
 	 */
-	public function save_post( $post_id, $post, $update ) {
+	public function save_post($post_id, $post, $update) {
 
 		// We're setting the alternative label that have been provided via the UI
 		// (in fact we're using $_REQUEST), while save_post may be also called
@@ -469,15 +468,15 @@ 
 		// the $post_id in the save_post call matches the post id set in the request.
 		//
 		// If this is not the current post being saved or if it's not an entity, return.
-		if ( ! isset( $_REQUEST['post_ID'] ) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity( $post_id ) ) {
+		if ( ! isset($_REQUEST['post_ID']) || $_REQUEST['post_ID'] != $post_id || ! $this->is_entity($post_id)) {
 			return;
 		}
 
 		// Get the alt labels from the request (or empty array).
-		$alt_labels = isset( $_REQUEST['wl_alternative_label'] ) ? $_REQUEST['wl_alternative_label'] : array();
+		$alt_labels = isset($_REQUEST['wl_alternative_label']) ? $_REQUEST['wl_alternative_label'] : array();
 
 		// Set the alternative labels.
-		$this->set_alternative_labels( $post_id, $alt_labels );
+		$this->set_alternative_labels($post_id, $alt_labels);
 
 	}
 
@@ -489,22 +488,22 @@ 
 	 * @param int $post_id The post id.
 	 * @param array $alt_labels An array of labels.
 	 */
-	public function set_alternative_labels( $post_id, $alt_labels ) {
+	public function set_alternative_labels($post_id, $alt_labels) {
 
 		// Force $alt_labels to be an array
-		if ( ! is_array( $alt_labels ) ) {
-			$alt_labels = array( $alt_labels );
+		if ( ! is_array($alt_labels)) {
+			$alt_labels = array($alt_labels);
 		}
 
-		$this->log_service->debug( "Setting alternative labels [ post id :: $post_id ][ alt labels :: " . implode( ',', $alt_labels ) . " ]" );
+		$this->log_service->debug("Setting alternative labels [ post id :: $post_id ][ alt labels :: ".implode(',', $alt_labels)." ]");
 
 		// Delete all the existing alternate labels.
-		delete_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		delete_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 
 		// Set the alternative labels.
-		foreach ( $alt_labels as $alt_label ) {
-			if ( ! empty( $alt_label ) ) {
-				add_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label );
+		foreach ($alt_labels as $alt_label) {
+			if ( ! empty($alt_label)) {
+				add_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY, $alt_label);
 			}
 		}
 
@@ -519,9 +518,9 @@ 
 	 *
 	 * @return mixed An array  of alternative labels.
 	 */
-	public function get_alternative_labels( $post_id ) {
+	public function get_alternative_labels($post_id) {
 
-		return get_post_meta( $post_id, self::ALTERNATIVE_LABEL_META_KEY );
+		return get_post_meta($post_id, self::ALTERNATIVE_LABEL_META_KEY);
 	}
 
 	/**
@@ -531,25 +530,25 @@ 
 	 *
 	 * @param WP_Post $post Post object.
 	 */
-	public function edit_form_before_permalink( $post ) {
+	public function edit_form_before_permalink($post) {
 
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
+		if ( ! $this->is_entity($post->ID)) {
 			return;
 		}
 
 		// Print the input template.
-		$this->ui_service->print_template( 'wl-tmpl-alternative-label-input', $this->get_alternative_label_input() );
+		$this->ui_service->print_template('wl-tmpl-alternative-label-input', $this->get_alternative_label_input());
 
 		// Print all the currently set alternative labels.
-		foreach ( $this->get_alternative_labels( $post->ID ) as $alt_label ) {
+		foreach ($this->get_alternative_labels($post->ID) as $alt_label) {
 
-			echo $this->get_alternative_label_input( $alt_label );
+			echo $this->get_alternative_label_input($alt_label);
 
 		};
 
 		// Print the button.
-		$this->ui_service->print_button( 'wl-add-alternative-labels-button', __( 'Add more titles', 'wordlift' ) );
+		$this->ui_service->print_button('wl-add-alternative-labels-button', __('Add more titles', 'wordlift'));
 
 	}
 
@@ -563,32 +562,32 @@ 
 	public function in_admin_header() {
 
 		// Return safely if get_current_screen() is not defined (yet)
-		if ( FALSE === function_exists( 'get_current_screen' ) ) {
+		if (FALSE === function_exists('get_current_screen')) {
 			return;
 		}
 
 		$screen = get_current_screen();
 		// If there is any valid screen nothing to do
-		if ( NULL === $screen ) {
+		if (NULL === $screen) {
 			return $clauses;
 		}
 
 		// If you're not in the entity post edit page, return.
-		if ( self::TYPE_NAME !== $screen->id ) {
+		if (self::TYPE_NAME !== $screen->id) {
 			return;
 		}
 		// Retrieve the current global post
 		global $post;
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post->ID ) ) {
+		if ( ! $this->is_entity($post->ID)) {
 			return;
 		}
 		// Retrieve an updated rating for the current entity
-		$rating = $this->get_rating_for( $post->ID, TRUE );
+		$rating = $this->get_rating_for($post->ID, TRUE);
 		// If there is at least 1 warning
-		if ( isset( $rating['warnings'] ) && 0 < count( $rating['warnings'] ) ) {
+		if (isset($rating['warnings']) && 0 < count($rating['warnings'])) {
 			// TODO - Pass Wordlift_Notice_Service trough the service constructor 
-			$this->notice_service->add_suggestion( $rating['warnings'] );
+			$this->notice_service->add_suggestion($rating['warnings']);
 		}
 
 	}
@@ -602,19 +601,19 @@ 
 	 *
 	 * @return int An array representing the rating obj.
 	 */
-	public function set_rating_for( $post_id ) {
+	public function set_rating_for($post_id) {
 
 		// Calculate rating for the given post
-		$rating = $this->calculate_rating_for( $post_id );
+		$rating = $this->calculate_rating_for($post_id);
 		// Store the rating on db as post meta
 		// Please notice that RATING_RAW_SCORE_META_KEY 
 		// is saved on a different meta to allow score sorting
 		// Both meta are managed as unique
 		// https://codex.wordpress.org/Function_Reference/update_post_meta
-		update_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score'] );
-		update_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings'] );
+		update_post_meta($post_id, self::RATING_RAW_SCORE_META_KEY, $rating['raw_score']);
+		update_post_meta($post_id, self::RATING_WARNINGS_META_KEY, $rating['warnings']);
 
-		$this->log_service->trace( sprintf( "Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score'] ) );
+		$this->log_service->trace(sprintf("Rating set for [ post_id :: $post_id ] [ rating :: %s ]", $rating['raw_score']));
 
 		// Finally returns the rating 
 		return $rating;
@@ -630,29 +629,29 @@ 
 	 *
 	 * @return int An array representing the rating obj.
 	 */
-	public function get_rating_for( $post_id, $force_reload = FALSE ) {
+	public function get_rating_for($post_id, $force_reload = FALSE) {
 
 		// If forced reload is required or rating is missing ..
-		if ( $force_reload ) {
-			$this->log_service->trace( "Force rating reload [ post_id :: $post_id ]" );
+		if ($force_reload) {
+			$this->log_service->trace("Force rating reload [ post_id :: $post_id ]");
 
-			return $this->set_rating_for( $post_id );
+			return $this->set_rating_for($post_id);
 		}
 
-		$current_raw_score = get_post_meta( $post_id, self::RATING_RAW_SCORE_META_KEY, TRUE );
+		$current_raw_score = get_post_meta($post_id, self::RATING_RAW_SCORE_META_KEY, TRUE);
 
-		if ( ! is_numeric( $current_raw_score ) ) {
-			$this->log_service->trace( "Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]" );
+		if ( ! is_numeric($current_raw_score)) {
+			$this->log_service->trace("Rating missing for [ post_id :: $post_id ] [ current_raw_score :: $current_raw_score ]");
 
-			return $this->set_rating_for( $post_id );
+			return $this->set_rating_for($post_id);
 		}
-		$current_warnings = get_post_meta( $post_id, self::RATING_WARNINGS_META_KEY, TRUE );
+		$current_warnings = get_post_meta($post_id, self::RATING_WARNINGS_META_KEY, TRUE);
 
 		// Finally return score and warnings
 		return array(
 			'raw_score'           => $current_raw_score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $current_raw_score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $current_raw_score ),
+			'traffic_light_score' => $this->convert_raw_score_to_traffic_light($current_raw_score),
+			'percentage_score'    => $this->convert_raw_score_to_percentage($current_raw_score),
 			'warnings'            => $current_warnings,
 		);
 
@@ -678,44 +677,39 @@ 
 	 *
 	 * @return int An array representing the rating obj.
 	 */
-	public function calculate_rating_for( $post_id ) {
+	public function calculate_rating_for($post_id) {
 
 		// If it's not an entity, return.
-		if ( ! $this->is_entity( $post_id ) ) {
+		if ( ! $this->is_entity($post_id)) {
 			return;
 		}
 		// Retrieve the post object
-		$post = get_post( $post_id );
+		$post = get_post($post_id);
 		// Rating value
 		$score = 0;
 		// Store warning messages
 		$warnings = array();
 
 		// Is the current entity related to at least 1 post?
-		( 0 < count( wl_core_get_related_post_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_RELATED_POSTS, 'wordlift' ) );
+		(0 < count(wl_core_get_related_post_ids($post->ID))) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_HAS_RELATED_POSTS, 'wordlift'));
 
 		// Is the post content not empty?
-		( ! empty( $post->post_content ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_CONTENT_POST, 'wordlift' ) );
+		( ! empty($post->post_content)) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_HAS_CONTENT_POST, 'wordlift'));
 
 		// Is the current entity related to at least 1 entity?
 		// Was the current entity already disambiguated?
-		( 0 < count( wl_core_get_related_entity_ids( $post->ID ) ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_RELATED_ENTITIES, 'wordlift' ) );
+		(0 < count(wl_core_get_related_entity_ids($post->ID))) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_HAS_RELATED_ENTITIES, 'wordlift'));
 
 		// Is the entity published?
-		( 'publish' === get_post_status( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_IS_PUBLISHED, 'wordlift' ) );
+		('publish' === get_post_status($post->ID)) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_IS_PUBLISHED, 'wordlift'));
 
 		// Has a thumbnail?
-		( has_post_thumbnail( $post->ID ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_THUMBNAIL, 'wordlift' ) );
+		(has_post_thumbnail($post->ID)) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_HAS_THUMBNAIL, 'wordlift'));
 
 		// Get all post meta keys for the current post		
 		global $wpdb;
@@ -725,30 +719,27 @@ 
 
 		// Check intersection between available meta keys 
 		// and expected ones arrays to detect missing values
-		$available_meta_keys = $wpdb->get_col( $query );
+		$available_meta_keys = $wpdb->get_col($query);
 
 		// If each expected key is contained in available keys array ...
-		( in_array( Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_SAME_AS, 'wordlift' ) );
+		(in_array(Wordlift_Schema_Service::FIELD_SAME_AS, $available_meta_keys)) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_HAS_SAME_AS, 'wordlift'));
 
-		$schema = wl_entity_type_taxonomy_get_type( $post_id );
+		$schema = wl_entity_type_taxonomy_get_type($post_id);
 
-		$expected_meta_keys = ( NULL === $schema['custom_fields'] ) ?
-			array() :
-			array_keys( $schema['custom_fields'] );
+		$expected_meta_keys = (NULL === $schema['custom_fields']) ?
+			array() : array_keys($schema['custom_fields']);
 
-		$intersection = array_intersect( $expected_meta_keys, $available_meta_keys );
+		$intersection = array_intersect($expected_meta_keys, $available_meta_keys);
 		// If each expected key is contained in available keys array ...
-		( count( $intersection ) === count( $expected_meta_keys ) ) ?
-			$score ++ :
-			array_push( $warnings, __( self::RATING_WARNING_HAS_COMPLETED_METADATA, 'wordlift' ) );
+		(count($intersection) === count($expected_meta_keys)) ?
+			$score++ : array_push($warnings, __(self::RATING_WARNING_HAS_COMPLETED_METADATA, 'wordlift'));
 
 		// Finally return score and warnings
 		return array(
 			'raw_score'           => $score,
-			'traffic_light_score' => $this->convert_raw_score_to_traffic_light( $score ),
-			'percentage_score'    => $this->convert_raw_score_to_percentage( $score ),
+			'traffic_light_score' => $this->convert_raw_score_to_traffic_light($score),
+			'percentage_score'    => $this->convert_raw_score_to_percentage($score),
 			'warnings'            => $warnings,
 		);
 
@@ -763,25 +754,25 @@ 
 	 *
 	 * @return null|string The entity URI or NULL if not found or the dataset URI is not configured.
 	 */
-	public function get_uri( $post_id ) {
+	public function get_uri($post_id) {
 
 		// If a null is given, nothing to do
-		if ( NULL == $post_id ) {
+		if (NULL == $post_id) {
 			return NULL;
 		}
 
-		$uri = get_post_meta( $post_id, WL_ENTITY_URL_META_NAME, TRUE );
+		$uri = get_post_meta($post_id, WL_ENTITY_URL_META_NAME, TRUE);
 
 		// If the dataset uri is not properly configured, null is returned
-		if ( '' === wl_configuration_get_redlink_dataset_uri() ) {
+		if ('' === wl_configuration_get_redlink_dataset_uri()) {
 			return NULL;
 		}
 
 		// Set the URI if it isn't set yet.
-		$post_status = get_post_status( $post_id );
-		if ( empty( $uri ) && 'auto-draft' !== $post_status && 'revision' !== $post_status ) {
-			$uri = wl_build_entity_uri( $post_id );
-			wl_set_entity_uri( $post_id, $uri );
+		$post_status = get_post_status($post_id);
+		if (empty($uri) && 'auto-draft' !== $post_status && 'revision' !== $post_status) {
+			$uri = wl_build_entity_uri($post_id);
+			wl_set_entity_uri($post_id, $uri);
 		}
 
 		return $uri;
@@ -796,13 +787,13 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	private function convert_raw_score_to_traffic_light( $score ) {
+	private function convert_raw_score_to_traffic_light($score) {
 		// RATING_MAX : $score = 3 : x 
 		// See http://php.net/manual/en/function.round.php
-		$rating = round( ( $score * 3 ) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP );
+		$rating = round(($score * 3) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP);
 
 		// If rating is 0, return 1, otherwise return rating
-		return ( 0 == $rating ) ? 1 : $rating;
+		return (0 == $rating) ? 1 : $rating;
 
 	}
 
@@ -815,9 +806,9 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	public function convert_raw_score_to_percentage( $score ) {
+	public function convert_raw_score_to_percentage($score) {
 		// RATING_MAX : $score = 100 : x 
-		return round( ( $score * 100 ) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP );
+		return round(($score * 100) / self::get_rating_max(), 0, PHP_ROUND_HALF_UP);
 	}
 
 	/**
@@ -829,9 +820,9 @@ 
 	 *
 	 * @return string The input HTML code.
 	 */
-	private function get_alternative_label_input( $value = '' ) {
+	private function get_alternative_label_input($value = '') {
 
-		return sprintf( self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr( $value ), __( 'Delete', 'wordlift' ) );
+		return sprintf(self::ALTERNATIVE_LABEL_INPUT_TEMPLATE, esc_attr($value), __('Delete', 'wordlift'));
 	}
 
 	/**
@@ -843,7 +834,7 @@ 
 	 */
 	public function count() {
 
-		$count = wp_count_posts( self::TYPE_NAME );
+		$count = wp_count_posts(self::TYPE_NAME);
 
 		return $count->publish;
 	}

src/wordlift_content_filter.php

Indentation +172 added lines, -172 removed lines

@@ -10,7 +10,7 @@ 
  * @param string $uri Uri of the entity to search in the post content.
  */
 function wl_content_embed_build_regex_from_uri( $uri ) {
-	return '|<(\\w+)[^<]* itemid=\"' . esc_attr( $uri ) . '\"[^>]*>([^<]*)<\\/\\1>|i';
+    return '|<(\\w+)[^<]* itemid=\"' . esc_attr( $uri ) . '\"[^>]*>([^<]*)<\\/\\1>|i';
 }
 
 /**
@@ -22,8 +22,8 @@ 
  */
 function wl_content_embed_microdata( $content ) {
 
-	// Apply microdata only to single pages.
-	/*if ( ! is_single() ) {
+    // Apply microdata only to single pages.
+    /*if ( ! is_single() ) {
 		wl_write_log( "wl_content_embed_microdata : is not single" );
 
 		return $content;
@@ -31,7 +31,7 @@ 
 
 	global $post;
         */
-	return _wl_content_embed_microdata( get_the_ID(), $content );
+    return _wl_content_embed_microdata( get_the_ID(), $content );
 }
 
 /**
@@ -44,31 +44,31 @@ 
  */
 function _wl_content_embed_microdata( $post_id, $content ) {
 
-	// If it is an entity, add its own microdata to the content.
-	if ( get_post_type( $post_id ) == Wordlift_Entity_Service::TYPE_NAME ) {
-		$own_uri = wl_get_entity_uri( $post_id );
-		$content .= '<span itemid="' . $own_uri . '"></span>';
-	}
+    // If it is an entity, add its own microdata to the content.
+    if ( get_post_type( $post_id ) == Wordlift_Entity_Service::TYPE_NAME ) {
+        $own_uri = wl_get_entity_uri( $post_id );
+        $content .= '<span itemid="' . $own_uri . '"></span>';
+    }
 
-	// Now search in the text entity mentions
-	$regex   = '/<(\\w+)[^<]* itemid=\"([^"]+)\"[^>]*>([^<]*)<\\/\\1>/i';
-	$matches = array();
+    // Now search in the text entity mentions
+    $regex   = '/<(\\w+)[^<]* itemid=\"([^"]+)\"[^>]*>([^<]*)<\\/\\1>/i';
+    $matches = array();
 
-	// Return the content if not item IDs have been found.
-	if ( FALSE === preg_match_all( $regex, $content, $matches, PREG_SET_ORDER ) ) {
-		return $content;
-	}
+    // Return the content if not item IDs have been found.
+    if ( FALSE === preg_match_all( $regex, $content, $matches, PREG_SET_ORDER ) ) {
+        return $content;
+    }
 
-	// TODO: Retrieve here just one time entities type structure to avoid multiple queries.
-	foreach ( $matches as $match ) {
-		$item_id = $match[2];
+    // TODO: Retrieve here just one time entities type structure to avoid multiple queries.
+    foreach ( $matches as $match ) {
+        $item_id = $match[2];
 
-		// wl_write_log( "_wl_content_embed_microdata [ item ID :: $item_id ]" );
+        // wl_write_log( "_wl_content_embed_microdata [ item ID :: $item_id ]" );
 
-		$content = wl_content_embed_item_microdata( $content, $item_id );
-	}
+        $content = wl_content_embed_item_microdata( $content, $item_id );
+    }
 
-	return $content;
+    return $content;
 }
 
 /**
@@ -82,80 +82,80 @@ 
  */
 function wl_content_embed_item_microdata( $content, $uri, $itemprop = NULL, $recursion_level = 0 ) {
 
-	// The recursion level is set by `wl_content_embed_compile_microdata_template`
-	// which is loading referenced entities and calling again this function to print
-	// additional properties. By default WordLift doesn't print more than 3 nested
-	// entities.
-	if ( $recursion_level > wl_config_get_recursion_depth() ) {
-		wl_write_log( "recursion depth limit exceeded [ level :: $recursion_level ][ max :: " . wl_config_get_recursion_depth() . " ]" );
+    // The recursion level is set by `wl_content_embed_compile_microdata_template`
+    // which is loading referenced entities and calling again this function to print
+    // additional properties. By default WordLift doesn't print more than 3 nested
+    // entities.
+    if ( $recursion_level > wl_config_get_recursion_depth() ) {
+        wl_write_log( "recursion depth limit exceeded [ level :: $recursion_level ][ max :: " . wl_config_get_recursion_depth() . " ]" );
 
-		return '';
-	}
+        return '';
+    }
 
-	$post = Wordlift_Entity_Service::get_instance()
-	                               ->get_entity_post_by_uri( $uri );
+    $post = Wordlift_Entity_Service::get_instance()
+                                    ->get_entity_post_by_uri( $uri );
 
-	// Entity not found or not published. Delete <span> tags but leave their content on page.
-	if ( NULL === $post || $post->post_status !== 'publish' ) {
+    // Entity not found or not published. Delete <span> tags but leave their content on page.
+    if ( NULL === $post || $post->post_status !== 'publish' ) {
 
-		// wl_write_log( "wl_content_embed_item_microdata : entity not found or not published [ uri :: $uri ]" );
+        // wl_write_log( "wl_content_embed_item_microdata : entity not found or not published [ uri :: $uri ]" );
 
-		// Replace the original tagging with the new tagging.
-		$regex   = wl_content_embed_build_regex_from_uri( $uri );
-		$content = preg_replace( $regex, '$2', $content );
+        // Replace the original tagging with the new tagging.
+        $regex   = wl_content_embed_build_regex_from_uri( $uri );
+        $content = preg_replace( $regex, '$2', $content );
 
-		return $content;
-	}
+        return $content;
+    }
 
-	// Get the entity URI and its escaped version for the regex.
-	$entity_uri = wl_get_entity_uri( $post->ID );
-	// Get the main type.
-	$main_type = wl_entity_type_taxonomy_get_type( $post->ID );
+    // Get the entity URI and its escaped version for the regex.
+    $entity_uri = wl_get_entity_uri( $post->ID );
+    // Get the main type.
+    $main_type = wl_entity_type_taxonomy_get_type( $post->ID );
 
-	// Set the item type if available.
-	$item_type = ( NULL === $main_type ? '' : ' itemtype="' . esc_attr( $main_type['uri'] ) . '"' );
+    // Set the item type if available.
+    $item_type = ( NULL === $main_type ? '' : ' itemtype="' . esc_attr( $main_type['uri'] ) . '"' );
 
-	// Define attribute itemprop if this entity is nested.
-	if ( ! is_null( $itemprop ) ) {
-		$itemprop = ' itemprop="' . $itemprop . '"';
-	}
+    // Define attribute itemprop if this entity is nested.
+    if ( ! is_null( $itemprop ) ) {
+        $itemprop = ' itemprop="' . $itemprop . '"';
+    }
 
-	// Get additional properties (this may imply a recursion of this method on a sub-entity).
-	$additional_properties = wl_content_embed_compile_microdata_template( $post->ID, $main_type, $recursion_level );
+    // Get additional properties (this may imply a recursion of this method on a sub-entity).
+    $additional_properties = wl_content_embed_compile_microdata_template( $post->ID, $main_type, $recursion_level );
 
-	$same_as = '';
-	// Get the array of sameAs uris.
-	$same_as_uris = wl_schema_get_value( $post->ID, 'sameAs' );
-	// Prepare the sameAs fragment.
-	foreach ( $same_as_uris as $same_as_uri ) {
-		$same_as .= "<link itemprop=\"sameAs\" href=\"$same_as_uri\">";
-	}
+    $same_as = '';
+    // Get the array of sameAs uris.
+    $same_as_uris = wl_schema_get_value( $post->ID, 'sameAs' );
+    // Prepare the sameAs fragment.
+    foreach ( $same_as_uris as $same_as_uri ) {
+        $same_as .= "<link itemprop=\"sameAs\" href=\"$same_as_uri\">";
+    }
 
-	// Get the entity URL.
-	$permalink = get_permalink( $post->ID );
-	$url       = '<link itemprop="url" href="' . $permalink . '" />';
+    // Get the entity URL.
+    $permalink = get_permalink( $post->ID );
+    $url       = '<link itemprop="url" href="' . $permalink . '" />';
 
 
-	// If entity is nested, we do not show a link, but a hidden meta.
-	// See https://github.com/insideout10/wordlift-plugin/issues/348
-	$name = ! is_null( $itemprop )
-		? "<meta itemprop='name' content='$post->post_title' /></$1>"
-		: '<a class="wl-entity-page-link" href="' . $permalink . '" itemprop="name" content="' . $post->post_title . '">' . ( is_null( $itemprop ) ? '$2' : '' ) . '</a></$1>';
+    // If entity is nested, we do not show a link, but a hidden meta.
+    // See https://github.com/insideout10/wordlift-plugin/issues/348
+    $name = ! is_null( $itemprop )
+        ? "<meta itemprop='name' content='$post->post_title' /></$1>"
+        : '<a class="wl-entity-page-link" href="' . $permalink . '" itemprop="name" content="' . $post->post_title . '">' . ( is_null( $itemprop ) ? '$2' : '' ) . '</a></$1>';
 
-	// Replace the original tagging with the new tagging.
-	$regex   = wl_content_embed_build_regex_from_uri( $uri );
-	$content = preg_replace( $regex,
-		'<$1' . $itemprop . ' itemscope' . $item_type . ' itemid="' . esc_attr( $entity_uri ) . '">'
-		. $same_as
-		. $additional_properties
-		. $url
-		. $name,
-		$content
-	);
+    // Replace the original tagging with the new tagging.
+    $regex   = wl_content_embed_build_regex_from_uri( $uri );
+    $content = preg_replace( $regex,
+        '<$1' . $itemprop . ' itemscope' . $item_type . ' itemid="' . esc_attr( $entity_uri ) . '">'
+        . $same_as
+        . $additional_properties
+        . $url
+        . $name,
+        $content
+    );
 
-	// wl_write_log( "wl_content_embed_item_microdata [ uri :: $uri ][ regex :: $regex ]" );
+    // wl_write_log( "wl_content_embed_item_microdata [ uri :: $uri ][ regex :: $regex ]" );
 
-	return $content;
+    return $content;
 }
 
 add_filter( 'the_content', 'wl_content_embed_microdata' );
@@ -170,96 +170,96 @@ 
  * @return string The content with embedded microdata.
  */
 function wl_content_embed_compile_microdata_template( $entity_id, $entity_type, $recursion_level = 0 ) {
-	global $wl_logger;
-
-	if ( WP_DEBUG ) {
-		$wl_logger->trace( "Embedding microdata [ entity id :: $entity_id ][ recursion level :: $recursion_level ]" );
-	}
-
-	$regex   = '/{{(.*?)}}/';
-	$matches = array();
-
-	if ( NULL === $entity_type ) {
-		return '';
-	}
-
-	$template = $entity_type['microdata_template'];
-	// Return empty string if template fields have not been found.
-	if ( FALSE === preg_match_all( $regex, $template, $matches, PREG_SET_ORDER ) ) {
-		return '';
-	}
-
-	foreach ( $matches as $match ) {
-
-		$placeholder = $match[0];
-		$field_name  = $match[1];
-
-		// Get property value.
-		$meta_collection = wl_schema_get_value( $entity_id, $field_name );
-
-		// If no value is given, just remove the placeholder from the template
-		if ( NULL == $meta_collection ) {
-			$template = str_replace( $placeholder, '', $template );
-			continue;
-		}
-
-		// What kind of value is it?
-		// TODO: Performance issue here: meta type retrieving should be centralized
-		$expected_type = wl_get_meta_type( $field_name );
-
-		if ( WP_DEBUG ) {
-			$wl_logger->trace( "Embedding microdata [ placeholder :: $placeholder ][ field name :: $field_name ][ meta collection :: " . ( is_array( $meta_collection ) ? var_export( $meta_collection, TRUE ) : $meta_collection ) . " ][ expected type :: $expected_type ]" );
-		}
-
-		foreach ( $meta_collection as $field_value ) {
-
-			// Quick and dirty patch for #163:
-			//  - only apply to URIs, i.e. to properties pointing to another post ( $field_value should be a post ID ),
-			//  - check that $field_value is actually a number,
-			//  - check that the referenced post is published.
-			//  OR
-			//  - if the value is empty then we don't display it.
-			//
-			// see https://github.com/insideout10/wordlift-plugin/issues/163
-			if ( Wordlift_Schema_Service::DATA_TYPE_URI === $expected_type && is_numeric( $field_value ) && 'publish' !== ( $post_status = get_post_status( $field_value ) )
-			     || empty( $field_value )
-			) {
-
-				if ( WP_DEBUG ) {
-					$wl_logger->trace( "Microdata refers to a non-published post [ field value :: $field_value ][ post status :: $post_status ]" );
-				}
-
-				// Remove the placeholder.
-				$template = str_replace( $placeholder, '', $template );
-				continue;
-			}
-
-			if ( Wordlift_Schema_Service::DATA_TYPE_URI == $expected_type ) {
-				// If is a numeric value we assume it is an ID referencing for an internal entity.
-				if ( is_numeric( $field_value ) ) {
-					// Found id, get uri.
-					$field_value = wl_get_entity_uri( $field_value );
-				}
-				// Just if the linked entity does exist I can go further with template compiling
-				$nested_entity = Wordlift_Entity_Service::get_instance()
-				                                        ->get_entity_post_by_uri( $field_value );
-				if ( ! is_null( $nested_entity ) ) {
-					$content           = '<span itemid="' . esc_attr( $field_value ) . '">' . $nested_entity->post_title . '</span>';
-					$compiled_template = wl_content_embed_item_microdata( $content, $field_value, $field_name, ++ $recursion_level );
-					$template          = str_replace( $placeholder, $compiled_template, $template );
-				} else {
-					$template = str_replace( $placeholder, '', $template );
-				}
-				continue;
-			}
-
-			// Standard condition: field containing a raw value
-			// For non visible test, schema.org dictates to use the *meta* tag.
-			// see http://schema.org/docs/gs.html#advanced_missing
-			$value    = '<meta itemprop="' . esc_attr( $field_name ) . '" content="' . esc_attr( $field_value ) . '" />';
-			$template = str_replace( $placeholder, $value, $template );
-		}
-	}
-
-	return $template;
+    global $wl_logger;
+
+    if ( WP_DEBUG ) {
+        $wl_logger->trace( "Embedding microdata [ entity id :: $entity_id ][ recursion level :: $recursion_level ]" );
+    }
+
+    $regex   = '/{{(.*?)}}/';
+    $matches = array();
+
+    if ( NULL === $entity_type ) {
+        return '';
+    }
+
+    $template = $entity_type['microdata_template'];
+    // Return empty string if template fields have not been found.
+    if ( FALSE === preg_match_all( $regex, $template, $matches, PREG_SET_ORDER ) ) {
+        return '';
+    }
+
+    foreach ( $matches as $match ) {
+
+        $placeholder = $match[0];
+        $field_name  = $match[1];
+
+        // Get property value.
+        $meta_collection = wl_schema_get_value( $entity_id, $field_name );
+
+        // If no value is given, just remove the placeholder from the template
+        if ( NULL == $meta_collection ) {
+            $template = str_replace( $placeholder, '', $template );
+            continue;
+        }
+
+        // What kind of value is it?
+        // TODO: Performance issue here: meta type retrieving should be centralized
+        $expected_type = wl_get_meta_type( $field_name );
+
+        if ( WP_DEBUG ) {
+            $wl_logger->trace( "Embedding microdata [ placeholder :: $placeholder ][ field name :: $field_name ][ meta collection :: " . ( is_array( $meta_collection ) ? var_export( $meta_collection, TRUE ) : $meta_collection ) . " ][ expected type :: $expected_type ]" );
+        }
+
+        foreach ( $meta_collection as $field_value ) {
+
+            // Quick and dirty patch for #163:
+            //  - only apply to URIs, i.e. to properties pointing to another post ( $field_value should be a post ID ),
+            //  - check that $field_value is actually a number,
+            //  - check that the referenced post is published.
+            //  OR
+            //  - if the value is empty then we don't display it.
+            //
+            // see https://github.com/insideout10/wordlift-plugin/issues/163
+            if ( Wordlift_Schema_Service::DATA_TYPE_URI === $expected_type && is_numeric( $field_value ) && 'publish' !== ( $post_status = get_post_status( $field_value ) )
+                 || empty( $field_value )
+            ) {
+
+                if ( WP_DEBUG ) {
+                    $wl_logger->trace( "Microdata refers to a non-published post [ field value :: $field_value ][ post status :: $post_status ]" );
+                }
+
+                // Remove the placeholder.
+                $template = str_replace( $placeholder, '', $template );
+                continue;
+            }
+
+            if ( Wordlift_Schema_Service::DATA_TYPE_URI == $expected_type ) {
+                // If is a numeric value we assume it is an ID referencing for an internal entity.
+                if ( is_numeric( $field_value ) ) {
+                    // Found id, get uri.
+                    $field_value = wl_get_entity_uri( $field_value );
+                }
+                // Just if the linked entity does exist I can go further with template compiling
+                $nested_entity = Wordlift_Entity_Service::get_instance()
+                                                        ->get_entity_post_by_uri( $field_value );
+                if ( ! is_null( $nested_entity ) ) {
+                    $content           = '<span itemid="' . esc_attr( $field_value ) . '">' . $nested_entity->post_title . '</span>';
+                    $compiled_template = wl_content_embed_item_microdata( $content, $field_value, $field_name, ++ $recursion_level );
+                    $template          = str_replace( $placeholder, $compiled_template, $template );
+                } else {
+                    $template = str_replace( $placeholder, '', $template );
+                }
+                continue;
+            }
+
+            // Standard condition: field containing a raw value
+            // For non visible test, schema.org dictates to use the *meta* tag.
+            // see http://schema.org/docs/gs.html#advanced_missing
+            $value    = '<meta itemprop="' . esc_attr( $field_name ) . '" content="' . esc_attr( $field_value ) . '" />';
+            $template = str_replace( $placeholder, $value, $template );
+        }
+    }
+
+    return $template;
 }
\ No newline at end of file

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

Doc Comments +1 added lines, -1 removed lines

@@ -291,7 +291,7 @@
 	 *
 	 * @since 3.7.0
 	 *
-	 * @param $value int A date value.
+	 * @param integer $value int A date value.
 	 *
 	 * @return array An array containing year, month and day values.
 	 */

Indentation +297 added lines, -297 removed lines

@@ -7,302 +7,302 @@
  */
 class Wordlift_Timeline_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log_service The Log service.
-	 */
-	private $log_service;
-
-	/**
-	 * The Entity service.
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service The Entity service.
-	 */
-	private $entity_service;
-
-	/**
-	 * The number of words to use for the excerpt, set in the `to_json` function
-	 * and used by a filter.
-	 *
-	 * @since 3.7.0
-	 * @access private
-	 * @var int $excerpt_length The number of words to use for the excerpt.
-	 */
-	private $excerpt_length;
-
-	/**
-	 * A singleton instance of the Timeline service (useful for unit tests).
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var \Wordlift_Timeline_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Timeline_Service instance.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param \Wordlift_Entity_Service $entity_service The Entity service.
-	 */
-	public function __construct( $entity_service ) {
-
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
-
-		$this->entity_service = $entity_service;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Wordlift_Timeline_Service
-	 *
-	 * @since 3.1.0
-	 *
-	 * @return \Wordlift_Timeline_Service The singleton instance of the Wordlift_Timeline_Service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Retrieve timeline events and output them in JSON.
-	 *
-	 * @since 3.1.0
-	 */
-	public function ajax_timeline() {
-
-		// Get the ID of the post who requested the timeline.
-		$post_id = ( isset( $_REQUEST['post_id'] ) ? $_REQUEST['post_id'] : NULL );
-
-		// Get the events and transform them for the JSON response, then send them to the client.
-		wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
-
-	}
-
-	/**
-	 * Retrieve timeline events.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @uses wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
-	 *
-	 * @param int $post_id The post ID.
-	 *
-	 * @return array An array of event posts.
-	 */
-	public function get_events( $post_id = NULL ) {
-
-		// Get the entity IDs either from the entities related to the specified post or from the last 50 published
-		// posts if no post has been specified.
-		$ids = ( is_numeric( $post_id )
-			? wl_core_get_related_entity_ids( $post_id )
-			: $this->entity_service->get_all_related_to_last_50_published_posts() );
-
-		// Add the post itself if it's an entity.
-		if ( is_numeric( $post_id ) && $this->entity_service->is_entity( $post_id ) ) {
-			$ids[] = $post_id;
-		}
-
-		// If there's no entities, return an empty array right away.
-		if ( 0 === sizeof( $ids ) ) {
-			$this->log_service->trace( "No events found [ post id :: $post_id ]" );
-
-			return array();
-		}
-
-		$this->log_service->trace( "Getting events [ entity ids :: " . join( ', ', $ids ) . " ]" );
-
-		return get_posts( array(
-			'post__in'       => $ids,
-			'post_type'      => Wordlift_Entity_Service::TYPE_NAME,
-			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
-			'meta_query'     => array(
-				'relation' => 'AND',
-				array(
-					'key'     => Wordlift_Schema_Service::FIELD_DATE_START,
-					'value'   => NULL,
-					'compare' => '!='
-				),
-				array(
-					'key'     => Wordlift_Schema_Service::FIELD_DATE_END,
-					'value'   => NULL,
-					'compare' => '!='
-				)
-			),
-			'tax_query'      => array(
-				'taxonomy' => Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'event'
-			)
-		) );
-	}
-
-	/**
-	 * Convert timeline events to JSON. This function sets the global post in order
-	 * to get an automatic excerpt. Since we're being called inside an AJAX request,
-	 * we're not taking care of restoring any previous post: there isn't any.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param array $posts An array of posts.
-	 *
-	 * @return array|string An array of timeline events or an empty string if no posts are provided.
-	 */
-	public function to_json( $posts ) {
-
-		// If there are no events, return empty JSON
-		if ( empty( $posts ) || is_null( $posts ) ) {
-			return '';
-		}
-
-		// {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
-		$display_images_as = isset( $_REQUEST['display_images_as'] ) ? $_REQUEST['display_images_as'] : 'media';
-
-		// The number of words for the excerpt (by default 55, as WordPress).
-		$this->excerpt_length = isset( $_REQUEST['excerpt_words'] ) && is_numeric( $_REQUEST['excerpt_words'] ) ? $_REQUEST['excerpt_words'] : 55;
-		add_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
-
-		// Add a filter to remove the [...] after excerpts, since we're adding
-		// a link to the post itself.
-		add_filter( 'excerpt_more', array( $this, 'excerpt_more' ) );
-
-		// Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
-		$start_at_slide = 0;
-		$event_index    = - 1;
-		$now            = time();
-
-		// Prepare the timeline variable.
-		$timeline = array();
-
-		// Populate the arrays.
-		$timeline['events'] = array_map( function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as ) {
-
-			// Get the start and end dates.
-			$start_date = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, TRUE ) );
-			$end_date   = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, TRUE ) );
-
-			// Set the starting slide.
-			$event_index ++;
-			if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
-				$start_at_slide = $event_index;
-			}
-
-			// Load thumbnail
-			if ( '' !== ( $thumbnail_id = get_post_thumbnail_id( $item->ID ) )
-			     && FALSE !== ( $attachment = wp_get_attachment_image_src( $thumbnail_id ) )
-			) {
-
-				// Set the thumbnail URL.
-				if ( 'background' === $display_images_as ) {
-					$date['background'] = array( 'url' => $attachment[0], );
-					$date['media']      = array( 'thumbnail' => $attachment[0], );
-				} else {
-					$date['media'] = array(
-						'url'       => $attachment[0],
-						'thumbnail' => $attachment[0],
-					);
-				}
-
-			}
-
-			// Set the start/end dates by converting them to TimelineJS required format.
-			$date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
-			$date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
-
-			setup_postdata( $GLOBALS['post'] = &$item );
-
-			$more_link_text = sprintf(
-				'<span aria-label="%1$s">%2$s</span>',
-				sprintf(
-				/* translators: %s: Name of current post */
-					__( 'Continue reading %s' ),
-					the_title_attribute( array( 'echo' => FALSE ) )
-				),
-				__( '(more&hellip;)' )
-			);
-
-			// Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
-			$date['text'] = array(
-				'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
-			);
-
-			// If we have an excerpt, set it.
-			if ( 0 < $this->excerpt_length ) {
-				$date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt( $item ), get_permalink(), $more_link_text );
-			}
-
-			return $date;
-
-		}, $posts );
-
-		// Finally remove the excerpt filter.
-		remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
-
-		// The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
-		return array(
-			'timeline'       => $timeline,
-			'start_at_slide' => $start_at_slide,
-		);
-	}
-
-	/**
-	 * This function filters {@link excerpt_more} by removing it, since we're
-	 * adding the 'read more' link. This filter is set by {@see to_json}.
-	 *
-	 * @since 3.7.0
-	 *
-	 * @param string $excerpt_more The excerpt more preset.
-	 *
-	 * @return string An empty string.
-	 */
-	public function excerpt_more( $excerpt_more ) {
-
-		return '';
-	}
-
-	/**
-	 * A filter for the excerpt length, set by the `to_json` function, to tailor
-	 * how many words to return according to the client setting.
-	 *
-	 * @since 3.7.0
-	 *
-	 * @param int $length The preset number of words.
-	 *
-	 * @return int The number of words for the preset.
-	 */
-	public function excerpt_length( $length ) {
-
-		return $this->excerpt_length;
-	}
-
-
-	/**
-	 * Convert the date to a date array.
-	 *
-	 * @since 3.7.0
-	 *
-	 * @param $value int A date value.
-	 *
-	 * @return array An array containing year, month and day values.
-	 */
-	public static function date( $value ) {
-
-		return array(
-			'year'  => (int) date( 'Y', $value ),
-			'month' => (int) date( 'm', $value ),
-			'day'   => (int) date( 'd', $value ),
-
-		);
-	}
+    /**
+     * The Log service.
+     *
+     * @since 3.1.0
+     * @access private
+     * @var \Wordlift_Log_Service $log_service The Log service.
+     */
+    private $log_service;
+
+    /**
+     * The Entity service.
+     *
+     * @since 3.1.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service The Entity service.
+     */
+    private $entity_service;
+
+    /**
+     * The number of words to use for the excerpt, set in the `to_json` function
+     * and used by a filter.
+     *
+     * @since 3.7.0
+     * @access private
+     * @var int $excerpt_length The number of words to use for the excerpt.
+     */
+    private $excerpt_length;
+
+    /**
+     * A singleton instance of the Timeline service (useful for unit tests).
+     *
+     * @since 3.1.0
+     * @access private
+     * @var \Wordlift_Timeline_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Timeline_Service instance.
+     *
+     * @since 3.1.0
+     *
+     * @param \Wordlift_Entity_Service $entity_service The Entity service.
+     */
+    public function __construct( $entity_service ) {
+
+        $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
+
+        $this->entity_service = $entity_service;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Wordlift_Timeline_Service
+     *
+     * @since 3.1.0
+     *
+     * @return \Wordlift_Timeline_Service The singleton instance of the Wordlift_Timeline_Service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Retrieve timeline events and output them in JSON.
+     *
+     * @since 3.1.0
+     */
+    public function ajax_timeline() {
+
+        // Get the ID of the post who requested the timeline.
+        $post_id = ( isset( $_REQUEST['post_id'] ) ? $_REQUEST['post_id'] : NULL );
+
+        // Get the events and transform them for the JSON response, then send them to the client.
+        wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
+
+    }
+
+    /**
+     * Retrieve timeline events.
+     *
+     * @since 3.1.0
+     *
+     * @uses wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
+     *
+     * @param int $post_id The post ID.
+     *
+     * @return array An array of event posts.
+     */
+    public function get_events( $post_id = NULL ) {
+
+        // Get the entity IDs either from the entities related to the specified post or from the last 50 published
+        // posts if no post has been specified.
+        $ids = ( is_numeric( $post_id )
+            ? wl_core_get_related_entity_ids( $post_id )
+            : $this->entity_service->get_all_related_to_last_50_published_posts() );
+
+        // Add the post itself if it's an entity.
+        if ( is_numeric( $post_id ) && $this->entity_service->is_entity( $post_id ) ) {
+            $ids[] = $post_id;
+        }
+
+        // If there's no entities, return an empty array right away.
+        if ( 0 === sizeof( $ids ) ) {
+            $this->log_service->trace( "No events found [ post id :: $post_id ]" );
+
+            return array();
+        }
+
+        $this->log_service->trace( "Getting events [ entity ids :: " . join( ', ', $ids ) . " ]" );
+
+        return get_posts( array(
+            'post__in'       => $ids,
+            'post_type'      => Wordlift_Entity_Service::TYPE_NAME,
+            'post_status'    => 'publish',
+            'posts_per_page' => - 1,
+            'meta_query'     => array(
+                'relation' => 'AND',
+                array(
+                    'key'     => Wordlift_Schema_Service::FIELD_DATE_START,
+                    'value'   => NULL,
+                    'compare' => '!='
+                ),
+                array(
+                    'key'     => Wordlift_Schema_Service::FIELD_DATE_END,
+                    'value'   => NULL,
+                    'compare' => '!='
+                )
+            ),
+            'tax_query'      => array(
+                'taxonomy' => Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'event'
+            )
+        ) );
+    }
+
+    /**
+     * Convert timeline events to JSON. This function sets the global post in order
+     * to get an automatic excerpt. Since we're being called inside an AJAX request,
+     * we're not taking care of restoring any previous post: there isn't any.
+     *
+     * @since 3.1.0
+     *
+     * @param array $posts An array of posts.
+     *
+     * @return array|string An array of timeline events or an empty string if no posts are provided.
+     */
+    public function to_json( $posts ) {
+
+        // If there are no events, return empty JSON
+        if ( empty( $posts ) || is_null( $posts ) ) {
+            return '';
+        }
+
+        // {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
+        $display_images_as = isset( $_REQUEST['display_images_as'] ) ? $_REQUEST['display_images_as'] : 'media';
+
+        // The number of words for the excerpt (by default 55, as WordPress).
+        $this->excerpt_length = isset( $_REQUEST['excerpt_words'] ) && is_numeric( $_REQUEST['excerpt_words'] ) ? $_REQUEST['excerpt_words'] : 55;
+        add_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+
+        // Add a filter to remove the [...] after excerpts, since we're adding
+        // a link to the post itself.
+        add_filter( 'excerpt_more', array( $this, 'excerpt_more' ) );
+
+        // Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
+        $start_at_slide = 0;
+        $event_index    = - 1;
+        $now            = time();
+
+        // Prepare the timeline variable.
+        $timeline = array();
+
+        // Populate the arrays.
+        $timeline['events'] = array_map( function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as ) {
+
+            // Get the start and end dates.
+            $start_date = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, TRUE ) );
+            $end_date   = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, TRUE ) );
+
+            // Set the starting slide.
+            $event_index ++;
+            if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
+                $start_at_slide = $event_index;
+            }
+
+            // Load thumbnail
+            if ( '' !== ( $thumbnail_id = get_post_thumbnail_id( $item->ID ) )
+                 && FALSE !== ( $attachment = wp_get_attachment_image_src( $thumbnail_id ) )
+            ) {
+
+                // Set the thumbnail URL.
+                if ( 'background' === $display_images_as ) {
+                    $date['background'] = array( 'url' => $attachment[0], );
+                    $date['media']      = array( 'thumbnail' => $attachment[0], );
+                } else {
+                    $date['media'] = array(
+                        'url'       => $attachment[0],
+                        'thumbnail' => $attachment[0],
+                    );
+                }
+
+            }
+
+            // Set the start/end dates by converting them to TimelineJS required format.
+            $date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
+            $date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
+
+            setup_postdata( $GLOBALS['post'] = &$item );
+
+            $more_link_text = sprintf(
+                '<span aria-label="%1$s">%2$s</span>',
+                sprintf(
+                /* translators: %s: Name of current post */
+                    __( 'Continue reading %s' ),
+                    the_title_attribute( array( 'echo' => FALSE ) )
+                ),
+                __( '(more&hellip;)' )
+            );
+
+            // Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
+            $date['text'] = array(
+                'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
+            );
+
+            // If we have an excerpt, set it.
+            if ( 0 < $this->excerpt_length ) {
+                $date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt( $item ), get_permalink(), $more_link_text );
+            }
+
+            return $date;
+
+        }, $posts );
+
+        // Finally remove the excerpt filter.
+        remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+
+        // The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
+        return array(
+            'timeline'       => $timeline,
+            'start_at_slide' => $start_at_slide,
+        );
+    }
+
+    /**
+     * This function filters {@link excerpt_more} by removing it, since we're
+     * adding the 'read more' link. This filter is set by {@see to_json}.
+     *
+     * @since 3.7.0
+     *
+     * @param string $excerpt_more The excerpt more preset.
+     *
+     * @return string An empty string.
+     */
+    public function excerpt_more( $excerpt_more ) {
+
+        return '';
+    }
+
+    /**
+     * A filter for the excerpt length, set by the `to_json` function, to tailor
+     * how many words to return according to the client setting.
+     *
+     * @since 3.7.0
+     *
+     * @param int $length The preset number of words.
+     *
+     * @return int The number of words for the preset.
+     */
+    public function excerpt_length( $length ) {
+
+        return $this->excerpt_length;
+    }
+
+
+    /**
+     * Convert the date to a date array.
+     *
+     * @since 3.7.0
+     *
+     * @param $value int A date value.
+     *
+     * @return array An array containing year, month and day values.
+     */
+    public static function date( $value ) {
+
+        return array(
+            'year'  => (int) date( 'Y', $value ),
+            'month' => (int) date( 'm', $value ),
+            'day'   => (int) date( 'd', $value ),
+
+        );
+    }
 
 }

Spacing +48 added lines, -48 removed lines

@@ -51,9 +51,9 @@ 
 	 *
 	 * @param \Wordlift_Entity_Service $entity_service The Entity service.
 	 */
-	public function __construct( $entity_service ) {
+	public function __construct($entity_service) {
 
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
+		$this->log_service = Wordlift_Log_Service::get_logger('Wordlift_Timeline_Service');
 
 		$this->entity_service = $entity_service;
 
@@ -81,10 +81,10 @@ 
 	public function ajax_timeline() {
 
 		// Get the ID of the post who requested the timeline.
-		$post_id = ( isset( $_REQUEST['post_id'] ) ? $_REQUEST['post_id'] : NULL );
+		$post_id = (isset($_REQUEST['post_id']) ? $_REQUEST['post_id'] : NULL);
 
 		// Get the events and transform them for the JSON response, then send them to the client.
-		wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
+		wp_send_json($this->to_json($this->get_events($post_id)));
 
 	}
 
@@ -99,33 +99,33 @@ 
 	 *
 	 * @return array An array of event posts.
 	 */
-	public function get_events( $post_id = NULL ) {
+	public function get_events($post_id = NULL) {
 
 		// Get the entity IDs either from the entities related to the specified post or from the last 50 published
 		// posts if no post has been specified.
-		$ids = ( is_numeric( $post_id )
-			? wl_core_get_related_entity_ids( $post_id )
-			: $this->entity_service->get_all_related_to_last_50_published_posts() );
+		$ids = (is_numeric($post_id)
+			? wl_core_get_related_entity_ids($post_id)
+			: $this->entity_service->get_all_related_to_last_50_published_posts());
 
 		// Add the post itself if it's an entity.
-		if ( is_numeric( $post_id ) && $this->entity_service->is_entity( $post_id ) ) {
+		if (is_numeric($post_id) && $this->entity_service->is_entity($post_id)) {
 			$ids[] = $post_id;
 		}
 
 		// If there's no entities, return an empty array right away.
-		if ( 0 === sizeof( $ids ) ) {
-			$this->log_service->trace( "No events found [ post id :: $post_id ]" );
+		if (0 === sizeof($ids)) {
+			$this->log_service->trace("No events found [ post id :: $post_id ]");
 
 			return array();
 		}
 
-		$this->log_service->trace( "Getting events [ entity ids :: " . join( ', ', $ids ) . " ]" );
+		$this->log_service->trace("Getting events [ entity ids :: ".join(', ', $ids)." ]");
 
-		return get_posts( array(
+		return get_posts(array(
 			'post__in'       => $ids,
 			'post_type'      => Wordlift_Entity_Service::TYPE_NAME,
 			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
+			'posts_per_page' => -1,
 			'meta_query'     => array(
 				'relation' => 'AND',
 				array(
@@ -144,7 +144,7 @@ 
 				'field'    => 'slug',
 				'terms'    => 'event'
 			)
-		) );
+		));
 	}
 
 	/**
@@ -158,23 +158,23 @@ 
 	 *
 	 * @return array|string An array of timeline events or an empty string if no posts are provided.
 	 */
-	public function to_json( $posts ) {
+	public function to_json($posts) {
 
 		// If there are no events, return empty JSON
-		if ( empty( $posts ) || is_null( $posts ) ) {
+		if (empty($posts) || is_null($posts)) {
 			return '';
 		}
 
 		// {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
-		$display_images_as = isset( $_REQUEST['display_images_as'] ) ? $_REQUEST['display_images_as'] : 'media';
+		$display_images_as = isset($_REQUEST['display_images_as']) ? $_REQUEST['display_images_as'] : 'media';
 
 		// The number of words for the excerpt (by default 55, as WordPress).
-		$this->excerpt_length = isset( $_REQUEST['excerpt_words'] ) && is_numeric( $_REQUEST['excerpt_words'] ) ? $_REQUEST['excerpt_words'] : 55;
-		add_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+		$this->excerpt_length = isset($_REQUEST['excerpt_words']) && is_numeric($_REQUEST['excerpt_words']) ? $_REQUEST['excerpt_words'] : 55;
+		add_filter('excerpt_length', array($this, 'excerpt_length'));
 
 		// Add a filter to remove the [...] after excerpts, since we're adding
 		// a link to the post itself.
-		add_filter( 'excerpt_more', array( $this, 'excerpt_more' ) );
+		add_filter('excerpt_more', array($this, 'excerpt_more'));
 
 		// Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
 		$start_at_slide = 0;
@@ -185,27 +185,27 @@ 
 		$timeline = array();
 
 		// Populate the arrays.
-		$timeline['events'] = array_map( function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as ) {
+		$timeline['events'] = array_map(function($item) use (&$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as) {
 
 			// Get the start and end dates.
-			$start_date = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, TRUE ) );
-			$end_date   = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, TRUE ) );
+			$start_date = strtotime(get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_DATE_START, TRUE));
+			$end_date   = strtotime(get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_DATE_END, TRUE));
 
 			// Set the starting slide.
-			$event_index ++;
-			if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
+			$event_index++;
+			if (0 === $start_at_slide && $now >= $start_date && $now <= $end_date) {
 				$start_at_slide = $event_index;
 			}
 
 			// Load thumbnail
-			if ( '' !== ( $thumbnail_id = get_post_thumbnail_id( $item->ID ) )
-			     && FALSE !== ( $attachment = wp_get_attachment_image_src( $thumbnail_id ) )
+			if ('' !== ($thumbnail_id = get_post_thumbnail_id($item->ID))
+			     && FALSE !== ($attachment = wp_get_attachment_image_src($thumbnail_id))
 			) {
 
 				// Set the thumbnail URL.
-				if ( 'background' === $display_images_as ) {
-					$date['background'] = array( 'url' => $attachment[0], );
-					$date['media']      = array( 'thumbnail' => $attachment[0], );
+				if ('background' === $display_images_as) {
+					$date['background'] = array('url' => $attachment[0],);
+					$date['media']      = array('thumbnail' => $attachment[0],);
 				} else {
 					$date['media'] = array(
 						'url'       => $attachment[0],
@@ -216,37 +216,37 @@ 
 			}
 
 			// Set the start/end dates by converting them to TimelineJS required format.
-			$date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
-			$date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
+			$date['start_date'] = Wordlift_Timeline_Service::date($start_date);
+			$date['end_date']   = Wordlift_Timeline_Service::date($end_date);
 
-			setup_postdata( $GLOBALS['post'] = &$item );
+			setup_postdata($GLOBALS['post'] = &$item);
 
 			$more_link_text = sprintf(
 				'<span aria-label="%1$s">%2$s</span>',
 				sprintf(
 				/* translators: %s: Name of current post */
-					__( 'Continue reading %s' ),
-					the_title_attribute( array( 'echo' => FALSE ) )
+					__('Continue reading %s'),
+					the_title_attribute(array('echo' => FALSE))
 				),
-				__( '(more&hellip;)' )
+				__('(more&hellip;)')
 			);
 
 			// Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
 			$date['text'] = array(
-				'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
+				'headline' => '<a href="'.get_permalink($item->ID).'">'.$item->post_title.'</a>',
 			);
 
 			// If we have an excerpt, set it.
-			if ( 0 < $this->excerpt_length ) {
-				$date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt( $item ), get_permalink(), $more_link_text );
+			if (0 < $this->excerpt_length) {
+				$date['text']['text'] = sprintf('%s <a href="%s">%s</a>', get_the_excerpt($item), get_permalink(), $more_link_text);
 			}
 
 			return $date;
 
-		}, $posts );
+		}, $posts);
 
 		// Finally remove the excerpt filter.
-		remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+		remove_filter('excerpt_length', array($this, 'excerpt_length'));
 
 		// The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
 		return array(
@@ -265,7 +265,7 @@ 
 	 *
 	 * @return string An empty string.
 	 */
-	public function excerpt_more( $excerpt_more ) {
+	public function excerpt_more($excerpt_more) {
 
 		return '';
 	}
@@ -280,7 +280,7 @@ 
 	 *
 	 * @return int The number of words for the preset.
 	 */
-	public function excerpt_length( $length ) {
+	public function excerpt_length($length) {
 
 		return $this->excerpt_length;
 	}
@@ -295,12 +295,12 @@ 
 	 *
 	 * @return array An array containing year, month and day values.
 	 */
-	public static function date( $value ) {
+	public static function date($value) {
 
 		return array(
-			'year'  => (int) date( 'Y', $value ),
-			'month' => (int) date( 'm', $value ),
-			'day'   => (int) date( 'd', $value ),
+			'year'  => (int) date('Y', $value),
+			'month' => (int) date('m', $value),
+			'day'   => (int) date('d', $value),
 
 		);
 	}

src/public/class-wordlift-shortcode.php

Indentation +45 added lines, -45 removed lines

@@ -8,50 +8,50 @@
  */
 abstract class Wordlift_Shortcode {
 
-	/**
-	 * The shortcode, set by extending classes.
-	 */
-	const SHORTCODE = NULL;
-
-	/**
-	 * Create a shortcode instance by registering the shortcode with the render
-	 * function.
-	 *
-	 * @since 3.5.4
-	 */
-	public function __construct() {
-
-		add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
-
-	}
-
-	/**
-	 * Render the shortcode.
-	 *
-	 * @since 3.5.4
-	 *
-	 * @param array $atts An array of shortcode attributes as set by the editor.
-	 *
-	 * @return string The output html code.
-	 */
-	public abstract function render( $atts );
-
-	/**
-	 * Enqueue scripts. Called by the shortcode implementations in their render
-	 * method.
-	 *
-	 * @since 3.5.4
-	 */
-	protected function enqueue_scripts() {
-
-		wp_enqueue_script( 'angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js' );
-		wp_enqueue_script( 'angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js', array( 'angularjs' ) );
-		wp_enqueue_script( 'wordlift-ui', dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js', array(
-			'jquery',
-			'angularjs',
-			'angularjs-touch'
-		) );
-
-	}
+    /**
+     * The shortcode, set by extending classes.
+     */
+    const SHORTCODE = NULL;
+
+    /**
+     * Create a shortcode instance by registering the shortcode with the render
+     * function.
+     *
+     * @since 3.5.4
+     */
+    public function __construct() {
+
+        add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
+
+    }
+
+    /**
+     * Render the shortcode.
+     *
+     * @since 3.5.4
+     *
+     * @param array $atts An array of shortcode attributes as set by the editor.
+     *
+     * @return string The output html code.
+     */
+    public abstract function render( $atts );
+
+    /**
+     * Enqueue scripts. Called by the shortcode implementations in their render
+     * method.
+     *
+     * @since 3.5.4
+     */
+    protected function enqueue_scripts() {
+
+        wp_enqueue_script( 'angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js' );
+        wp_enqueue_script( 'angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js', array( 'angularjs' ) );
+        wp_enqueue_script( 'wordlift-ui', dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js', array(
+            'jquery',
+            'angularjs',
+            'angularjs-touch'
+        ) );
+
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
 	 */
 	public function __construct() {
 
-		add_shortcode( static::SHORTCODE, array( $this, 'render' ) );
+		add_shortcode(static::SHORTCODE, array($this, 'render'));
 
 	}
 
@@ -34,7 +34,7 @@ 
 	 *
 	 * @return string The output html code.
 	 */
-	public abstract function render( $atts );
+	public abstract function render($atts);
 
 	/**
 	 * Enqueue scripts. Called by the shortcode implementations in their render
@@ -44,13 +44,13 @@ 
 	 */
 	protected function enqueue_scripts() {
 
-		wp_enqueue_script( 'angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js' );
-		wp_enqueue_script( 'angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js', array( 'angularjs' ) );
-		wp_enqueue_script( 'wordlift-ui', dirname( plugin_dir_url( __FILE__ ) ) . '/js/wordlift-ui' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '.min' : '' ) . '.js', array(
+		wp_enqueue_script('angularjs', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular.min.js');
+		wp_enqueue_script('angularjs-touch', 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.3.11/angular-touch.min.js', array('angularjs'));
+		wp_enqueue_script('wordlift-ui', dirname(plugin_dir_url(__FILE__)).'/js/wordlift-ui'.( ! defined('SCRIPT_DEBUG') || ! SCRIPT_DEBUG ? '.min' : '').'.js', array(
 			'jquery',
 			'angularjs',
 			'angularjs-touch'
-		) );
+		));
 
 	}
 

src/public/class-wordlift-timeline-shortcode.php

Indentation +193 added lines, -193 removed lines

@@ -7,198 +7,198 @@
  */
 class Wordlift_Timeline_Shortcode extends Wordlift_Shortcode {
 
-	const SHORTCODE = 'wl_timeline';
-
-	/**
-	 * The list of locales supported by TimelineJS (correspond to the list of
-	 * files in the locale subfolder).
-	 *
-	 * @since 3.7.0
-	 * @var array An array of two-letters language codes.
-	 */
-	private static $supported_locales = array(
-		'ur',
-		'uk',
-		'tr',
-		'tl',
-		'th',
-		'te',
-		'ta',
-		'sv',
-		'sr',
-		'sl',
-		'sk',
-		'si',
-		'ru',
-		'ro',
-		'rm',
-		'pt',
-		'pl',
-		'no',
-		'nl',
-		'ne',
-		'ms',
-		'lv',
-		'lt',
-		'lb',
-		'ko',
-		'ka',
-		'ja',
-		'iw',
-		'it',
-		'is',
-		'id',
-		'hy',
-		'hu',
-		'hr',
-		'hi',
-		'he',
-		'gl',
-		'ga',
-		'fy',
-		'fr',
-		'fo',
-		'fi',
-		'fa',
-		'eu',
-		'et',
-		'es',
-		'eo',
-		'en',
-		'el',
-		'de',
-		'da',
-		'cz',
-		'ca',
-		'bg',
-		'be',
-		'ar',
-		'af'
-	);
-
-	/**
-	 * The Log service.
-	 *
-	 * @since 3.1.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log_service The Log service.
-	 */
-	private $log_service;
-
-	/**
-	 * Create a Wordlift_Timeline_Shortcode instance.
-	 *
-	 * @since 3.1.0
-	 */
-	public function __construct() {
-		parent::__construct();
-
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Shortcode' );
-
-	}
-
-	/**
-	 * Renders the Timeline.
-	 *
-	 * @since 3.1.0
-	 *
-	 * @param array $atts An array of shortcode attributes.
-	 *
-	 * @return string The rendered HTML.
-	 */
-	public function render( $atts ) {
-
-		//extract attributes and set default values
-		$settings = shortcode_atts( array(
-			'debug'                            => defined( 'WP_DEBUG' ) && WP_DEBUG,
-			'height'                           => NULL,
-			'width'                            => NULL,
-			'is_embed'                         => FALSE,
-			'hash_bookmark'                    => FALSE,
-			'default_bg_color'                 => 'white',
-			'scale_factor'                     => 2,
-			'initial_zoom'                     => NULL,
-			'zoom_sequence'                    => '[0.5, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]',
-			'timenav_position'                 => 'bottom',
-			'optimal_tick_width'               => 100,
-			'base_class'                       => 'tl-timeline',
-			'timenav_height'                   => 150,
-			'timenav_height_percentage'        => NULL,
-			'timenav_mobile_height_percentage' => 40,
-			'timenav_height_min'               => 150,
-			'marker_height_min'                => 30,
-			'marker_width_min'                 => 100,
-			'marker_padding'                   => 5,
-			'start_at_slide'                   => 0,
-			'start_at_end'                     => FALSE,
-			'menubar_height'                   => 0,
-			'use_bc'                           => FALSE,
-			'duration'                         => 1000,
-			'ease'                             => 'TL.Ease.easeInOutQuint',
-			'slide_default_fade'               => '0%',
-			'language'                         => $this->get_locale(),
-			'ga_property_id'                   => NULL,
-			'track_events'                     => "['back_to_start','nav_next','nav_previous','zoom_in','zoom_out']",
-			'global'                           => FALSE,
-			// The following settings are unrelated to TimelineJS script.
-			'display_images_as'                => 'media',
-			'excerpt_words'                    => 55,
-		), $atts );
-
-		// Load the TimelineJS stylesheets and scripts.
-		wp_enqueue_style( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/css/timeline.css' );
-		wp_enqueue_script( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/js/timeline' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '-min' : '' ) . '.js' );
-
-		// Enqueue the scripts for the timeline.
-		$this->enqueue_scripts();
-
-		// Provide the script with options.
-		wp_localize_script( 'timelinejs', 'wl_timeline_params', array(
-			'ajax_url'          => admin_url( 'admin-ajax.php' ),
-			// TODO: this parameter is already provided by WP
-			'action'            => 'wl_timeline',
-			// These settings apply to our wl_timeline AJAX endpoint.
-			'display_images_as' => $settings['display_images_as'],
-			'excerpt_words'     => $settings['excerpt_words'],
-			// These settings apply to the timeline javascript client.
-			'settings'          => array_filter( $settings, function ( $value, $key = NULL ) {
-				// Do not set NULL values or settings which are not related to the client TimelineJS script.
-				return ( NULL != $key && NULL !== $value && 'display_images_as' !== $key && 'excerpt_words' !== $key );
-			} )
-		) );
-
-		// Get the current post id or set null if global is set to true.
-		$post_id = ( $settings['global'] ? NULL : get_the_ID() );
-
-		// Escaping atts.
-		$style        = sprintf( 'style="%s%s"', isset( $settings['width'] ) ? "width:{$settings['width']};" : '', isset( $settings['height'] ) ? "height:{$settings['height']};" : '' );
-		$data_post_id = ( isset( $post_id ) ? "data-post-id='$post_id'" : '' );
-
-		// Generate a unique ID for this timeline.
-		$element_id = uniqid( 'wl-timeline-' );
-
-		if ( WP_DEBUG ) {
-			$this->log_service->trace( "Creating a timeline widget [ element id :: $element_id ][ post id :: $post_id ]" );
-		}
-
-		// Building template.
-		return sprintf( '<div class="wl-timeline-container" %s><div class="wl-timeline" id="%s" %s></div></div>', $style, $element_id, $data_post_id );
-	}
-
-	/**
-	 * Return the locale for the TimelineJS according to WP's configured locale and
-	 * support TimelineJS locales. If WP's locale is not supported, english is used.
-	 *
-	 * @since 3.7.0
-	 * @return string The locale (2 letters code).
-	 */
-	private function get_locale() {
-
-		// Get the first 2 letters.
-		$locale = substr( get_locale(), 0, 2 );
-
-		// Check that the specified locale is supported otherwise use English.
-		return in_array( $locale, self::$supported_locales ) ? $locale : 'en';
-	}
+    const SHORTCODE = 'wl_timeline';
+
+    /**
+     * The list of locales supported by TimelineJS (correspond to the list of
+     * files in the locale subfolder).
+     *
+     * @since 3.7.0
+     * @var array An array of two-letters language codes.
+     */
+    private static $supported_locales = array(
+        'ur',
+        'uk',
+        'tr',
+        'tl',
+        'th',
+        'te',
+        'ta',
+        'sv',
+        'sr',
+        'sl',
+        'sk',
+        'si',
+        'ru',
+        'ro',
+        'rm',
+        'pt',
+        'pl',
+        'no',
+        'nl',
+        'ne',
+        'ms',
+        'lv',
+        'lt',
+        'lb',
+        'ko',
+        'ka',
+        'ja',
+        'iw',
+        'it',
+        'is',
+        'id',
+        'hy',
+        'hu',
+        'hr',
+        'hi',
+        'he',
+        'gl',
+        'ga',
+        'fy',
+        'fr',
+        'fo',
+        'fi',
+        'fa',
+        'eu',
+        'et',
+        'es',
+        'eo',
+        'en',
+        'el',
+        'de',
+        'da',
+        'cz',
+        'ca',
+        'bg',
+        'be',
+        'ar',
+        'af'
+    );
+
+    /**
+     * The Log service.
+     *
+     * @since 3.1.0
+     * @access private
+     * @var \Wordlift_Log_Service $log_service The Log service.
+     */
+    private $log_service;
+
+    /**
+     * Create a Wordlift_Timeline_Shortcode instance.
+     *
+     * @since 3.1.0
+     */
+    public function __construct() {
+        parent::__construct();
+
+        $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Shortcode' );
+
+    }
+
+    /**
+     * Renders the Timeline.
+     *
+     * @since 3.1.0
+     *
+     * @param array $atts An array of shortcode attributes.
+     *
+     * @return string The rendered HTML.
+     */
+    public function render( $atts ) {
+
+        //extract attributes and set default values
+        $settings = shortcode_atts( array(
+            'debug'                            => defined( 'WP_DEBUG' ) && WP_DEBUG,
+            'height'                           => NULL,
+            'width'                            => NULL,
+            'is_embed'                         => FALSE,
+            'hash_bookmark'                    => FALSE,
+            'default_bg_color'                 => 'white',
+            'scale_factor'                     => 2,
+            'initial_zoom'                     => NULL,
+            'zoom_sequence'                    => '[0.5, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]',
+            'timenav_position'                 => 'bottom',
+            'optimal_tick_width'               => 100,
+            'base_class'                       => 'tl-timeline',
+            'timenav_height'                   => 150,
+            'timenav_height_percentage'        => NULL,
+            'timenav_mobile_height_percentage' => 40,
+            'timenav_height_min'               => 150,
+            'marker_height_min'                => 30,
+            'marker_width_min'                 => 100,
+            'marker_padding'                   => 5,
+            'start_at_slide'                   => 0,
+            'start_at_end'                     => FALSE,
+            'menubar_height'                   => 0,
+            'use_bc'                           => FALSE,
+            'duration'                         => 1000,
+            'ease'                             => 'TL.Ease.easeInOutQuint',
+            'slide_default_fade'               => '0%',
+            'language'                         => $this->get_locale(),
+            'ga_property_id'                   => NULL,
+            'track_events'                     => "['back_to_start','nav_next','nav_previous','zoom_in','zoom_out']",
+            'global'                           => FALSE,
+            // The following settings are unrelated to TimelineJS script.
+            'display_images_as'                => 'media',
+            'excerpt_words'                    => 55,
+        ), $atts );
+
+        // Load the TimelineJS stylesheets and scripts.
+        wp_enqueue_style( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/css/timeline.css' );
+        wp_enqueue_script( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/js/timeline' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '-min' : '' ) . '.js' );
+
+        // Enqueue the scripts for the timeline.
+        $this->enqueue_scripts();
+
+        // Provide the script with options.
+        wp_localize_script( 'timelinejs', 'wl_timeline_params', array(
+            'ajax_url'          => admin_url( 'admin-ajax.php' ),
+            // TODO: this parameter is already provided by WP
+            'action'            => 'wl_timeline',
+            // These settings apply to our wl_timeline AJAX endpoint.
+            'display_images_as' => $settings['display_images_as'],
+            'excerpt_words'     => $settings['excerpt_words'],
+            // These settings apply to the timeline javascript client.
+            'settings'          => array_filter( $settings, function ( $value, $key = NULL ) {
+                // Do not set NULL values or settings which are not related to the client TimelineJS script.
+                return ( NULL != $key && NULL !== $value && 'display_images_as' !== $key && 'excerpt_words' !== $key );
+            } )
+        ) );
+
+        // Get the current post id or set null if global is set to true.
+        $post_id = ( $settings['global'] ? NULL : get_the_ID() );
+
+        // Escaping atts.
+        $style        = sprintf( 'style="%s%s"', isset( $settings['width'] ) ? "width:{$settings['width']};" : '', isset( $settings['height'] ) ? "height:{$settings['height']};" : '' );
+        $data_post_id = ( isset( $post_id ) ? "data-post-id='$post_id'" : '' );
+
+        // Generate a unique ID for this timeline.
+        $element_id = uniqid( 'wl-timeline-' );
+
+        if ( WP_DEBUG ) {
+            $this->log_service->trace( "Creating a timeline widget [ element id :: $element_id ][ post id :: $post_id ]" );
+        }
+
+        // Building template.
+        return sprintf( '<div class="wl-timeline-container" %s><div class="wl-timeline" id="%s" %s></div></div>', $style, $element_id, $data_post_id );
+    }
+
+    /**
+     * Return the locale for the TimelineJS according to WP's configured locale and
+     * support TimelineJS locales. If WP's locale is not supported, english is used.
+     *
+     * @since 3.7.0
+     * @return string The locale (2 letters code).
+     */
+    private function get_locale() {
+
+        // Get the first 2 letters.
+        $locale = substr( get_locale(), 0, 2 );
+
+        // Check that the specified locale is supported otherwise use English.
+        return in_array( $locale, self::$supported_locales ) ? $locale : 'en';
+    }
 
 }

Spacing +21 added lines, -21 removed lines

@@ -93,7 +93,7 @@ 
 	public function __construct() {
 		parent::__construct();
 
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Shortcode' );
+		$this->log_service = Wordlift_Log_Service::get_logger('Wordlift_Timeline_Shortcode');
 
 	}
 
@@ -106,11 +106,11 @@ 
 	 *
 	 * @return string The rendered HTML.
 	 */
-	public function render( $atts ) {
+	public function render($atts) {
 
 		//extract attributes and set default values
-		$settings = shortcode_atts( array(
-			'debug'                            => defined( 'WP_DEBUG' ) && WP_DEBUG,
+		$settings = shortcode_atts(array(
+			'debug'                            => defined('WP_DEBUG') && WP_DEBUG,
 			'height'                           => NULL,
 			'width'                            => NULL,
 			'is_embed'                         => FALSE,
@@ -143,46 +143,46 @@ 
 			// The following settings are unrelated to TimelineJS script.
 			'display_images_as'                => 'media',
 			'excerpt_words'                    => 55,
-		), $atts );
+		), $atts);
 
 		// Load the TimelineJS stylesheets and scripts.
-		wp_enqueue_style( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/css/timeline.css' );
-		wp_enqueue_script( 'timelinejs', dirname( plugin_dir_url( __FILE__ ) ) . '/timelinejs/js/timeline' . ( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ? '-min' : '' ) . '.js' );
+		wp_enqueue_style('timelinejs', dirname(plugin_dir_url(__FILE__)).'/timelinejs/css/timeline.css');
+		wp_enqueue_script('timelinejs', dirname(plugin_dir_url(__FILE__)).'/timelinejs/js/timeline'.( ! defined('SCRIPT_DEBUG') || ! SCRIPT_DEBUG ? '-min' : '').'.js');
 
 		// Enqueue the scripts for the timeline.
 		$this->enqueue_scripts();
 
 		// Provide the script with options.
-		wp_localize_script( 'timelinejs', 'wl_timeline_params', array(
-			'ajax_url'          => admin_url( 'admin-ajax.php' ),
+		wp_localize_script('timelinejs', 'wl_timeline_params', array(
+			'ajax_url'          => admin_url('admin-ajax.php'),
 			// TODO: this parameter is already provided by WP
 			'action'            => 'wl_timeline',
 			// These settings apply to our wl_timeline AJAX endpoint.
 			'display_images_as' => $settings['display_images_as'],
 			'excerpt_words'     => $settings['excerpt_words'],
 			// These settings apply to the timeline javascript client.
-			'settings'          => array_filter( $settings, function ( $value, $key = NULL ) {
+			'settings'          => array_filter($settings, function($value, $key = NULL) {
 				// Do not set NULL values or settings which are not related to the client TimelineJS script.
-				return ( NULL != $key && NULL !== $value && 'display_images_as' !== $key && 'excerpt_words' !== $key );
+				return (NULL != $key && NULL !== $value && 'display_images_as' !== $key && 'excerpt_words' !== $key);
 			} )
-		) );
+		));
 
 		// Get the current post id or set null if global is set to true.
-		$post_id = ( $settings['global'] ? NULL : get_the_ID() );
+		$post_id = ($settings['global'] ? NULL : get_the_ID());
 
 		// Escaping atts.
-		$style        = sprintf( 'style="%s%s"', isset( $settings['width'] ) ? "width:{$settings['width']};" : '', isset( $settings['height'] ) ? "height:{$settings['height']};" : '' );
-		$data_post_id = ( isset( $post_id ) ? "data-post-id='$post_id'" : '' );
+		$style        = sprintf('style="%s%s"', isset($settings['width']) ? "width:{$settings['width']};" : '', isset($settings['height']) ? "height:{$settings['height']};" : '');
+		$data_post_id = (isset($post_id) ? "data-post-id='$post_id'" : '');
 
 		// Generate a unique ID for this timeline.
-		$element_id = uniqid( 'wl-timeline-' );
+		$element_id = uniqid('wl-timeline-');
 
-		if ( WP_DEBUG ) {
-			$this->log_service->trace( "Creating a timeline widget [ element id :: $element_id ][ post id :: $post_id ]" );
+		if (WP_DEBUG) {
+			$this->log_service->trace("Creating a timeline widget [ element id :: $element_id ][ post id :: $post_id ]");
 		}
 
 		// Building template.
-		return sprintf( '<div class="wl-timeline-container" %s><div class="wl-timeline" id="%s" %s></div></div>', $style, $element_id, $data_post_id );
+		return sprintf('<div class="wl-timeline-container" %s><div class="wl-timeline" id="%s" %s></div></div>', $style, $element_id, $data_post_id);
 	}
 
 	/**
@@ -195,10 +195,10 @@ 
 	private function get_locale() {
 
 		// Get the first 2 letters.
-		$locale = substr( get_locale(), 0, 2 );
+		$locale = substr(get_locale(), 0, 2);
 
 		// Check that the specified locale is supported otherwise use English.
-		return in_array( $locale, self::$supported_locales ) ? $locale : 'en';
+		return in_array($locale, self::$supported_locales) ? $locale : 'en';
 	}
 
 }