insideout10 / wordlift-plugin

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

Indentation +786 added lines, -786 removed lines

@@ -15,791 +15,791 @@
  */
 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 'telephone' field name.
-	 *
-	 * @since 3.8.0
-	 */
-	const FIELD_TELEPHONE = 'wl_schema_telephone';
-
-	/**
-	 * 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 ) {
-
-		// 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;
-	}
-
-	/**
-	 * 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,
-					),
-					// We need a custom metabox.
-					'input_field' => 'sameas',
-				),
-				// 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*
-			'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,
-					),
-				),
-			),
-			'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,
-					),
-				),
-			),
-			'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' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_PO_BOX      => array(
-					'predicate'   => 'http://schema.org/postOfficeBoxNumber',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_POSTAL_CODE => array(
-					'predicate'   => 'http://schema.org/postalCode',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_LOCALITY    => array(
-					'predicate'   => 'http://schema.org/addressLocality',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_REGION      => array(
-					'predicate'   => 'http://schema.org/addressRegion',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_COUNTRY     => array(
-					'predicate'   => 'http://schema.org/addressCountry',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_EMAIL               => array(
-					'predicate'   => 'http://schema.org/email',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-				),
-				self::FIELD_TELEPHONE           => array(
-					'predicate'   => 'http://schema.org/telephone',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-				),
-			),
-			'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,
-					),
-				),
-			),
-			'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' => '',
-					// To build custom metabox.
-					'input_field' => 'coordinates',
-				),
-				self::FIELD_GEO_LONGITUDE       => array(
-					'predicate'   => 'http://schema.org/longitude',
-					'type'        => self::DATA_TYPE_DOUBLE,
-					'export_type' => 'xsd:double',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'coordinates',
-				),
-				self::FIELD_ADDRESS             => array(
-					'predicate'   => 'http://schema.org/streetAddress',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_PO_BOX      => array(
-					'predicate'   => 'http://schema.org/postOfficeBoxNumber',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_POSTAL_CODE => array(
-					'predicate'   => 'http://schema.org/postalCode',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_LOCALITY    => array(
-					'predicate'   => 'http://schema.org/addressLocality',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_REGION      => array(
-					'predicate'   => 'http://schema.org/addressRegion',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-				self::FIELD_ADDRESS_COUNTRY     => array(
-					'predicate'   => 'http://schema.org/addressCountry',
-					'type'        => self::DATA_TYPE_STRING,
-					'export_type' => 'xsd:string',
-					'constraints' => '',
-					// To build custom metabox.
-					'input_field' => 'address',
-				),
-			),
-			'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(),
-			'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;
-	}
+    /**
+     * 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 'telephone' field name.
+     *
+     * @since 3.8.0
+     */
+    const FIELD_TELEPHONE = 'wl_schema_telephone';
+
+    /**
+     * 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 ) {
+
+        // 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;
+    }
+
+    /**
+     * 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,
+                    ),
+                    // We need a custom metabox.
+                    'input_field' => 'sameas',
+                ),
+                // 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*
+            '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,
+                    ),
+                ),
+            ),
+            '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,
+                    ),
+                ),
+            ),
+            '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' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_PO_BOX      => array(
+                    'predicate'   => 'http://schema.org/postOfficeBoxNumber',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_POSTAL_CODE => array(
+                    'predicate'   => 'http://schema.org/postalCode',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_LOCALITY    => array(
+                    'predicate'   => 'http://schema.org/addressLocality',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_REGION      => array(
+                    'predicate'   => 'http://schema.org/addressRegion',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_COUNTRY     => array(
+                    'predicate'   => 'http://schema.org/addressCountry',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_EMAIL               => array(
+                    'predicate'   => 'http://schema.org/email',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                ),
+                self::FIELD_TELEPHONE           => array(
+                    'predicate'   => 'http://schema.org/telephone',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                ),
+            ),
+            '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,
+                    ),
+                ),
+            ),
+            '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' => '',
+                    // To build custom metabox.
+                    'input_field' => 'coordinates',
+                ),
+                self::FIELD_GEO_LONGITUDE       => array(
+                    'predicate'   => 'http://schema.org/longitude',
+                    'type'        => self::DATA_TYPE_DOUBLE,
+                    'export_type' => 'xsd:double',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'coordinates',
+                ),
+                self::FIELD_ADDRESS             => array(
+                    'predicate'   => 'http://schema.org/streetAddress',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_PO_BOX      => array(
+                    'predicate'   => 'http://schema.org/postOfficeBoxNumber',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_POSTAL_CODE => array(
+                    'predicate'   => 'http://schema.org/postalCode',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_LOCALITY    => array(
+                    'predicate'   => 'http://schema.org/addressLocality',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_REGION      => array(
+                    'predicate'   => 'http://schema.org/addressRegion',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+                self::FIELD_ADDRESS_COUNTRY     => array(
+                    'predicate'   => 'http://schema.org/addressCountry',
+                    'type'        => self::DATA_TYPE_STRING,
+                    'export_type' => 'xsd:string',
+                    'constraints' => '',
+                    // To build custom metabox.
+                    'input_field' => 'address',
+                ),
+            ),
+            '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(),
+            '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/widgets/wordlift_widget_chord.php

Indentation +46 added lines, -46 removed lines

@@ -2,56 +2,56 @@
 
 class Wordlift_Chord_Widget extends WP_Widget {
 
-	/**
-	 * Sets up the widgets name etc
-	 */
-	public function __construct() {
-		// widget actual processes
-		parent::__construct(
-			'wl_chord_widget', // Base ID
-			__( 'Chord Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ), ) // Args
-		);
-	}
-
-	/**
-	 * Outputs the content of the widget
-	 *
-	 * @param array $args
-	 * @param array $instance
-	 */
-	public function widget( $args, $instance ) {
-		// outputs the content of the widget	
-		echo do_shortcode( '[wl_chord global=true]' );
-	}
-
-	/**
-	 * Outputs the options form on admin
-	 *
-	 * @param array $instance The widget options
-	 *
-	 * @return string|void
-	 */
-	public function form( $instance ) {
-		// outputs the options form on admin
-	}
-
-	/**
-	 * Processing widget options on save
-	 *
-	 * @param array $new_instance The new options
-	 * @param array $old_instance The previous options
-	 *
-	 * @return array|void
-	 */
-	public function update( $new_instance, $old_instance ) {
-		// processes widget options to be saved
-	}
+    /**
+     * Sets up the widgets name etc
+     */
+    public function __construct() {
+        // widget actual processes
+        parent::__construct(
+            'wl_chord_widget', // Base ID
+            __( 'Chord Widget', 'wordlift' ), // Name
+            array( 'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ), ) // Args
+        );
+    }
+
+    /**
+     * Outputs the content of the widget
+     *
+     * @param array $args
+     * @param array $instance
+     */
+    public function widget( $args, $instance ) {
+        // outputs the content of the widget	
+        echo do_shortcode( '[wl_chord global=true]' );
+    }
+
+    /**
+     * Outputs the options form on admin
+     *
+     * @param array $instance The widget options
+     *
+     * @return string|void
+     */
+    public function form( $instance ) {
+        // outputs the options form on admin
+    }
+
+    /**
+     * Processing widget options on save
+     *
+     * @param array $new_instance The new options
+     * @param array $old_instance The previous options
+     *
+     * @return array|void
+     */
+    public function update( $new_instance, $old_instance ) {
+        // processes widget options to be saved
+    }
 }
 
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+    register_widget( 'WordLift_Chord_Widget' );
 }
 
 add_action( 'widgets_init', 'wl_register_chord_widget' );

Spacing +9 added lines, -9 removed lines

@@ -9,8 +9,8 @@ 
 		// widget actual processes
 		parent::__construct(
 			'wl_chord_widget', // Base ID
-			__( 'Chord Widget', 'wordlift' ), // Name
-			array( 'description' => __( 'The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift' ), ) // Args
+			__('Chord Widget', 'wordlift'), // Name
+			array('description' => __('The Chord Widget depicts the main topics of your blog in concise graph.', 'wordlift'),) // Args
 		);
 	}
 
@@ -20,9 +20,9 @@ 
 	 * @param array $args
 	 * @param array $instance
 	 */
-	public function widget( $args, $instance ) {
+	public function widget($args, $instance) {
 		// outputs the content of the widget	
-		echo do_shortcode( '[wl_chord global=true]' );
+		echo do_shortcode('[wl_chord global=true]');
 	}
 
 	/**
@@ -32,7 +32,7 @@ 
 	 *
 	 * @return string|void
 	 */
-	public function form( $instance ) {
+	public function form($instance) {
 		// outputs the options form on admin
 	}
 
@@ -44,15 +44,15 @@ 
 	 *
 	 * @return array|void
 	 */
-	public function update( $new_instance, $old_instance ) {
+	public function update($new_instance, $old_instance) {
 		// processes widget options to be saved
 	}
 }
 
 function wl_register_chord_widget() {
 
-	register_widget( 'WordLift_Chord_Widget' );
+	register_widget('WordLift_Chord_Widget');
 }
 
-add_action( 'widgets_init', 'wl_register_chord_widget' );
-add_filter( 'widget_text', 'do_shortcode' );
+add_action('widgets_init', 'wl_register_chord_widget');
+add_filter('widget_text', 'do_shortcode');

src/shortcodes/wordlift_shortcode_chord.php

Indentation +124 added lines, -124 removed lines

@@ -8,33 +8,33 @@ 
  * @return mixed
  */
 function wl_shortcode_chord_most_referenced_entity_id() {
-	// Get the last 20 posts by post date.
-	// For each post get the entities they reference.
-	$post_ids = get_posts( array(
-		'numberposts' => 20,
-		'post_type'   => 'post',
-		'fields'      => 'ids', //only get post IDs
-		'post_status' => 'published',
-		'orderby'     => 'post_date',
-		'order'       => 'DESC',
-	) );
-
-	if ( empty( $post_ids ) ) {
-		return null;
-	}
-
-	$entities = array();
-	foreach ( $post_ids as $id ) {
-		$entities = array_merge( $entities, wl_core_get_related_entity_ids( $id ) );
-	}
-
-	$famous_entities = array_count_values( $entities );
-	arsort( $famous_entities );
-	if ( sizeof( $famous_entities ) >= 1 ) {
-		return key( $famous_entities );
-	} else {
-		return $post_ids[0];
-	}
+    // Get the last 20 posts by post date.
+    // For each post get the entities they reference.
+    $post_ids = get_posts( array(
+        'numberposts' => 20,
+        'post_type'   => 'post',
+        'fields'      => 'ids', //only get post IDs
+        'post_status' => 'published',
+        'orderby'     => 'post_date',
+        'order'       => 'DESC',
+    ) );
+
+    if ( empty( $post_ids ) ) {
+        return null;
+    }
+
+    $entities = array();
+    foreach ( $post_ids as $id ) {
+        $entities = array_merge( $entities, wl_core_get_related_entity_ids( $id ) );
+    }
+
+    $famous_entities = array_count_values( $entities );
+    arsort( $famous_entities );
+    if ( sizeof( $famous_entities ) >= 1 ) {
+        return key( $famous_entities );
+    } else {
+        return $post_ids[0];
+    }
 
 }
 
@@ -52,60 +52,60 @@ 
  */
 function wl_shortcode_chord_get_relations( $entity_id, $depth = 2, $related = null, $max_size = 9 ) {
 
-	if ( ! is_null( $related ) ) {
-		if ( 0 === $depth ) {
-			return $related;
-		}
-	}
+    if ( ! is_null( $related ) ) {
+        if ( 0 === $depth ) {
+            return $related;
+        }
+    }
 
-	wl_write_log( "wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: " . ( is_null( $related ) ? 'yes' : 'no' ) . " ]" );
+    wl_write_log( "wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: " . ( is_null( $related ) ? 'yes' : 'no' ) . " ]" );
 
-	// Create a related array which will hold entities and relations.
-	if ( is_null( $related ) ) {
-		$related = array(
-			'entities'  => array( $entity_id ),
-			'relations' => array(),
-		);
-	}
+    // Create a related array which will hold entities and relations.
+    if ( is_null( $related ) ) {
+        $related = array(
+            'entities'  => array( $entity_id ),
+            'relations' => array(),
+        );
+    }
 
-	// Get related entities
-	$related_entity_ids = wl_core_get_related_entity_ids( $entity_id, array(
-		'status' => 'publish',
-	) );
+    // Get related entities
+    $related_entity_ids = wl_core_get_related_entity_ids( $entity_id, array(
+        'status' => 'publish',
+    ) );
 
-	// If the current node is an entity, add related posts too
-	$related_post_ids = ( Wordlift_Entity_Service::get_instance()
-	                                             ->is_entity( $entity_id ) ) ?
-		wl_core_get_related_post_ids( $entity_id, array(
-			'status' => 'publish',
-		) ) :
-		array();
+    // If the current node is an entity, add related posts too
+    $related_post_ids = ( Wordlift_Entity_Service::get_instance()
+                                                    ->is_entity( $entity_id ) ) ?
+        wl_core_get_related_post_ids( $entity_id, array(
+            'status' => 'publish',
+        ) ) :
+        array();
 
-	// Merge results and remove duplicated entries
-	$related_ids = array_unique( array_merge( $related_post_ids, $related_entity_ids ) );
+    // Merge results and remove duplicated entries
+    $related_ids = array_unique( array_merge( $related_post_ids, $related_entity_ids ) );
 
-	// TODO: List of entities ($rel) should be ordered by interest factors.
-	shuffle( $related_ids );
+    // TODO: List of entities ($rel) should be ordered by interest factors.
+    shuffle( $related_ids );
 
-	// Now we have all the related IDs.
-	foreach ( $related_ids as $related_id ) {
+    // Now we have all the related IDs.
+    foreach ( $related_ids as $related_id ) {
 
-		if ( count( $related['entities'] ) >= $max_size ) {
-			return $related;
-		}
+        if ( count( $related['entities'] ) >= $max_size ) {
+            return $related;
+        }
 
-		$related['relations'][] = array( $entity_id, $related_id );
+        $related['relations'][] = array( $entity_id, $related_id );
 
-		if ( ! in_array( $related_id, $related['entities'] ) ) {
-			// Found new related entity!
-			$related['entities'][] = $related_id;
+        if ( ! in_array( $related_id, $related['entities'] ) ) {
+            // Found new related entity!
+            $related['entities'][] = $related_id;
 
-			$related = wl_shortcode_chord_get_relations( $related_id, ( $depth - 1 ), $related, $max_size );
-		}
-	}
+            $related = wl_shortcode_chord_get_relations( $related_id, ( $depth - 1 ), $related, $max_size );
+        }
+    }
 
-	// End condition 2: no more entities to search for.
-	return $related;
+    // End condition 2: no more entities to search for.
+    return $related;
 }
 
 /**
@@ -119,56 +119,56 @@ 
  */
 function wl_shortcode_chord_get_graph( $data ) {
 
-	// Refactor the entities array in order to provide entities relevant data (uri, url, label, type, css_class).
-	array_walk( $data['entities'], function ( &$item ) {
-		$post = get_post( $item );
-
-		// Skip non-existing posts.
-		if ( is_null( $post ) ) {
-			wl_write_log( "wl_shortcode_chord_get_graph : post not found [ post id :: $item ]" );
-
-			return $item;
-		}
-
-		// Get the entity taxonomy bound to this post (if there's no taxonomy, no stylesheet will be set).
-		$term = wl_entity_type_taxonomy_get_type( $item );
-
-		wl_write_log( "wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: " . var_export( $term, true ) . " ]" );
-
-		// TODO: get all images
-		$thumbnail    = null;
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id ) {
-			$attachment = wp_get_attachment_image_src( $thumbnail_id );
-			if ( false !== $attachment ) {
-				$thumbnail = esc_attr( $attachment[0] );
-			}
-		}
-
-		$entity = array(
-			'uri'        => wl_get_entity_uri( $item ),
-			'url'        => get_permalink( $item ),
-			'label'      => $post->post_title,
-			'type'       => $post->post_type,
-			'thumbnails' => array( $thumbnail ),
-			'css_class'  => ( isset( $term['css_class'] ) ? $term['css_class'] : '' ),
-		);
-
-		$item = $entity;
-	} );
-
-	// Refactor the relations.
-	array_walk( $data['relations'], function ( &$item ) {
-		$relation = array(
-			's' => wl_get_entity_uri( $item[0] ),
-			'o' => wl_get_entity_uri( $item[1] ),
-		);
-
-		$item = $relation;
-	} );
-
-	// Return the JSON representation.
-	return $data;
+    // Refactor the entities array in order to provide entities relevant data (uri, url, label, type, css_class).
+    array_walk( $data['entities'], function ( &$item ) {
+        $post = get_post( $item );
+
+        // Skip non-existing posts.
+        if ( is_null( $post ) ) {
+            wl_write_log( "wl_shortcode_chord_get_graph : post not found [ post id :: $item ]" );
+
+            return $item;
+        }
+
+        // Get the entity taxonomy bound to this post (if there's no taxonomy, no stylesheet will be set).
+        $term = wl_entity_type_taxonomy_get_type( $item );
+
+        wl_write_log( "wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: " . var_export( $term, true ) . " ]" );
+
+        // TODO: get all images
+        $thumbnail    = null;
+        $thumbnail_id = get_post_thumbnail_id( $post->ID );
+        if ( '' !== $thumbnail_id ) {
+            $attachment = wp_get_attachment_image_src( $thumbnail_id );
+            if ( false !== $attachment ) {
+                $thumbnail = esc_attr( $attachment[0] );
+            }
+        }
+
+        $entity = array(
+            'uri'        => wl_get_entity_uri( $item ),
+            'url'        => get_permalink( $item ),
+            'label'      => $post->post_title,
+            'type'       => $post->post_type,
+            'thumbnails' => array( $thumbnail ),
+            'css_class'  => ( isset( $term['css_class'] ) ? $term['css_class'] : '' ),
+        );
+
+        $item = $entity;
+    } );
+
+    // Refactor the relations.
+    array_walk( $data['relations'], function ( &$item ) {
+        $relation = array(
+            's' => wl_get_entity_uri( $item[0] ),
+            'o' => wl_get_entity_uri( $item[1] ),
+        );
+
+        $item = $relation;
+    } );
+
+    // Return the JSON representation.
+    return $data;
 }
 
 /**
@@ -179,13 +179,13 @@ 
  */
 function wl_shortcode_chord_ajax() {
 
-	$post_id = $_REQUEST['post_id'];
-	$depth   = $_REQUEST['depth'];
+    $post_id = $_REQUEST['post_id'];
+    $depth   = $_REQUEST['depth'];
 
-	$relations = wl_shortcode_chord_get_relations( $post_id, $depth );
-	$graph     = wl_shortcode_chord_get_graph( $relations );
+    $relations = wl_shortcode_chord_get_relations( $post_id, $depth );
+    $graph     = wl_shortcode_chord_get_graph( $relations );
 
-	wl_core_send_json( $graph );
+    wl_core_send_json( $graph );
 }
 
 add_action( 'wp_ajax_wl_chord', 'wl_shortcode_chord_ajax' );

Spacing +52 added lines, -53 removed lines

@@ -10,28 +10,28 @@ 
 function wl_shortcode_chord_most_referenced_entity_id() {
 	// Get the last 20 posts by post date.
 	// For each post get the entities they reference.
-	$post_ids = get_posts( array(
+	$post_ids = get_posts(array(
 		'numberposts' => 20,
 		'post_type'   => 'post',
 		'fields'      => 'ids', //only get post IDs
 		'post_status' => 'published',
 		'orderby'     => 'post_date',
 		'order'       => 'DESC',
-	) );
+	));
 
-	if ( empty( $post_ids ) ) {
+	if (empty($post_ids)) {
 		return null;
 	}
 
 	$entities = array();
-	foreach ( $post_ids as $id ) {
-		$entities = array_merge( $entities, wl_core_get_related_entity_ids( $id ) );
+	foreach ($post_ids as $id) {
+		$entities = array_merge($entities, wl_core_get_related_entity_ids($id));
 	}
 
-	$famous_entities = array_count_values( $entities );
-	arsort( $famous_entities );
-	if ( sizeof( $famous_entities ) >= 1 ) {
-		return key( $famous_entities );
+	$famous_entities = array_count_values($entities);
+	arsort($famous_entities);
+	if (sizeof($famous_entities) >= 1) {
+		return key($famous_entities);
 	} else {
 		return $post_ids[0];
 	}
@@ -50,57 +50,56 @@ 
  *
  * @return array
  */
-function wl_shortcode_chord_get_relations( $entity_id, $depth = 2, $related = null, $max_size = 9 ) {
+function wl_shortcode_chord_get_relations($entity_id, $depth = 2, $related = null, $max_size = 9) {
 
-	if ( ! is_null( $related ) ) {
-		if ( 0 === $depth ) {
+	if ( ! is_null($related)) {
+		if (0 === $depth) {
 			return $related;
 		}
 	}
 
-	wl_write_log( "wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: " . ( is_null( $related ) ? 'yes' : 'no' ) . " ]" );
+	wl_write_log("wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: ".(is_null($related) ? 'yes' : 'no')." ]");
 
 	// Create a related array which will hold entities and relations.
-	if ( is_null( $related ) ) {
+	if (is_null($related)) {
 		$related = array(
-			'entities'  => array( $entity_id ),
+			'entities'  => array($entity_id),
 			'relations' => array(),
 		);
 	}
 
 	// Get related entities
-	$related_entity_ids = wl_core_get_related_entity_ids( $entity_id, array(
+	$related_entity_ids = wl_core_get_related_entity_ids($entity_id, array(
 		'status' => 'publish',
-	) );
+	));
 
 	// If the current node is an entity, add related posts too
-	$related_post_ids = ( Wordlift_Entity_Service::get_instance()
-	                                             ->is_entity( $entity_id ) ) ?
-		wl_core_get_related_post_ids( $entity_id, array(
+	$related_post_ids = (Wordlift_Entity_Service::get_instance()
+	                                             ->is_entity($entity_id)) ?
+		wl_core_get_related_post_ids($entity_id, array(
 			'status' => 'publish',
-		) ) :
-		array();
+		)) : array();
 
 	// Merge results and remove duplicated entries
-	$related_ids = array_unique( array_merge( $related_post_ids, $related_entity_ids ) );
+	$related_ids = array_unique(array_merge($related_post_ids, $related_entity_ids));
 
 	// TODO: List of entities ($rel) should be ordered by interest factors.
-	shuffle( $related_ids );
+	shuffle($related_ids);
 
 	// Now we have all the related IDs.
-	foreach ( $related_ids as $related_id ) {
+	foreach ($related_ids as $related_id) {
 
-		if ( count( $related['entities'] ) >= $max_size ) {
+		if (count($related['entities']) >= $max_size) {
 			return $related;
 		}
 
-		$related['relations'][] = array( $entity_id, $related_id );
+		$related['relations'][] = array($entity_id, $related_id);
 
-		if ( ! in_array( $related_id, $related['entities'] ) ) {
+		if ( ! in_array($related_id, $related['entities'])) {
 			// Found new related entity!
 			$related['entities'][] = $related_id;
 
-			$related = wl_shortcode_chord_get_relations( $related_id, ( $depth - 1 ), $related, $max_size );
+			$related = wl_shortcode_chord_get_relations($related_id, ($depth - 1), $related, $max_size);
 		}
 	}
 
@@ -117,51 +116,51 @@ 
  *
  * @return mixed|string|void
  */
-function wl_shortcode_chord_get_graph( $data ) {
+function wl_shortcode_chord_get_graph($data) {
 
 	// Refactor the entities array in order to provide entities relevant data (uri, url, label, type, css_class).
-	array_walk( $data['entities'], function ( &$item ) {
-		$post = get_post( $item );
+	array_walk($data['entities'], function(&$item) {
+		$post = get_post($item);
 
 		// Skip non-existing posts.
-		if ( is_null( $post ) ) {
-			wl_write_log( "wl_shortcode_chord_get_graph : post not found [ post id :: $item ]" );
+		if (is_null($post)) {
+			wl_write_log("wl_shortcode_chord_get_graph : post not found [ post id :: $item ]");
 
 			return $item;
 		}
 
 		// Get the entity taxonomy bound to this post (if there's no taxonomy, no stylesheet will be set).
-		$term = wl_entity_type_taxonomy_get_type( $item );
+		$term = wl_entity_type_taxonomy_get_type($item);
 
-		wl_write_log( "wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: " . var_export( $term, true ) . " ]" );
+		wl_write_log("wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: ".var_export($term, true)." ]");
 
 		// TODO: get all images
 		$thumbnail    = null;
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id ) {
-			$attachment = wp_get_attachment_image_src( $thumbnail_id );
-			if ( false !== $attachment ) {
-				$thumbnail = esc_attr( $attachment[0] );
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id) {
+			$attachment = wp_get_attachment_image_src($thumbnail_id);
+			if (false !== $attachment) {
+				$thumbnail = esc_attr($attachment[0]);
 			}
 		}
 
 		$entity = array(
-			'uri'        => wl_get_entity_uri( $item ),
-			'url'        => get_permalink( $item ),
+			'uri'        => wl_get_entity_uri($item),
+			'url'        => get_permalink($item),
 			'label'      => $post->post_title,
 			'type'       => $post->post_type,
-			'thumbnails' => array( $thumbnail ),
-			'css_class'  => ( isset( $term['css_class'] ) ? $term['css_class'] : '' ),
+			'thumbnails' => array($thumbnail),
+			'css_class'  => (isset($term['css_class']) ? $term['css_class'] : ''),
 		);
 
 		$item = $entity;
 	} );
 
 	// Refactor the relations.
-	array_walk( $data['relations'], function ( &$item ) {
+	array_walk($data['relations'], function(&$item) {
 		$relation = array(
-			's' => wl_get_entity_uri( $item[0] ),
-			'o' => wl_get_entity_uri( $item[1] ),
+			's' => wl_get_entity_uri($item[0]),
+			'o' => wl_get_entity_uri($item[1]),
 		);
 
 		$item = $relation;
@@ -182,14 +181,14 @@ 
 	$post_id = $_REQUEST['post_id'];
 	$depth   = $_REQUEST['depth'];
 
-	$relations = wl_shortcode_chord_get_relations( $post_id, $depth );
-	$graph     = wl_shortcode_chord_get_graph( $relations );
+	$relations = wl_shortcode_chord_get_relations($post_id, $depth);
+	$graph     = wl_shortcode_chord_get_graph($relations);
 
-	wl_core_send_json( $graph );
+	wl_core_send_json($graph);
 }
 
-add_action( 'wp_ajax_wl_chord', 'wl_shortcode_chord_ajax' );
-add_action( 'wp_ajax_nopriv_wl_chord', 'wl_shortcode_chord_ajax' );
+add_action('wp_ajax_wl_chord', 'wl_shortcode_chord_ajax');
+add_action('wp_ajax_nopriv_wl_chord', 'wl_shortcode_chord_ajax');
 
 //
 ///**