insideout10 / wordlift-plugin

src/public/class-wordlift-related-entities-cloud-shortcode.php

Indentation +98 added lines, -98 removed lines

@@ -16,110 +16,110 @@
  */
 class Wordlift_Related_Entities_Cloud_Shortcode extends Wordlift_Shortcode {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	const SHORTCODE = 'wl_cloud';
-
-	/**
-	 * The {@link Wordlift_Relation_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 */
-	private $relation_service;
-
-	/**
-	 * Create a {@link Wordlift_Related_Entities_Cloud_Shortcode} instance.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
-	 */
-	public function __construct( $relation_service ) {
-		parent::__construct();
-
-		$this->relation_service = $relation_service;
-
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function render( $atts ) {
-
-		$tags = $this->get_related_entities_tags();
-
-		// Bail out if there are no associated entities.
-		if ( empty( $tags ) ) {
-			return '';
-		}
-
-		/*
+    /**
+     * {@inheritdoc}
+     */
+    const SHORTCODE = 'wl_cloud';
+
+    /**
+     * The {@link Wordlift_Relation_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     */
+    private $relation_service;
+
+    /**
+     * Create a {@link Wordlift_Related_Entities_Cloud_Shortcode} instance.
+     *
+     * @since 3.15.0
+     *
+     * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
+     */
+    public function __construct( $relation_service ) {
+        parent::__construct();
+
+        $this->relation_service = $relation_service;
+
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function render( $atts ) {
+
+        $tags = $this->get_related_entities_tags();
+
+        // Bail out if there are no associated entities.
+        if ( empty( $tags ) ) {
+            return '';
+        }
+
+        /*
 		 * Since the output is use in the widget as well, we need to have the
 		 * same class as the core tagcloud widget, to easily inherit its styling.
 		 */
 
-		return '<div class="tagcloud wl-related-entities-cloud">' .
-		       wp_generate_tag_cloud( $tags ) .
-		       '</div>';
-	}
-
-	/**
-	 * Find the related entities to the currently displayed post and
-	 * calculate the "tags" for them as wp_generate_tag_cloud expects to get.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @return array    Array of tags. Empty array in case we re not in a context
-	 *                  of a post, or it has no related entities.
-	 */
-	public function get_related_entities_tags() {
-
-		// Define the supported types list.
-		$supported_types = Wordlift_Entity_Service::valid_entity_post_types();
-
-		// Show nothing if not on a post or entity page.
-		if ( ! is_singular( $supported_types ) ) {
-			return array();
-		}
-
-		// Get the IDs of entities related to current post.
-		$related_entities = wl_core_get_related_entity_ids( get_the_ID(), array( 'status' => 'publish' ) );
-
-		// Bail out if there are no associated entities.
-		if ( empty( $related_entities ) ) {
-			return array();
-		}
-
-		/*
+        return '<div class="tagcloud wl-related-entities-cloud">' .
+                wp_generate_tag_cloud( $tags ) .
+                '</div>';
+    }
+
+    /**
+     * Find the related entities to the currently displayed post and
+     * calculate the "tags" for them as wp_generate_tag_cloud expects to get.
+     *
+     * @since 3.11.0
+     *
+     * @return array    Array of tags. Empty array in case we re not in a context
+     *                  of a post, or it has no related entities.
+     */
+    public function get_related_entities_tags() {
+
+        // Define the supported types list.
+        $supported_types = Wordlift_Entity_Service::valid_entity_post_types();
+
+        // Show nothing if not on a post or entity page.
+        if ( ! is_singular( $supported_types ) ) {
+            return array();
+        }
+
+        // Get the IDs of entities related to current post.
+        $related_entities = wl_core_get_related_entity_ids( get_the_ID(), array( 'status' => 'publish' ) );
+
+        // Bail out if there are no associated entities.
+        if ( empty( $related_entities ) ) {
+            return array();
+        }
+
+        /*
 		 * Create an array of "tags" to feed to wp_generate_tag_cloud.
 		 * Use the number of posts and entities connected to the entity as a weight.
 		 */
-		$tags = array();
-
-		foreach ( array_unique( $related_entities ) as $entity_id ) {
-
-			$connected_entities = count( wl_core_get_related_entity_ids( $entity_id, array( 'status' => 'publish' ) ) );
-			$connected_posts    = count( $this->relation_service->get_article_subjects( $entity_id, '*', null, 'publish' ) );
-
-			$tags[] = (object) array(
-				'id'    => $entity_id,
-				// Used to give a unique class on the tag.
-				'name'  => get_the_title( $entity_id ),
-				// The text of the tag.
-				'slug'  => get_the_title( $entity_id ),
-				// Required but not seem to be relevant
-				'link'  => get_permalink( $entity_id ),
-				// the url the tag links to.
-				'count' => $connected_entities + $connected_posts,
-				// The weight.
-			);
-
-		}
-
-		return $tags;
-	}
+        $tags = array();
+
+        foreach ( array_unique( $related_entities ) as $entity_id ) {
+
+            $connected_entities = count( wl_core_get_related_entity_ids( $entity_id, array( 'status' => 'publish' ) ) );
+            $connected_posts    = count( $this->relation_service->get_article_subjects( $entity_id, '*', null, 'publish' ) );
+
+            $tags[] = (object) array(
+                'id'    => $entity_id,
+                // Used to give a unique class on the tag.
+                'name'  => get_the_title( $entity_id ),
+                // The text of the tag.
+                'slug'  => get_the_title( $entity_id ),
+                // Required but not seem to be relevant
+                'link'  => get_permalink( $entity_id ),
+                // the url the tag links to.
+                'count' => $connected_entities + $connected_posts,
+                // The weight.
+            );
+
+        }
+
+        return $tags;
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -37,7 +37,7 @@ 
 	 *
 	 * @param \Wordlift_Relation_Service $relation_service The {@link Wordlift_Relation_Service} instance.
 	 */
-	public function __construct( $relation_service ) {
+	public function __construct($relation_service) {
 		parent::__construct();
 
 		$this->relation_service = $relation_service;
@@ -47,12 +47,12 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function render( $atts ) {
+	public function render($atts) {
 
 		$tags = $this->get_related_entities_tags();
 
 		// Bail out if there are no associated entities.
-		if ( empty( $tags ) ) {
+		if (empty($tags)) {
 			return '';
 		}
 
@@ -61,8 +61,8 @@ 
 		 * same class as the core tagcloud widget, to easily inherit its styling.
 		 */
 
-		return '<div class="tagcloud wl-related-entities-cloud">' .
-		       wp_generate_tag_cloud( $tags ) .
+		return '<div class="tagcloud wl-related-entities-cloud">'.
+		       wp_generate_tag_cloud($tags).
 		       '</div>';
 	}
 
@@ -81,15 +81,15 @@ 
 		$supported_types = Wordlift_Entity_Service::valid_entity_post_types();
 
 		// Show nothing if not on a post or entity page.
-		if ( ! is_singular( $supported_types ) ) {
+		if ( ! is_singular($supported_types)) {
 			return array();
 		}
 
 		// Get the IDs of entities related to current post.
-		$related_entities = wl_core_get_related_entity_ids( get_the_ID(), array( 'status' => 'publish' ) );
+		$related_entities = wl_core_get_related_entity_ids(get_the_ID(), array('status' => 'publish'));
 
 		// Bail out if there are no associated entities.
-		if ( empty( $related_entities ) ) {
+		if (empty($related_entities)) {
 			return array();
 		}
 
@@ -99,19 +99,19 @@ 
 		 */
 		$tags = array();
 
-		foreach ( array_unique( $related_entities ) as $entity_id ) {
+		foreach (array_unique($related_entities) as $entity_id) {
 
-			$connected_entities = count( wl_core_get_related_entity_ids( $entity_id, array( 'status' => 'publish' ) ) );
-			$connected_posts    = count( $this->relation_service->get_article_subjects( $entity_id, '*', null, 'publish' ) );
+			$connected_entities = count(wl_core_get_related_entity_ids($entity_id, array('status' => 'publish')));
+			$connected_posts    = count($this->relation_service->get_article_subjects($entity_id, '*', null, 'publish'));
 
 			$tags[] = (object) array(
 				'id'    => $entity_id,
 				// Used to give a unique class on the tag.
-				'name'  => get_the_title( $entity_id ),
+				'name'  => get_the_title($entity_id),
 				// The text of the tag.
-				'slug'  => get_the_title( $entity_id ),
+				'slug'  => get_the_title($entity_id),
 				// Required but not seem to be relevant
-				'link'  => get_permalink( $entity_id ),
+				'link'  => get_permalink($entity_id),
 				// the url the tag links to.
 				'count' => $connected_entities + $connected_posts,
 				// The weight.

src/public/class-wordlift-public.php

Indentation +123 added lines, -123 removed lines

@@ -22,128 +22,128 @@
  */
 class Wordlift_Public {
 
-	/**
-	 * The ID of this plugin.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $plugin_name The ID of this plugin.
-	 */
-	private $plugin_name;
-
-	/**
-	 * The version of this plugin.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $version The current version of this plugin.
-	 */
-	private $version;
-
-	/**
-	 * Initialize the class and set its properties.
-	 *
-	 * @since    1.0.0
-	 *
-	 * @param      string $plugin_name The name of the plugin.
-	 * @param      string $version The version of this plugin.
-	 */
-	public function __construct( $plugin_name, $version ) {
-
-		$this->plugin_name = $plugin_name;
-		$this->version     = $version;
-
-	}
-
-	/**
-	 * Register the stylesheets for the public-facing side of the site.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_styles() {
-
-		/**
-		 * This function is provided for demonstration purposes only.
-		 *
-		 * An instance of this class should be passed to the run() function
-		 * defined in Wordlift_Loader as all of the hooks are defined
-		 * in that particular class.
-		 *
-		 * The Wordlift_Loader will then create the relationship
-		 * between the defined hooks and the functions defined in this
-		 * class.
-		 */
-
-		wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-public.css', array(), $this->version, 'all' );
-
-	}
-
-	/**
-	 * Register the stylesheets for the public-facing side of the site.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_scripts() {
-
-		/**
-		 * This function is provided for demonstration purposes only.
-		 *
-		 * An instance of this class should be passed to the run() function
-		 * defined in Wordlift_Loader as all of the hooks are defined
-		 * in that particular class.
-		 *
-		 * The Wordlift_Loader will then create the relationship
-		 * between the defined hooks and the functions defined in this
-		 * class.
-		 */
-
-		$settings = self::get_settings();
-
-		// Note that we switched the js to be loaded in footer, since it is loading
-		// the json-ld representation.
-		wp_enqueue_script( $this->plugin_name, plugin_dir_url( dirname( __FILE__ ) ) . 'js/dist/bundle.js', array(), $this->version, true );
-		wp_localize_script( $this->plugin_name, 'wlSettings', $settings );
-
-	}
-
-	/**
-	 * Get the settings array.
-	 *
-	 * @since 3.19.1
-	 *
-	 * @return array An array with the settings.
-	 */
-	public static function get_settings() {
-
-		// Prepare a settings array for client-side functions.
-		$settings = array(
-			'ajaxUrl' => admin_url( 'admin-ajax.php' ),
-			'apiUrl'  => get_site_url( null, 'wl-api/' ),
-		);
-
-		// If we're in a single page, then print out the post id.
-		if ( is_singular() ) {
-			$settings['postId'] = get_the_ID();
-		}
-
-		// Add flag that we are on home/blog page.
-		if ( is_home() || is_front_page() ) {
-			$settings['isHome'] = true;
-		}
-
-		// By default only enable JSON-LD on supported entity pages (includes
-		// `page`, `post` and `entity` by default) and on the home page.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/733
-		$jsonld_enabled = is_home() || is_front_page() || Wordlift_Entity_Type_Service::is_valid_entity_post_type( get_post_type() );
-
-		// Add the JSON-LD enabled flag, when set to false, the JSON-lD won't
-		// be loaded.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/642.
-		$settings['jsonld_enabled'] = apply_filters( 'wl_jsonld_enabled', $jsonld_enabled );
-
-		return $settings;
-	}
+    /**
+     * The ID of this plugin.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $plugin_name The ID of this plugin.
+     */
+    private $plugin_name;
+
+    /**
+     * The version of this plugin.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $version The current version of this plugin.
+     */
+    private $version;
+
+    /**
+     * Initialize the class and set its properties.
+     *
+     * @since    1.0.0
+     *
+     * @param      string $plugin_name The name of the plugin.
+     * @param      string $version The version of this plugin.
+     */
+    public function __construct( $plugin_name, $version ) {
+
+        $this->plugin_name = $plugin_name;
+        $this->version     = $version;
+
+    }
+
+    /**
+     * Register the stylesheets for the public-facing side of the site.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_styles() {
+
+        /**
+         * This function is provided for demonstration purposes only.
+         *
+         * An instance of this class should be passed to the run() function
+         * defined in Wordlift_Loader as all of the hooks are defined
+         * in that particular class.
+         *
+         * The Wordlift_Loader will then create the relationship
+         * between the defined hooks and the functions defined in this
+         * class.
+         */
+
+        wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-public.css', array(), $this->version, 'all' );
+
+    }
+
+    /**
+     * Register the stylesheets for the public-facing side of the site.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_scripts() {
+
+        /**
+         * This function is provided for demonstration purposes only.
+         *
+         * An instance of this class should be passed to the run() function
+         * defined in Wordlift_Loader as all of the hooks are defined
+         * in that particular class.
+         *
+         * The Wordlift_Loader will then create the relationship
+         * between the defined hooks and the functions defined in this
+         * class.
+         */
+
+        $settings = self::get_settings();
+
+        // Note that we switched the js to be loaded in footer, since it is loading
+        // the json-ld representation.
+        wp_enqueue_script( $this->plugin_name, plugin_dir_url( dirname( __FILE__ ) ) . 'js/dist/bundle.js', array(), $this->version, true );
+        wp_localize_script( $this->plugin_name, 'wlSettings', $settings );
+
+    }
+
+    /**
+     * Get the settings array.
+     *
+     * @since 3.19.1
+     *
+     * @return array An array with the settings.
+     */
+    public static function get_settings() {
+
+        // Prepare a settings array for client-side functions.
+        $settings = array(
+            'ajaxUrl' => admin_url( 'admin-ajax.php' ),
+            'apiUrl'  => get_site_url( null, 'wl-api/' ),
+        );
+
+        // If we're in a single page, then print out the post id.
+        if ( is_singular() ) {
+            $settings['postId'] = get_the_ID();
+        }
+
+        // Add flag that we are on home/blog page.
+        if ( is_home() || is_front_page() ) {
+            $settings['isHome'] = true;
+        }
+
+        // By default only enable JSON-LD on supported entity pages (includes
+        // `page`, `post` and `entity` by default) and on the home page.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/733
+        $jsonld_enabled = is_home() || is_front_page() || Wordlift_Entity_Type_Service::is_valid_entity_post_type( get_post_type() );
+
+        // Add the JSON-LD enabled flag, when set to false, the JSON-lD won't
+        // be loaded.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/642.
+        $settings['jsonld_enabled'] = apply_filters( 'wl_jsonld_enabled', $jsonld_enabled );
+
+        return $settings;
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -48,7 +48,7 @@ 
 	 * @param      string $plugin_name The name of the plugin.
 	 * @param      string $version The version of this plugin.
 	 */
-	public function __construct( $plugin_name, $version ) {
+	public function __construct($plugin_name, $version) {
 
 		$this->plugin_name = $plugin_name;
 		$this->version     = $version;
@@ -74,7 +74,7 @@ 
 		 * class.
 		 */
 
-		wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-public.css', array(), $this->version, 'all' );
+		wp_enqueue_style($this->plugin_name, plugin_dir_url(__FILE__).'css/wordlift-public.css', array(), $this->version, 'all');
 
 	}
 
@@ -101,8 +101,8 @@ 
 
 		// Note that we switched the js to be loaded in footer, since it is loading
 		// the json-ld representation.
-		wp_enqueue_script( $this->plugin_name, plugin_dir_url( dirname( __FILE__ ) ) . 'js/dist/bundle.js', array(), $this->version, true );
-		wp_localize_script( $this->plugin_name, 'wlSettings', $settings );
+		wp_enqueue_script($this->plugin_name, plugin_dir_url(dirname(__FILE__)).'js/dist/bundle.js', array(), $this->version, true);
+		wp_localize_script($this->plugin_name, 'wlSettings', $settings);
 
 	}
 
@@ -117,17 +117,17 @@ 
 
 		// Prepare a settings array for client-side functions.
 		$settings = array(
-			'ajaxUrl' => admin_url( 'admin-ajax.php' ),
-			'apiUrl'  => get_site_url( null, 'wl-api/' ),
+			'ajaxUrl' => admin_url('admin-ajax.php'),
+			'apiUrl'  => get_site_url(null, 'wl-api/'),
 		);
 
 		// If we're in a single page, then print out the post id.
-		if ( is_singular() ) {
+		if (is_singular()) {
 			$settings['postId'] = get_the_ID();
 		}
 
 		// Add flag that we are on home/blog page.
-		if ( is_home() || is_front_page() ) {
+		if (is_home() || is_front_page()) {
 			$settings['isHome'] = true;
 		}
 
@@ -135,13 +135,13 @@ 
 		// `page`, `post` and `entity` by default) and on the home page.
 		//
 		// @see https://github.com/insideout10/wordlift-plugin/issues/733
-		$jsonld_enabled = is_home() || is_front_page() || Wordlift_Entity_Type_Service::is_valid_entity_post_type( get_post_type() );
+		$jsonld_enabled = is_home() || is_front_page() || Wordlift_Entity_Type_Service::is_valid_entity_post_type(get_post_type());
 
 		// Add the JSON-LD enabled flag, when set to false, the JSON-lD won't
 		// be loaded.
 		//
 		// @see https://github.com/insideout10/wordlift-plugin/issues/642.
-		$settings['jsonld_enabled'] = apply_filters( 'wl_jsonld_enabled', $jsonld_enabled );
+		$settings['jsonld_enabled'] = apply_filters('wl_jsonld_enabled', $jsonld_enabled);
 
 		return $settings;
 	}

src/public/class-wordlift-amp-service.php

Indentation +49 added lines, -49 removed lines

@@ -21,64 +21,64 @@
  */
 class Wordlift_AMP_Service {
 
-	/**
-	 * The {@link \Wordlift_Jsonld_Service} instance.
-	 *
-	 * @since 3.19.1
-	 * @access private
-	 * @var \Wordlift_Jsonld_Service $jsonld_service The {@link \Wordlift_Jsonld_Service} instance.
-	 */
-	private $jsonld_service;
+    /**
+     * The {@link \Wordlift_Jsonld_Service} instance.
+     *
+     * @since 3.19.1
+     * @access private
+     * @var \Wordlift_Jsonld_Service $jsonld_service The {@link \Wordlift_Jsonld_Service} instance.
+     */
+    private $jsonld_service;
 
-	/**
-	 * Create a {@link Wordlift_AMP_Service} instance.
-	 * @since 3.19.1
-	 *
-	 * @param \Wordlift_Jsonld_Service $jsonld_service
-	 */
-	function __construct( $jsonld_service ) {
+    /**
+     * Create a {@link Wordlift_AMP_Service} instance.
+     * @since 3.19.1
+     *
+     * @param \Wordlift_Jsonld_Service $jsonld_service
+     */
+    function __construct( $jsonld_service ) {
 
-		$this->jsonld_service = $jsonld_service;
+        $this->jsonld_service = $jsonld_service;
 
-		add_action( 'amp_init', array( $this, 'register_entity_cpt_with_amp_plugin', ) );
-		add_filter( 'amp_post_template_metadata', array( $this, 'amp_post_template_metadata', ), 99, 2 );
+        add_action( 'amp_init', array( $this, 'register_entity_cpt_with_amp_plugin', ) );
+        add_filter( 'amp_post_template_metadata', array( $this, 'amp_post_template_metadata', ), 99, 2 );
 
-	}
+    }
 
-	/**
-	 * Register the `entity` post type with the AMP plugin.
-	 *
-	 * @since 3.12.0
-	 */
-	function register_entity_cpt_with_amp_plugin() {
+    /**
+     * Register the `entity` post type with the AMP plugin.
+     *
+     * @since 3.12.0
+     */
+    function register_entity_cpt_with_amp_plugin() {
 
-		if ( ! defined( 'AMP_QUERY_VAR' ) ) {
-			return;
-		}
+        if ( ! defined( 'AMP_QUERY_VAR' ) ) {
+            return;
+        }
 
-		foreach ( Wordlift_Entity_Service::valid_entity_post_types() as $post_type ) {
-			// Do not change anything for posts and pages.
-			if ( 'post' === $post_type || 'page' === $post_type ) {
-				continue;
-			}
-			add_post_type_support( $post_type, AMP_QUERY_VAR );
-		}
+        foreach ( Wordlift_Entity_Service::valid_entity_post_types() as $post_type ) {
+            // Do not change anything for posts and pages.
+            if ( 'post' === $post_type || 'page' === $post_type ) {
+                continue;
+            }
+            add_post_type_support( $post_type, AMP_QUERY_VAR );
+        }
 
-	}
+    }
 
-	/**
-	 * Filters Schema.org metadata for a post.
-	 *
-	 * @since 3.19.1
-	 *
-	 * @param array $metadata Metadata.
-	 * @param WP_Post $post Post.
-	 *
-	 * @return array Return WordLift's generated JSON-LD.
-	 */
-	function amp_post_template_metadata( $metadata, $post ) {
+    /**
+     * Filters Schema.org metadata for a post.
+     *
+     * @since 3.19.1
+     *
+     * @param array $metadata Metadata.
+     * @param WP_Post $post Post.
+     *
+     * @return array Return WordLift's generated JSON-LD.
+     */
+    function amp_post_template_metadata( $metadata, $post ) {
 
-		return $this->jsonld_service->get_jsonld( false, $post->ID );
-	}
+        return $this->jsonld_service->get_jsonld( false, $post->ID );
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -36,12 +36,12 @@ 
 	 *
 	 * @param \Wordlift_Jsonld_Service $jsonld_service
 	 */
-	function __construct( $jsonld_service ) {
+	function __construct($jsonld_service) {
 
 		$this->jsonld_service = $jsonld_service;
 
-		add_action( 'amp_init', array( $this, 'register_entity_cpt_with_amp_plugin', ) );
-		add_filter( 'amp_post_template_metadata', array( $this, 'amp_post_template_metadata', ), 99, 2 );
+		add_action('amp_init', array($this, 'register_entity_cpt_with_amp_plugin',));
+		add_filter('amp_post_template_metadata', array($this, 'amp_post_template_metadata',), 99, 2);
 
 	}
 
@@ -52,16 +52,16 @@ 
 	 */
 	function register_entity_cpt_with_amp_plugin() {
 
-		if ( ! defined( 'AMP_QUERY_VAR' ) ) {
+		if ( ! defined('AMP_QUERY_VAR')) {
 			return;
 		}
 
-		foreach ( Wordlift_Entity_Service::valid_entity_post_types() as $post_type ) {
+		foreach (Wordlift_Entity_Service::valid_entity_post_types() as $post_type) {
 			// Do not change anything for posts and pages.
-			if ( 'post' === $post_type || 'page' === $post_type ) {
+			if ('post' === $post_type || 'page' === $post_type) {
 				continue;
 			}
-			add_post_type_support( $post_type, AMP_QUERY_VAR );
+			add_post_type_support($post_type, AMP_QUERY_VAR);
 		}
 
 	}
@@ -76,9 +76,9 @@ 
 	 *
 	 * @return array Return WordLift's generated JSON-LD.
 	 */
-	function amp_post_template_metadata( $metadata, $post ) {
+	function amp_post_template_metadata($metadata, $post) {
 
-		return $this->jsonld_service->get_jsonld( false, $post->ID );
+		return $this->jsonld_service->get_jsonld(false, $post->ID);
 	}
 
 }

src/public/class-wordlift-sharethis-service.php

Indentation +106 added lines, -106 removed lines

@@ -17,111 +17,111 @@
  */
 class Wordlift_ShareThis_Service {
 
-	/**
-	 * The ShareThis function which prints the buttons.
-	 *
-	 * @since 3.2.0
-	 */
-	const ADD_WIDGET_FUNCTION_NAME = 'st_add_widget';
-
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.2.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log_service The Log service.
-	 */
-	private $log_service;
-
-	/**
-	 * Create an instance of the ShareThis service.
-	 *
-	 * @since 3.2.0
-	 */
-	public function __construct() {
-
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_ShareThis_Service' );
-
-	}
-
-	/**
-	 * Receive <em>the_content</em> filter calls from WordPress.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $content The post content.
-	 *
-	 * @return string The updated post content.
-	 */
-	public function the_content( $content ) {
-
-		return $this->call_sharethis( 'the_content', $content );
-	}
-
-	/**
-	 * Receive <em>the_excerpt</em> filter calls from WordPress.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $content The post excerpt.
-	 *
-	 * @return string The updated post excerpt.
-	 */
-	public function the_excerpt( $content ) {
-
-		return $this->call_sharethis( 'the_excerpt', $content );
-	}
-
-	/**
-	 * Call the ShareThis function.
-	 *
-	 * @since 3.2.0
-	 *
-	 * @param string $tag The filter tag.
-	 * @param string $content The post content.
-	 *
-	 * @return string The updated post content.
-	 */
-	private function call_sharethis( $tag, $content ) {
-
-		// Get the current post.
-		global $post;
-
-		// Bail out if the current entity is a post/page since this is already handled by ShareThis.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/819
-		if ( 'post' === $post->post_type || 'page' === $post->post_type ) {
-			return $content;
-		}
-
-		// If it's not the entity type, return.
-		$entity_service = Wordlift_Entity_Service::get_instance();
-		if ( null === $post || ! $entity_service->is_entity( get_the_ID() ) ) {
-			return $content;
-		}
-
-		// If the ShareThis function doesn't exist, return.
-		if ( ! function_exists( self::ADD_WIDGET_FUNCTION_NAME ) ) {
-			return $content;
-		}
-
-		// If ShareThis hasn't been added as a filter, return.
-		if ( ! has_filter( $tag, self::ADD_WIDGET_FUNCTION_NAME ) ) {
-			return $content;
-		}
-
-		// Temporary pop the post type and replace it with post.
-		$post_type       = $post->post_type;
-		$post->post_type = 'post';
-
-		// Call ShareThis (disguised as a post).
-		$content = call_user_func_array( self::ADD_WIDGET_FUNCTION_NAME, array( $content ) );
-
-		// Restore our post type.
-		$post->post_type = $post_type;
-
-		// Finally return the content.
-		return $content;
-	}
+    /**
+     * The ShareThis function which prints the buttons.
+     *
+     * @since 3.2.0
+     */
+    const ADD_WIDGET_FUNCTION_NAME = 'st_add_widget';
+
+    /**
+     * The Log service.
+     *
+     * @since  3.2.0
+     * @access private
+     * @var \Wordlift_Log_Service $log_service The Log service.
+     */
+    private $log_service;
+
+    /**
+     * Create an instance of the ShareThis service.
+     *
+     * @since 3.2.0
+     */
+    public function __construct() {
+
+        $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_ShareThis_Service' );
+
+    }
+
+    /**
+     * Receive <em>the_content</em> filter calls from WordPress.
+     *
+     * @since 3.2.0
+     *
+     * @param string $content The post content.
+     *
+     * @return string The updated post content.
+     */
+    public function the_content( $content ) {
+
+        return $this->call_sharethis( 'the_content', $content );
+    }
+
+    /**
+     * Receive <em>the_excerpt</em> filter calls from WordPress.
+     *
+     * @since 3.2.0
+     *
+     * @param string $content The post excerpt.
+     *
+     * @return string The updated post excerpt.
+     */
+    public function the_excerpt( $content ) {
+
+        return $this->call_sharethis( 'the_excerpt', $content );
+    }
+
+    /**
+     * Call the ShareThis function.
+     *
+     * @since 3.2.0
+     *
+     * @param string $tag The filter tag.
+     * @param string $content The post content.
+     *
+     * @return string The updated post content.
+     */
+    private function call_sharethis( $tag, $content ) {
+
+        // Get the current post.
+        global $post;
+
+        // Bail out if the current entity is a post/page since this is already handled by ShareThis.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/819
+        if ( 'post' === $post->post_type || 'page' === $post->post_type ) {
+            return $content;
+        }
+
+        // If it's not the entity type, return.
+        $entity_service = Wordlift_Entity_Service::get_instance();
+        if ( null === $post || ! $entity_service->is_entity( get_the_ID() ) ) {
+            return $content;
+        }
+
+        // If the ShareThis function doesn't exist, return.
+        if ( ! function_exists( self::ADD_WIDGET_FUNCTION_NAME ) ) {
+            return $content;
+        }
+
+        // If ShareThis hasn't been added as a filter, return.
+        if ( ! has_filter( $tag, self::ADD_WIDGET_FUNCTION_NAME ) ) {
+            return $content;
+        }
+
+        // Temporary pop the post type and replace it with post.
+        $post_type       = $post->post_type;
+        $post->post_type = 'post';
+
+        // Call ShareThis (disguised as a post).
+        $content = call_user_func_array( self::ADD_WIDGET_FUNCTION_NAME, array( $content ) );
+
+        // Restore our post type.
+        $post->post_type = $post_type;
+
+        // Finally return the content.
+        return $content;
+    }
 
 }

Spacing +11 added lines, -11 removed lines

@@ -40,7 +40,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_ShareThis_Service' );
+		$this->log_service = Wordlift_Log_Service::get_logger('Wordlift_ShareThis_Service');
 
 	}
 
@@ -53,9 +53,9 @@ 
 	 *
 	 * @return string The updated post content.
 	 */
-	public function the_content( $content ) {
+	public function the_content($content) {
 
-		return $this->call_sharethis( 'the_content', $content );
+		return $this->call_sharethis('the_content', $content);
 	}
 
 	/**
@@ -67,9 +67,9 @@ 
 	 *
 	 * @return string The updated post excerpt.
 	 */
-	public function the_excerpt( $content ) {
+	public function the_excerpt($content) {
 
-		return $this->call_sharethis( 'the_excerpt', $content );
+		return $this->call_sharethis('the_excerpt', $content);
 	}
 
 	/**
@@ -82,7 +82,7 @@ 
 	 *
 	 * @return string The updated post content.
 	 */
-	private function call_sharethis( $tag, $content ) {
+	private function call_sharethis($tag, $content) {
 
 		// Get the current post.
 		global $post;
@@ -90,23 +90,23 @@ 
 		// Bail out if the current entity is a post/page since this is already handled by ShareThis.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/819
-		if ( 'post' === $post->post_type || 'page' === $post->post_type ) {
+		if ('post' === $post->post_type || 'page' === $post->post_type) {
 			return $content;
 		}
 
 		// If it's not the entity type, return.
 		$entity_service = Wordlift_Entity_Service::get_instance();
-		if ( null === $post || ! $entity_service->is_entity( get_the_ID() ) ) {
+		if (null === $post || ! $entity_service->is_entity(get_the_ID())) {
 			return $content;
 		}
 
 		// If the ShareThis function doesn't exist, return.
-		if ( ! function_exists( self::ADD_WIDGET_FUNCTION_NAME ) ) {
+		if ( ! function_exists(self::ADD_WIDGET_FUNCTION_NAME)) {
 			return $content;
 		}
 
 		// If ShareThis hasn't been added as a filter, return.
-		if ( ! has_filter( $tag, self::ADD_WIDGET_FUNCTION_NAME ) ) {
+		if ( ! has_filter($tag, self::ADD_WIDGET_FUNCTION_NAME)) {
 			return $content;
 		}
 
@@ -115,7 +115,7 @@ 
 		$post->post_type = 'post';
 
 		// Call ShareThis (disguised as a post).
-		$content = call_user_func_array( self::ADD_WIDGET_FUNCTION_NAME, array( $content ) );
+		$content = call_user_func_array(self::ADD_WIDGET_FUNCTION_NAME, array($content));
 
 		// Restore our post type.
 		$post->post_type = $post_type;

src/admin/WL_Metabox/class-wl-metabox-field.php

Indentation +419 added lines, -419 removed lines

@@ -19,420 +19,420 @@ 
  */
 class WL_Metabox_Field {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access protected
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	protected $log;
-
-	/**
-	 * The meta name for this field's value.
-	 *
-	 * @var string $meta_name The meta name for this field's value.
-	 */
-	public $meta_name;
-
-	/**
-	 * The custom field settings.
-	 *
-	 * @var null|array $raw_custom_field The custom field settings.
-	 */
-	public $raw_custom_field;
-
-	/**
-	 * The schema.org predicate.
-	 *
-	 * @var string $predicate The schema.org predicate.
-	 */
-	public $predicate;
-
-	/**
-	 * The field's label.
-	 *
-	 * @var string $label The field's label.
-	 */
-	public $label;
-
-	/**
-	 * The WordLift data type.
-	 *
-	 * @var string $expected_wl_type The WordLift data type.
-	 */
-	public $expected_wl_type;
-
-	/**
-	 * The RDF data type.
-	 *
-	 * @var string $expected_uri_type The RDF data type.
-	 */
-	public $expected_uri_type;
-
-	/**
-	 * The cardinality.
-	 *
-	 * @var int $cardinality The cardinality.
-	 */
-	public $cardinality;
-
-	/**
-	 * The current value.
-	 *
-	 * @var array $data The current value.
-	 */
-	public $data;
-
-	/**
-	 * The current {@link WP_Post} id.
-	 *
-	 * @since 3.15.3
-	 *
-	 * @var int The current {@link WP_Post} id.
-	 */
-	private $post_id;
-
-	/**
-	 * Create a {@link WL_Metabox_Field} instance.
-	 *
-	 * @param array $args An array of parameters.
-	 */
-	public function __construct( $args ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'WL_Metabox_Field' );
-
-		if ( empty( $args ) ) {
-			return;
-		}
-
-		// Save a copy of the custom field's params.
-		$this->raw_custom_field = reset( $args );
-
-		// Extract meta name (post_meta key for the DB).
-		$this->meta_name = key( $args );
-
-		// Extract linked data predicate.
-		if ( isset( $this->raw_custom_field['predicate'] ) ) {
-			$this->predicate = $this->raw_custom_field['predicate'];
-		} else {
-			return;
-		}
-
-		// Extract human readable label.
-		$exploded_predicate = explode( '/', $this->predicate );
-
-		// Use the label defined for the property if set, otherwise the last part of the schema.org/xyz predicate.
-		$this->label = isset( $this->raw_custom_field['metabox']['label'] ) ? $this->raw_custom_field['metabox']['label'] : end( $exploded_predicate );
-
-		// Extract field constraints (numerosity, expected type).
-		// Default constaints: accept one string..
-		if ( isset( $this->raw_custom_field['type'] ) ) {
-			$this->expected_wl_type = $this->raw_custom_field['type'];
-		} else {
-			$this->expected_wl_type = Wordlift_Schema_Service::DATA_TYPE_STRING;
-		}
-
-		$this->cardinality = 1;
-		if ( isset( $this->raw_custom_field['constraints'] ) ) {
-
-			$constraints = $this->raw_custom_field['constraints'];
-
-			// Extract cardinality.
-			if ( isset( $constraints['cardinality'] ) ) {
-				$this->cardinality = $constraints['cardinality'];
-			}
-
-			// Which type of entity can we accept (e.g. Place, Event, ecc.)? .
-			if ( Wordlift_Schema_Service::DATA_TYPE_URI === $this->expected_wl_type && isset( $constraints['uri_type'] ) ) {
-				$this->expected_uri_type = is_array( $constraints['uri_type'] )
-					? $constraints['uri_type']
-					: array( $constraints['uri_type'] );
-			}
-		}
-
-		// Save early the post id to avoid other plugins messing up with it.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/665.
-		$this->post_id = get_the_ID();
-
-	}
-
-	/**
-	 * Return nonce HTML.
-	 *
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 */
-	public function html_nonce() {
-
-		return wp_nonce_field( 'wordlift_' . $this->meta_name . '_entity_box', 'wordlift_' . $this->meta_name . '_entity_box_nonce', true, false );
-	}
-
-	/**
-	 * Verify nonce.
-	 *
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 *
-	 * @return boolean Nonce verification.
-	 */
-	public function verify_nonce() {
-
-		$nonce_name   = 'wordlift_' . $this->meta_name . '_entity_box_nonce';
-		$nonce_verify = 'wordlift_' . $this->meta_name . '_entity_box';
-
-		if ( ! isset( $_POST[ $nonce_name ] ) ) {
-			return false;
-		}
-
-		// Verify that the nonce is valid.
-		return wp_verify_nonce( $_POST[ $nonce_name ], $nonce_verify );
-	}
-
-	/**
-	 * Load data from DB and store the resulting array in $this->data.
-	 *
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 */
-	public function get_data() {
-
-		// Get the post id and load the data.
-		$post_id    = $this->post_id;
-		$this->data = get_post_meta( $post_id, $this->meta_name );
-
-		$this->log->debug( 'Found ' . count( $this->data ) . " value(s) for meta $this->meta_name, post $post_id." );
-
-	}
-
-	/**
-	 * Sanitizes data before saving to DB. Default sanitization trashes empty
-	 * values.
-	 *
-	 * Stores the sanitized values into $this->data so they can be later processed.
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 *
-	 * @param array $values Array of values to be sanitized and then stored into
-	 *                      $this->data.
-	 */
-	public function sanitize_data( $values ) {
-
-		$sanitized_data = array();
-
-		if ( ! is_array( $values ) ) {
-			$values = array( $values );
-		}
-
-		foreach ( $values as $value ) {
-			$sanitized_value = $this->sanitize_data_filter( $value );
-			if ( ! is_null( $sanitized_value ) ) {
-				$sanitized_data[] = $sanitized_value;
-			}
-		}
-
-		$this->data = $sanitized_data;
-	}
-
-	/**
-	 * Sanitize a single value. Called from $this->sanitize_data. Default
-	 * sanitization excludes empty values.
-	 *
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 *
-	 * @param string $value The value to sanitize.
-	 *
-	 * @return mixed Returns sanitized value, or null.
-	 */
-	public function sanitize_data_filter( $value ) {
-
-		// TODO: all fields should provide their own sanitize which shouldn't
-		// be part of a UI class.
-
-		// If the field provides its own validation, use it.
-		if ( isset( $this->raw_custom_field['sanitize'] ) ) {
-			return call_user_func( $this->raw_custom_field['sanitize'], $value );
-		}
-
-		if ( ! is_null( $value ) && '' !== $value ) {         // do not use 'empty()' -> https://www.virendrachandak.com/techtalk/php-isset-vs-empty-vs-is_null/ .
-			return $value;
-		}
-
-		return null;
-	}
-
-	/**
-	 * Save data to DB.
-	 *
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 *
-	 * @param array $values Array of values to be sanitized and then stored into $this->data.
-	 */
-	public function save_data( $values ) {
-
-		// Will sanitize data and store them in $field->data.
-		$this->sanitize_data( $values );
-
-		// Bail out, if the post id isn't set in the request or isn't numeric.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/665.
-		if ( ! isset( $_POST['post_ID'] ) || ! is_numeric( $_POST['post_ID'] ) ) {
-			return;
-		}
-
-		$entity_id = intval( $_POST['post_ID'] );
-
-		// Take away old values.
-		delete_post_meta( $entity_id, $this->meta_name );
-
-		// insert new values, respecting cardinality.
-		$single = ( 1 === $this->cardinality );
-		foreach ( $this->data as $value ) {
-			$this->log->trace( "Saving $value to $this->meta_name for entity $entity_id..." );
-			$meta_id = add_post_meta( $entity_id, $this->meta_name, $value, $single );
-			$this->log->debug( "$value to $this->meta_name for entity $entity_id saved with id $meta_id." );
-		}
-	}
-
-	/**
-	 * Returns the HTML tag that will contain the Field. By default the we
-	 * return a <div> with data- attributes on cardinality and expected types.
-	 *
-	 * It is useful to provide data- attributes for the JS scripts.
-	 *
-	 * Overwrite this method in a child class to obtain custom behaviour.
-	 */
-	public function html_wrapper_open() {
-
-		return "<div class='wl-field' data-cardinality='$this->cardinality'>";
-	}
-
-	/**
-	 * Returns Field HTML (nonce included).
-	 *
-	 * Overwrite this method (or methods called from this method) in a child
-	 * class to obtain custom behaviour.
-	 *
-	 * The HTML fragment includes the following parts:
-	 * * html wrapper open.
-	 * * heading.
-	 * * nonce.
-	 * * stored values.
-	 * * an empty input when there are no stored values.
-	 * * an add button to add more values.
-	 * * html wrapper close.
-	 */
-	public function html() {
-
-		// Open main <div> for the Field.
-		$html = $this->html_wrapper_open();
-
-		// Label.
-		$html .= $this->get_heading_html();
-
-		// print nonce.
-		$html .= $this->html_nonce();
-
-		// print data loaded from DB.
-		$count = 0;
-		$html  .= $this->get_stored_values_html( $count );
-
-		// Print the empty <input> to add new values.
-		if ( 0 === $count ) { // } || $count < $this->cardinality ) { DO NOT print empty inputs unless requested by the editor since fields might support empty strings.
-			$this->log->debug( 'Going to print an empty HTML input...' );
-			$html .= $this->html_input( '' );    // Will print an empty <input>.
-			$count ++;
-		}
-
-		// If cardinality allows it, print button to add new values.
-		$html .= $this->get_add_button_html( $count );
-
-		// Close the HTML wrapper.
-		$html .= $this->html_wrapper_close();
-
-		return $html;
-	}
-
-	/**
-	 * Print the heading with the label for the metabox.
-	 *
-	 * @since 3.15.0
-	 * @return string The heading html fragment.
-	 */
-	protected function get_heading_html() {
-
-		return "<h3>$this->label</h3>";
-	}
-
-	/**
-	 * Print the stored values.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int $count An output value: the number of printed values.
-	 *
-	 * @return string The html fragment.
-	 */
-	protected function get_stored_values_html( &$count ) {
-
-		$html = '';
-
-		// print data loaded from DB.
-		$count = 0;
-		if ( $this->data ) {
-			foreach ( $this->data as $value ) {
-				if ( $count < $this->cardinality ) {
-					$this->log->debug( "Going to print an HTML input #$count with $value..." );
-					$fragment = $this->html_input( $value );
-
-					// If the fragment is empty, continue to the next one. This is necessary because the
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access protected
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    protected $log;
+
+    /**
+     * The meta name for this field's value.
+     *
+     * @var string $meta_name The meta name for this field's value.
+     */
+    public $meta_name;
+
+    /**
+     * The custom field settings.
+     *
+     * @var null|array $raw_custom_field The custom field settings.
+     */
+    public $raw_custom_field;
+
+    /**
+     * The schema.org predicate.
+     *
+     * @var string $predicate The schema.org predicate.
+     */
+    public $predicate;
+
+    /**
+     * The field's label.
+     *
+     * @var string $label The field's label.
+     */
+    public $label;
+
+    /**
+     * The WordLift data type.
+     *
+     * @var string $expected_wl_type The WordLift data type.
+     */
+    public $expected_wl_type;
+
+    /**
+     * The RDF data type.
+     *
+     * @var string $expected_uri_type The RDF data type.
+     */
+    public $expected_uri_type;
+
+    /**
+     * The cardinality.
+     *
+     * @var int $cardinality The cardinality.
+     */
+    public $cardinality;
+
+    /**
+     * The current value.
+     *
+     * @var array $data The current value.
+     */
+    public $data;
+
+    /**
+     * The current {@link WP_Post} id.
+     *
+     * @since 3.15.3
+     *
+     * @var int The current {@link WP_Post} id.
+     */
+    private $post_id;
+
+    /**
+     * Create a {@link WL_Metabox_Field} instance.
+     *
+     * @param array $args An array of parameters.
+     */
+    public function __construct( $args ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'WL_Metabox_Field' );
+
+        if ( empty( $args ) ) {
+            return;
+        }
+
+        // Save a copy of the custom field's params.
+        $this->raw_custom_field = reset( $args );
+
+        // Extract meta name (post_meta key for the DB).
+        $this->meta_name = key( $args );
+
+        // Extract linked data predicate.
+        if ( isset( $this->raw_custom_field['predicate'] ) ) {
+            $this->predicate = $this->raw_custom_field['predicate'];
+        } else {
+            return;
+        }
+
+        // Extract human readable label.
+        $exploded_predicate = explode( '/', $this->predicate );
+
+        // Use the label defined for the property if set, otherwise the last part of the schema.org/xyz predicate.
+        $this->label = isset( $this->raw_custom_field['metabox']['label'] ) ? $this->raw_custom_field['metabox']['label'] : end( $exploded_predicate );
+
+        // Extract field constraints (numerosity, expected type).
+        // Default constaints: accept one string..
+        if ( isset( $this->raw_custom_field['type'] ) ) {
+            $this->expected_wl_type = $this->raw_custom_field['type'];
+        } else {
+            $this->expected_wl_type = Wordlift_Schema_Service::DATA_TYPE_STRING;
+        }
+
+        $this->cardinality = 1;
+        if ( isset( $this->raw_custom_field['constraints'] ) ) {
+
+            $constraints = $this->raw_custom_field['constraints'];
+
+            // Extract cardinality.
+            if ( isset( $constraints['cardinality'] ) ) {
+                $this->cardinality = $constraints['cardinality'];
+            }
+
+            // Which type of entity can we accept (e.g. Place, Event, ecc.)? .
+            if ( Wordlift_Schema_Service::DATA_TYPE_URI === $this->expected_wl_type && isset( $constraints['uri_type'] ) ) {
+                $this->expected_uri_type = is_array( $constraints['uri_type'] )
+                    ? $constraints['uri_type']
+                    : array( $constraints['uri_type'] );
+            }
+        }
+
+        // Save early the post id to avoid other plugins messing up with it.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/665.
+        $this->post_id = get_the_ID();
+
+    }
+
+    /**
+     * Return nonce HTML.
+     *
+     * Overwrite this method in a child class to obtain custom behaviour.
+     */
+    public function html_nonce() {
+
+        return wp_nonce_field( 'wordlift_' . $this->meta_name . '_entity_box', 'wordlift_' . $this->meta_name . '_entity_box_nonce', true, false );
+    }
+
+    /**
+     * Verify nonce.
+     *
+     * Overwrite this method in a child class to obtain custom behaviour.
+     *
+     * @return boolean Nonce verification.
+     */
+    public function verify_nonce() {
+
+        $nonce_name   = 'wordlift_' . $this->meta_name . '_entity_box_nonce';
+        $nonce_verify = 'wordlift_' . $this->meta_name . '_entity_box';
+
+        if ( ! isset( $_POST[ $nonce_name ] ) ) {
+            return false;
+        }
+
+        // Verify that the nonce is valid.
+        return wp_verify_nonce( $_POST[ $nonce_name ], $nonce_verify );
+    }
+
+    /**
+     * Load data from DB and store the resulting array in $this->data.
+     *
+     * Overwrite this method in a child class to obtain custom behaviour.
+     */
+    public function get_data() {
+
+        // Get the post id and load the data.
+        $post_id    = $this->post_id;
+        $this->data = get_post_meta( $post_id, $this->meta_name );
+
+        $this->log->debug( 'Found ' . count( $this->data ) . " value(s) for meta $this->meta_name, post $post_id." );
+
+    }
+
+    /**
+     * Sanitizes data before saving to DB. Default sanitization trashes empty
+     * values.
+     *
+     * Stores the sanitized values into $this->data so they can be later processed.
+     * Overwrite this method in a child class to obtain custom behaviour.
+     *
+     * @param array $values Array of values to be sanitized and then stored into
+     *                      $this->data.
+     */
+    public function sanitize_data( $values ) {
+
+        $sanitized_data = array();
+
+        if ( ! is_array( $values ) ) {
+            $values = array( $values );
+        }
+
+        foreach ( $values as $value ) {
+            $sanitized_value = $this->sanitize_data_filter( $value );
+            if ( ! is_null( $sanitized_value ) ) {
+                $sanitized_data[] = $sanitized_value;
+            }
+        }
+
+        $this->data = $sanitized_data;
+    }
+
+    /**
+     * Sanitize a single value. Called from $this->sanitize_data. Default
+     * sanitization excludes empty values.
+     *
+     * Overwrite this method in a child class to obtain custom behaviour.
+     *
+     * @param string $value The value to sanitize.
+     *
+     * @return mixed Returns sanitized value, or null.
+     */
+    public function sanitize_data_filter( $value ) {
+
+        // TODO: all fields should provide their own sanitize which shouldn't
+        // be part of a UI class.
+
+        // If the field provides its own validation, use it.
+        if ( isset( $this->raw_custom_field['sanitize'] ) ) {
+            return call_user_func( $this->raw_custom_field['sanitize'], $value );
+        }
+
+        if ( ! is_null( $value ) && '' !== $value ) {         // do not use 'empty()' -> https://www.virendrachandak.com/techtalk/php-isset-vs-empty-vs-is_null/ .
+            return $value;
+        }
+
+        return null;
+    }
+
+    /**
+     * Save data to DB.
+     *
+     * Overwrite this method in a child class to obtain custom behaviour.
+     *
+     * @param array $values Array of values to be sanitized and then stored into $this->data.
+     */
+    public function save_data( $values ) {
+
+        // Will sanitize data and store them in $field->data.
+        $this->sanitize_data( $values );
+
+        // Bail out, if the post id isn't set in the request or isn't numeric.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/665.
+        if ( ! isset( $_POST['post_ID'] ) || ! is_numeric( $_POST['post_ID'] ) ) {
+            return;
+        }
+
+        $entity_id = intval( $_POST['post_ID'] );
+
+        // Take away old values.
+        delete_post_meta( $entity_id, $this->meta_name );
+
+        // insert new values, respecting cardinality.
+        $single = ( 1 === $this->cardinality );
+        foreach ( $this->data as $value ) {
+            $this->log->trace( "Saving $value to $this->meta_name for entity $entity_id..." );
+            $meta_id = add_post_meta( $entity_id, $this->meta_name, $value, $single );
+            $this->log->debug( "$value to $this->meta_name for entity $entity_id saved with id $meta_id." );
+        }
+    }
+
+    /**
+     * Returns the HTML tag that will contain the Field. By default the we
+     * return a <div> with data- attributes on cardinality and expected types.
+     *
+     * It is useful to provide data- attributes for the JS scripts.
+     *
+     * Overwrite this method in a child class to obtain custom behaviour.
+     */
+    public function html_wrapper_open() {
+
+        return "<div class='wl-field' data-cardinality='$this->cardinality'>";
+    }
+
+    /**
+     * Returns Field HTML (nonce included).
+     *
+     * Overwrite this method (or methods called from this method) in a child
+     * class to obtain custom behaviour.
+     *
+     * The HTML fragment includes the following parts:
+     * * html wrapper open.
+     * * heading.
+     * * nonce.
+     * * stored values.
+     * * an empty input when there are no stored values.
+     * * an add button to add more values.
+     * * html wrapper close.
+     */
+    public function html() {
+
+        // Open main <div> for the Field.
+        $html = $this->html_wrapper_open();
+
+        // Label.
+        $html .= $this->get_heading_html();
+
+        // print nonce.
+        $html .= $this->html_nonce();
+
+        // print data loaded from DB.
+        $count = 0;
+        $html  .= $this->get_stored_values_html( $count );
+
+        // Print the empty <input> to add new values.
+        if ( 0 === $count ) { // } || $count < $this->cardinality ) { DO NOT print empty inputs unless requested by the editor since fields might support empty strings.
+            $this->log->debug( 'Going to print an empty HTML input...' );
+            $html .= $this->html_input( '' );    // Will print an empty <input>.
+            $count ++;
+        }
+
+        // If cardinality allows it, print button to add new values.
+        $html .= $this->get_add_button_html( $count );
+
+        // Close the HTML wrapper.
+        $html .= $this->html_wrapper_close();
+
+        return $html;
+    }
+
+    /**
+     * Print the heading with the label for the metabox.
+     *
+     * @since 3.15.0
+     * @return string The heading html fragment.
+     */
+    protected function get_heading_html() {
+
+        return "<h3>$this->label</h3>";
+    }
+
+    /**
+     * Print the stored values.
+     *
+     * @since 3.15.0
+     *
+     * @param int $count An output value: the number of printed values.
+     *
+     * @return string The html fragment.
+     */
+    protected function get_stored_values_html( &$count ) {
+
+        $html = '';
+
+        // print data loaded from DB.
+        $count = 0;
+        if ( $this->data ) {
+            foreach ( $this->data as $value ) {
+                if ( $count < $this->cardinality ) {
+                    $this->log->debug( "Going to print an HTML input #$count with $value..." );
+                    $fragment = $this->html_input( $value );
+
+                    // If the fragment is empty, continue to the next one. This is necessary because the
                     // metabox may reference an invalid value which would cause the metabox not to print,
                     // returning an empty html fragment.
                     //
                     // See https://github.com/insideout10/wordlift-plugin/issues/818
-					if ( '' === $fragment ) {
-						continue;
-					}
-
-					$html .= $fragment;
-					$count ++;
-				}
-			}
-		}
-
-		return $html;
-	}
-
-	/**
-	 * Get the add button html.
-	 *
-	 * This function is protected, allowing extending class to further customize
-	 * the add button html code.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param int $count The current number of values.
-	 *
-	 * @return string The add button html code.
-	 */
-	protected function get_add_button_html( $count ) {
-
-		// If cardinality allows it, print button to add new values.
-		if ( $count < $this->cardinality ) {
-			return '<button class="button wl-add-input wl-button" type="button">' . esc_html__( 'Add' ) . '</button>';
-		}
-
-		// Return an empty string.
-		return '';
-	}
-
-	/**
-	 * Return a single <input> tag for the Field.
-	 *
-	 * @param mixed $value Input value.
-	 *
-	 * @return string The html code fragment.
-	 */
-	public function html_input( $value ) {
-		@ob_start();
-		?>
+                    if ( '' === $fragment ) {
+                        continue;
+                    }
+
+                    $html .= $fragment;
+                    $count ++;
+                }
+            }
+        }
+
+        return $html;
+    }
+
+    /**
+     * Get the add button html.
+     *
+     * This function is protected, allowing extending class to further customize
+     * the add button html code.
+     *
+     * @since 3.15.0
+     *
+     * @param int $count The current number of values.
+     *
+     * @return string The add button html code.
+     */
+    protected function get_add_button_html( $count ) {
+
+        // If cardinality allows it, print button to add new values.
+        if ( $count < $this->cardinality ) {
+            return '<button class="button wl-add-input wl-button" type="button">' . esc_html__( 'Add' ) . '</button>';
+        }
+
+        // Return an empty string.
+        return '';
+    }
+
+    /**
+     * Return a single <input> tag for the Field.
+     *
+     * @param mixed $value Input value.
+     *
+     * @return string The html code fragment.
+     */
+    public function html_input( $value ) {
+        @ob_start();
+        ?>
         <div class="wl-input-wrapper">
             <input
                     type="text"
@@ -447,17 +447,17 @@ 
             </button>
         </div>
 		<?php
-		$html = ob_get_clean();
+        $html = ob_get_clean();
 
-		return $html;
-	}
+        return $html;
+    }
 
-	/**
-	 * Returns closing for the wrapper HTML tag.
-	 */
-	public function html_wrapper_close() {
+    /**
+     * Returns closing for the wrapper HTML tag.
+     */
+    public function html_wrapper_close() {
 
-		return '</div><hr>';
-	}
+        return '</div><hr>';
+    }
 
 }

Spacing +62 added lines, -62 removed lines

@@ -98,56 +98,56 @@ 
 	 *
 	 * @param array $args An array of parameters.
 	 */
-	public function __construct( $args ) {
+	public function __construct($args) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'WL_Metabox_Field' );
+		$this->log = Wordlift_Log_Service::get_logger('WL_Metabox_Field');
 
-		if ( empty( $args ) ) {
+		if (empty($args)) {
 			return;
 		}
 
 		// Save a copy of the custom field's params.
-		$this->raw_custom_field = reset( $args );
+		$this->raw_custom_field = reset($args);
 
 		// Extract meta name (post_meta key for the DB).
-		$this->meta_name = key( $args );
+		$this->meta_name = key($args);
 
 		// Extract linked data predicate.
-		if ( isset( $this->raw_custom_field['predicate'] ) ) {
+		if (isset($this->raw_custom_field['predicate'])) {
 			$this->predicate = $this->raw_custom_field['predicate'];
 		} else {
 			return;
 		}
 
 		// Extract human readable label.
-		$exploded_predicate = explode( '/', $this->predicate );
+		$exploded_predicate = explode('/', $this->predicate);
 
 		// Use the label defined for the property if set, otherwise the last part of the schema.org/xyz predicate.
-		$this->label = isset( $this->raw_custom_field['metabox']['label'] ) ? $this->raw_custom_field['metabox']['label'] : end( $exploded_predicate );
+		$this->label = isset($this->raw_custom_field['metabox']['label']) ? $this->raw_custom_field['metabox']['label'] : end($exploded_predicate);
 
 		// Extract field constraints (numerosity, expected type).
 		// Default constaints: accept one string..
-		if ( isset( $this->raw_custom_field['type'] ) ) {
+		if (isset($this->raw_custom_field['type'])) {
 			$this->expected_wl_type = $this->raw_custom_field['type'];
 		} else {
 			$this->expected_wl_type = Wordlift_Schema_Service::DATA_TYPE_STRING;
 		}
 
 		$this->cardinality = 1;
-		if ( isset( $this->raw_custom_field['constraints'] ) ) {
+		if (isset($this->raw_custom_field['constraints'])) {
 
 			$constraints = $this->raw_custom_field['constraints'];
 
 			// Extract cardinality.
-			if ( isset( $constraints['cardinality'] ) ) {
+			if (isset($constraints['cardinality'])) {
 				$this->cardinality = $constraints['cardinality'];
 			}
 
 			// Which type of entity can we accept (e.g. Place, Event, ecc.)? .
-			if ( Wordlift_Schema_Service::DATA_TYPE_URI === $this->expected_wl_type && isset( $constraints['uri_type'] ) ) {
-				$this->expected_uri_type = is_array( $constraints['uri_type'] )
+			if (Wordlift_Schema_Service::DATA_TYPE_URI === $this->expected_wl_type && isset($constraints['uri_type'])) {
+				$this->expected_uri_type = is_array($constraints['uri_type'])
 					? $constraints['uri_type']
-					: array( $constraints['uri_type'] );
+					: array($constraints['uri_type']);
 			}
 		}
 
@@ -165,7 +165,7 @@ 
 	 */
 	public function html_nonce() {
 
-		return wp_nonce_field( 'wordlift_' . $this->meta_name . '_entity_box', 'wordlift_' . $this->meta_name . '_entity_box_nonce', true, false );
+		return wp_nonce_field('wordlift_'.$this->meta_name.'_entity_box', 'wordlift_'.$this->meta_name.'_entity_box_nonce', true, false);
 	}
 
 	/**
@@ -177,15 +177,15 @@ 
 	 */
 	public function verify_nonce() {
 
-		$nonce_name   = 'wordlift_' . $this->meta_name . '_entity_box_nonce';
-		$nonce_verify = 'wordlift_' . $this->meta_name . '_entity_box';
+		$nonce_name   = 'wordlift_'.$this->meta_name.'_entity_box_nonce';
+		$nonce_verify = 'wordlift_'.$this->meta_name.'_entity_box';
 
-		if ( ! isset( $_POST[ $nonce_name ] ) ) {
+		if ( ! isset($_POST[$nonce_name])) {
 			return false;
 		}
 
 		// Verify that the nonce is valid.
-		return wp_verify_nonce( $_POST[ $nonce_name ], $nonce_verify );
+		return wp_verify_nonce($_POST[$nonce_name], $nonce_verify);
 	}
 
 	/**
@@ -197,9 +197,9 @@ 
 
 		// Get the post id and load the data.
 		$post_id    = $this->post_id;
-		$this->data = get_post_meta( $post_id, $this->meta_name );
+		$this->data = get_post_meta($post_id, $this->meta_name);
 
-		$this->log->debug( 'Found ' . count( $this->data ) . " value(s) for meta $this->meta_name, post $post_id." );
+		$this->log->debug('Found '.count($this->data)." value(s) for meta $this->meta_name, post $post_id.");
 
 	}
 
@@ -213,17 +213,17 @@ 
 	 * @param array $values Array of values to be sanitized and then stored into
 	 *                      $this->data.
 	 */
-	public function sanitize_data( $values ) {
+	public function sanitize_data($values) {
 
 		$sanitized_data = array();
 
-		if ( ! is_array( $values ) ) {
-			$values = array( $values );
+		if ( ! is_array($values)) {
+			$values = array($values);
 		}
 
-		foreach ( $values as $value ) {
-			$sanitized_value = $this->sanitize_data_filter( $value );
-			if ( ! is_null( $sanitized_value ) ) {
+		foreach ($values as $value) {
+			$sanitized_value = $this->sanitize_data_filter($value);
+			if ( ! is_null($sanitized_value)) {
 				$sanitized_data[] = $sanitized_value;
 			}
 		}
@@ -241,17 +241,17 @@ 
 	 *
 	 * @return mixed Returns sanitized value, or null.
 	 */
-	public function sanitize_data_filter( $value ) {
+	public function sanitize_data_filter($value) {
 
 		// TODO: all fields should provide their own sanitize which shouldn't
 		// be part of a UI class.
 
 		// If the field provides its own validation, use it.
-		if ( isset( $this->raw_custom_field['sanitize'] ) ) {
-			return call_user_func( $this->raw_custom_field['sanitize'], $value );
+		if (isset($this->raw_custom_field['sanitize'])) {
+			return call_user_func($this->raw_custom_field['sanitize'], $value);
 		}
 
-		if ( ! is_null( $value ) && '' !== $value ) {         // do not use 'empty()' -> https://www.virendrachandak.com/techtalk/php-isset-vs-empty-vs-is_null/ .
+		if ( ! is_null($value) && '' !== $value) {         // do not use 'empty()' -> https://www.virendrachandak.com/techtalk/php-isset-vs-empty-vs-is_null/ .
 			return $value;
 		}
 
@@ -265,29 +265,29 @@ 
 	 *
 	 * @param array $values Array of values to be sanitized and then stored into $this->data.
 	 */
-	public function save_data( $values ) {
+	public function save_data($values) {
 
 		// Will sanitize data and store them in $field->data.
-		$this->sanitize_data( $values );
+		$this->sanitize_data($values);
 
 		// Bail out, if the post id isn't set in the request or isn't numeric.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/665.
-		if ( ! isset( $_POST['post_ID'] ) || ! is_numeric( $_POST['post_ID'] ) ) {
+		if ( ! isset($_POST['post_ID']) || ! is_numeric($_POST['post_ID'])) {
 			return;
 		}
 
-		$entity_id = intval( $_POST['post_ID'] );
+		$entity_id = intval($_POST['post_ID']);
 
 		// Take away old values.
-		delete_post_meta( $entity_id, $this->meta_name );
+		delete_post_meta($entity_id, $this->meta_name);
 
 		// insert new values, respecting cardinality.
-		$single = ( 1 === $this->cardinality );
-		foreach ( $this->data as $value ) {
-			$this->log->trace( "Saving $value to $this->meta_name for entity $entity_id..." );
-			$meta_id = add_post_meta( $entity_id, $this->meta_name, $value, $single );
-			$this->log->debug( "$value to $this->meta_name for entity $entity_id saved with id $meta_id." );
+		$single = (1 === $this->cardinality);
+		foreach ($this->data as $value) {
+			$this->log->trace("Saving $value to $this->meta_name for entity $entity_id...");
+			$meta_id = add_post_meta($entity_id, $this->meta_name, $value, $single);
+			$this->log->debug("$value to $this->meta_name for entity $entity_id saved with id $meta_id.");
 		}
 	}
 
@@ -332,17 +332,17 @@ 
 
 		// print data loaded from DB.
 		$count = 0;
-		$html  .= $this->get_stored_values_html( $count );
+		$html .= $this->get_stored_values_html($count);
 
 		// Print the empty <input> to add new values.
-		if ( 0 === $count ) { // } || $count < $this->cardinality ) { DO NOT print empty inputs unless requested by the editor since fields might support empty strings.
-			$this->log->debug( 'Going to print an empty HTML input...' );
-			$html .= $this->html_input( '' );    // Will print an empty <input>.
-			$count ++;
+		if (0 === $count) { // } || $count < $this->cardinality ) { DO NOT print empty inputs unless requested by the editor since fields might support empty strings.
+			$this->log->debug('Going to print an empty HTML input...');
+			$html .= $this->html_input(''); // Will print an empty <input>.
+			$count++;
 		}
 
 		// If cardinality allows it, print button to add new values.
-		$html .= $this->get_add_button_html( $count );
+		$html .= $this->get_add_button_html($count);
 
 		// Close the HTML wrapper.
 		$html .= $this->html_wrapper_close();
@@ -370,29 +370,29 @@ 
 	 *
 	 * @return string The html fragment.
 	 */
-	protected function get_stored_values_html( &$count ) {
+	protected function get_stored_values_html(&$count) {
 
 		$html = '';
 
 		// print data loaded from DB.
 		$count = 0;
-		if ( $this->data ) {
-			foreach ( $this->data as $value ) {
-				if ( $count < $this->cardinality ) {
-					$this->log->debug( "Going to print an HTML input #$count with $value..." );
-					$fragment = $this->html_input( $value );
+		if ($this->data) {
+			foreach ($this->data as $value) {
+				if ($count < $this->cardinality) {
+					$this->log->debug("Going to print an HTML input #$count with $value...");
+					$fragment = $this->html_input($value);
 
 					// If the fragment is empty, continue to the next one. This is necessary because the
                     // metabox may reference an invalid value which would cause the metabox not to print,
                     // returning an empty html fragment.
                     //
                     // See https://github.com/insideout10/wordlift-plugin/issues/818
-					if ( '' === $fragment ) {
+					if ('' === $fragment) {
 						continue;
 					}
 
 					$html .= $fragment;
-					$count ++;
+					$count++;
 				}
 			}
 		}
@@ -412,11 +412,11 @@ 
 	 *
 	 * @return string The add button html code.
 	 */
-	protected function get_add_button_html( $count ) {
+	protected function get_add_button_html($count) {
 
 		// If cardinality allows it, print button to add new values.
-		if ( $count < $this->cardinality ) {
-			return '<button class="button wl-add-input wl-button" type="button">' . esc_html__( 'Add' ) . '</button>';
+		if ($count < $this->cardinality) {
+			return '<button class="button wl-add-input wl-button" type="button">'.esc_html__('Add').'</button>';
 		}
 
 		// Return an empty string.
@@ -430,20 +430,20 @@ 
 	 *
 	 * @return string The html code fragment.
 	 */
-	public function html_input( $value ) {
+	public function html_input($value) {
 		@ob_start();
 		?>
         <div class="wl-input-wrapper">
             <input
                     type="text"
-                    id="<?php echo esc_attr( $this->meta_name ); ?>"
+                    id="<?php echo esc_attr($this->meta_name); ?>"
                     name="wl_metaboxes[<?php echo $this->meta_name ?>][]"
-                    value="<?php echo esc_attr( $value ); ?>"
+                    value="<?php echo esc_attr($value); ?>"
                     style="width:88%"
             />
 
             <button class="button wl-remove-input wl-button" type="button">
-				<?php esc_html_e( 'Remove', 'wordlift' ); ?>
+				<?php esc_html_e('Remove', 'wordlift'); ?>
             </button>
         </div>
 		<?php

src/admin/WL_Metabox/class-wl-metabox-field-uri.php

Indentation +143 added lines, -143 removed lines

@@ -16,146 +16,146 @@ 
  */
 class WL_Metabox_Field_uri extends WL_Metabox_Field {
 
-	/**
-	 * Only accept URIs or local entity IDs.
-	 * Build new entity if the user inputted a name that is not present in DB.
-	 *
-	 * @param mixed $value The value to sanitize.
-	 *
-	 * @return int|mixed|WP_Error
-	 */
-	public function sanitize_data_filter( $value ) {
-
-		if ( empty( $value ) ) {
-			return null;
-		}
-
-		// Check that the inserted URI, ID or name does not point to a saved
-		// entity or when the editor types a string in the input box, we try to
-		// find an entity with that title and, if not found, we create that entity.
-		$absent_from_db = is_numeric( $value )
-			? is_null( get_post( $value ) )
-			: ! $this->exists( $value );
-
-		// Is it an URI?
-		$name_is_uri = strpos( $value, 'http' ) === 0;
-
-		// We create a new entity only if the entity is not present in the DB.
-		// In the case of an external uri, we just save the uri.
-		if ( $absent_from_db && ! $name_is_uri ) {
-
-			// ...we create a new entity!
-			$new_entity_id = wp_insert_post( array(
-				'post_status' => 'publish',
-				'post_type'   => Wordlift_Entity_Service::TYPE_NAME,
-				'post_title'  => $value,
-			) );
-
-			$type = 'http://schema.org/' . ( isset( $this->expected_uri_type ) ? $this->expected_uri_type[0] : 'Thing' );
-
-			wl_set_entity_main_type( $new_entity_id, $type );
-
-			// Build uri for this entity.
-			$new_uri = wl_build_entity_uri( $new_entity_id );
-			wl_set_entity_uri( $new_entity_id, $new_uri );
-
-			Wordlift_Linked_Data_Service::get_instance()->push( $new_entity_id );
-
-			// Update the value that will be saved as meta.
-			$value = $new_entity_id;
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Check whether an entity exists given a value.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @param string $value An entity URI or a title string..
-	 *
-	 * @return bool True if the entity exists otherwise false.
-	 */
-	private function exists( $value ) {
-
-		// When the editor types a string in the input box, we try to find
-		// an entity with that title and, if not found, we create that entity.
-		$entity_service = Wordlift_Entity_Service::get_instance();
-
-		// Try looking for an entity by URI.
-		$found_by_uri = null !== $entity_service->get_entity_post_by_uri( $value );
-
-		// Return true if found.
-		if ( $found_by_uri ) {
-			$this->log->debug( "Found entity for $value." );
-
-			return true;
-		}
-
-		// Try looking for an entity by title, get any potential candidate.
-		$candidate = get_page_by_title( $value, OBJECT, Wordlift_Entity_Service::valid_entity_post_types() );
-
-		// If a candidate has been found and it's an entity.
-		return null !== $candidate && $entity_service->is_entity( $candidate->ID );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function html_wrapper_open() {
-
-		// The containing <div> contains info on cardinality and expected types.
-		$html = "<div class='wl-field' data-cardinality='$this->cardinality'";
-
-		if ( isset( $this->expected_uri_type ) && ! is_null( $this->expected_uri_type ) ) {
-
-			if ( is_array( $this->expected_uri_type ) ) {
-				$html .= " data-expected-types='" . implode( ',', $this->expected_uri_type ) . "'";
-			} else {
-				$html .= " data-expected-types='$this->expected_uri_type'";
-			}
-		}
-
-		$html .= '>';
-
-		return $html;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function html_input( $default_entity_identifier ) {
-
-		if ( empty( $default_entity_identifier ) ) {
-			$entity = null;
-		} elseif ( is_numeric( $default_entity_identifier ) ) {
-			$entity = get_post( $default_entity_identifier );
-		} else {
-			// @todo: we cannot be so sure this is a URI.
-			// It is an URI
-			$entity = Wordlift_Entity_Service
-				::get_instance()
-				->get_entity_post_by_uri( $default_entity_identifier );
-		}
-
-		// Bail out if an entity id has been provided by the entity is not found.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/818
-		if ( ! empty( $default_entity_identifier ) && is_null( $entity ) ) {
-			return '';
-		}
-
-		$label = is_null( $entity ) ? '' : $entity->post_title;
-		$value = is_null( $entity ) ? '' : $entity->ID;
-
-		// Write saved value in page
-		// The <input> tags host the meta value.
-		// The visible <input> has the human readable value (i.e. entity name or uri)
-		// and is accompained by an hidden <input> tag, passed to the server,
-		// that contains the raw value (i.e. the uri or entity id).
-		@ob_start();
-		?>
+    /**
+     * Only accept URIs or local entity IDs.
+     * Build new entity if the user inputted a name that is not present in DB.
+     *
+     * @param mixed $value The value to sanitize.
+     *
+     * @return int|mixed|WP_Error
+     */
+    public function sanitize_data_filter( $value ) {
+
+        if ( empty( $value ) ) {
+            return null;
+        }
+
+        // Check that the inserted URI, ID or name does not point to a saved
+        // entity or when the editor types a string in the input box, we try to
+        // find an entity with that title and, if not found, we create that entity.
+        $absent_from_db = is_numeric( $value )
+            ? is_null( get_post( $value ) )
+            : ! $this->exists( $value );
+
+        // Is it an URI?
+        $name_is_uri = strpos( $value, 'http' ) === 0;
+
+        // We create a new entity only if the entity is not present in the DB.
+        // In the case of an external uri, we just save the uri.
+        if ( $absent_from_db && ! $name_is_uri ) {
+
+            // ...we create a new entity!
+            $new_entity_id = wp_insert_post( array(
+                'post_status' => 'publish',
+                'post_type'   => Wordlift_Entity_Service::TYPE_NAME,
+                'post_title'  => $value,
+            ) );
+
+            $type = 'http://schema.org/' . ( isset( $this->expected_uri_type ) ? $this->expected_uri_type[0] : 'Thing' );
+
+            wl_set_entity_main_type( $new_entity_id, $type );
+
+            // Build uri for this entity.
+            $new_uri = wl_build_entity_uri( $new_entity_id );
+            wl_set_entity_uri( $new_entity_id, $new_uri );
+
+            Wordlift_Linked_Data_Service::get_instance()->push( $new_entity_id );
+
+            // Update the value that will be saved as meta.
+            $value = $new_entity_id;
+        }
+
+        return $value;
+    }
+
+    /**
+     * Check whether an entity exists given a value.
+     *
+     * @since 3.15.0
+     *
+     * @param string $value An entity URI or a title string..
+     *
+     * @return bool True if the entity exists otherwise false.
+     */
+    private function exists( $value ) {
+
+        // When the editor types a string in the input box, we try to find
+        // an entity with that title and, if not found, we create that entity.
+        $entity_service = Wordlift_Entity_Service::get_instance();
+
+        // Try looking for an entity by URI.
+        $found_by_uri = null !== $entity_service->get_entity_post_by_uri( $value );
+
+        // Return true if found.
+        if ( $found_by_uri ) {
+            $this->log->debug( "Found entity for $value." );
+
+            return true;
+        }
+
+        // Try looking for an entity by title, get any potential candidate.
+        $candidate = get_page_by_title( $value, OBJECT, Wordlift_Entity_Service::valid_entity_post_types() );
+
+        // If a candidate has been found and it's an entity.
+        return null !== $candidate && $entity_service->is_entity( $candidate->ID );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function html_wrapper_open() {
+
+        // The containing <div> contains info on cardinality and expected types.
+        $html = "<div class='wl-field' data-cardinality='$this->cardinality'";
+
+        if ( isset( $this->expected_uri_type ) && ! is_null( $this->expected_uri_type ) ) {
+
+            if ( is_array( $this->expected_uri_type ) ) {
+                $html .= " data-expected-types='" . implode( ',', $this->expected_uri_type ) . "'";
+            } else {
+                $html .= " data-expected-types='$this->expected_uri_type'";
+            }
+        }
+
+        $html .= '>';
+
+        return $html;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function html_input( $default_entity_identifier ) {
+
+        if ( empty( $default_entity_identifier ) ) {
+            $entity = null;
+        } elseif ( is_numeric( $default_entity_identifier ) ) {
+            $entity = get_post( $default_entity_identifier );
+        } else {
+            // @todo: we cannot be so sure this is a URI.
+            // It is an URI
+            $entity = Wordlift_Entity_Service
+                ::get_instance()
+                ->get_entity_post_by_uri( $default_entity_identifier );
+        }
+
+        // Bail out if an entity id has been provided by the entity is not found.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/818
+        if ( ! empty( $default_entity_identifier ) && is_null( $entity ) ) {
+            return '';
+        }
+
+        $label = is_null( $entity ) ? '' : $entity->post_title;
+        $value = is_null( $entity ) ? '' : $entity->ID;
+
+        // Write saved value in page
+        // The <input> tags host the meta value.
+        // The visible <input> has the human readable value (i.e. entity name or uri)
+        // and is accompained by an hidden <input> tag, passed to the server,
+        // that contains the raw value (i.e. the uri or entity id).
+        @ob_start();
+        ?>
         <div class="wl-input-wrapper wl-autocomplete-wrapper">
             <input
                     type="text"
@@ -177,9 +177,9 @@ 
             <div class="wl-input-notice"></div>
         </div>
 		<?php
-		$html = ob_get_clean();
+        $html = ob_get_clean();
 
-		return $html;
-	}
+        return $html;
+    }
 
 }

Spacing +36 added lines, -36 removed lines

@@ -24,42 +24,42 @@ 
 	 *
 	 * @return int|mixed|WP_Error
 	 */
-	public function sanitize_data_filter( $value ) {
+	public function sanitize_data_filter($value) {
 
-		if ( empty( $value ) ) {
+		if (empty($value)) {
 			return null;
 		}
 
 		// Check that the inserted URI, ID or name does not point to a saved
 		// entity or when the editor types a string in the input box, we try to
 		// find an entity with that title and, if not found, we create that entity.
-		$absent_from_db = is_numeric( $value )
-			? is_null( get_post( $value ) )
-			: ! $this->exists( $value );
+		$absent_from_db = is_numeric($value)
+			? is_null(get_post($value))
+			: ! $this->exists($value);
 
 		// Is it an URI?
-		$name_is_uri = strpos( $value, 'http' ) === 0;
+		$name_is_uri = strpos($value, 'http') === 0;
 
 		// We create a new entity only if the entity is not present in the DB.
 		// In the case of an external uri, we just save the uri.
-		if ( $absent_from_db && ! $name_is_uri ) {
+		if ($absent_from_db && ! $name_is_uri) {
 
 			// ...we create a new entity!
-			$new_entity_id = wp_insert_post( array(
+			$new_entity_id = wp_insert_post(array(
 				'post_status' => 'publish',
 				'post_type'   => Wordlift_Entity_Service::TYPE_NAME,
 				'post_title'  => $value,
-			) );
+			));
 
-			$type = 'http://schema.org/' . ( isset( $this->expected_uri_type ) ? $this->expected_uri_type[0] : 'Thing' );
+			$type = 'http://schema.org/'.(isset($this->expected_uri_type) ? $this->expected_uri_type[0] : 'Thing');
 
-			wl_set_entity_main_type( $new_entity_id, $type );
+			wl_set_entity_main_type($new_entity_id, $type);
 
 			// Build uri for this entity.
-			$new_uri = wl_build_entity_uri( $new_entity_id );
-			wl_set_entity_uri( $new_entity_id, $new_uri );
+			$new_uri = wl_build_entity_uri($new_entity_id);
+			wl_set_entity_uri($new_entity_id, $new_uri);
 
-			Wordlift_Linked_Data_Service::get_instance()->push( $new_entity_id );
+			Wordlift_Linked_Data_Service::get_instance()->push($new_entity_id);
 
 			// Update the value that will be saved as meta.
 			$value = $new_entity_id;
@@ -77,27 +77,27 @@ 
 	 *
 	 * @return bool True if the entity exists otherwise false.
 	 */
-	private function exists( $value ) {
+	private function exists($value) {
 
 		// When the editor types a string in the input box, we try to find
 		// an entity with that title and, if not found, we create that entity.
 		$entity_service = Wordlift_Entity_Service::get_instance();
 
 		// Try looking for an entity by URI.
-		$found_by_uri = null !== $entity_service->get_entity_post_by_uri( $value );
+		$found_by_uri = null !== $entity_service->get_entity_post_by_uri($value);
 
 		// Return true if found.
-		if ( $found_by_uri ) {
-			$this->log->debug( "Found entity for $value." );
+		if ($found_by_uri) {
+			$this->log->debug("Found entity for $value.");
 
 			return true;
 		}
 
 		// Try looking for an entity by title, get any potential candidate.
-		$candidate = get_page_by_title( $value, OBJECT, Wordlift_Entity_Service::valid_entity_post_types() );
+		$candidate = get_page_by_title($value, OBJECT, Wordlift_Entity_Service::valid_entity_post_types());
 
 		// If a candidate has been found and it's an entity.
-		return null !== $candidate && $entity_service->is_entity( $candidate->ID );
+		return null !== $candidate && $entity_service->is_entity($candidate->ID);
 	}
 
 	/**
@@ -108,10 +108,10 @@ 
 		// The containing <div> contains info on cardinality and expected types.
 		$html = "<div class='wl-field' data-cardinality='$this->cardinality'";
 
-		if ( isset( $this->expected_uri_type ) && ! is_null( $this->expected_uri_type ) ) {
+		if (isset($this->expected_uri_type) && ! is_null($this->expected_uri_type)) {
 
-			if ( is_array( $this->expected_uri_type ) ) {
-				$html .= " data-expected-types='" . implode( ',', $this->expected_uri_type ) . "'";
+			if (is_array($this->expected_uri_type)) {
+				$html .= " data-expected-types='".implode(',', $this->expected_uri_type)."'";
 			} else {
 				$html .= " data-expected-types='$this->expected_uri_type'";
 			}
@@ -125,29 +125,29 @@ 
 	/**
 	 * @inheritdoc
 	 */
-	public function html_input( $default_entity_identifier ) {
+	public function html_input($default_entity_identifier) {
 
-		if ( empty( $default_entity_identifier ) ) {
+		if (empty($default_entity_identifier)) {
 			$entity = null;
-		} elseif ( is_numeric( $default_entity_identifier ) ) {
-			$entity = get_post( $default_entity_identifier );
+		} elseif (is_numeric($default_entity_identifier)) {
+			$entity = get_post($default_entity_identifier);
 		} else {
 			// @todo: we cannot be so sure this is a URI.
 			// It is an URI
 			$entity = Wordlift_Entity_Service
 				::get_instance()
-				->get_entity_post_by_uri( $default_entity_identifier );
+				->get_entity_post_by_uri($default_entity_identifier);
 		}
 
 		// Bail out if an entity id has been provided by the entity is not found.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/818
-		if ( ! empty( $default_entity_identifier ) && is_null( $entity ) ) {
+		if ( ! empty($default_entity_identifier) && is_null($entity)) {
 			return '';
 		}
 
-		$label = is_null( $entity ) ? '' : $entity->post_title;
-		$value = is_null( $entity ) ? '' : $entity->ID;
+		$label = is_null($entity) ? '' : $entity->post_title;
+		$value = is_null($entity) ? '' : $entity->ID;
 
 		// Write saved value in page
 		// The <input> tags host the meta value.
@@ -159,19 +159,19 @@ 
         <div class="wl-input-wrapper wl-autocomplete-wrapper">
             <input
                     type="text"
-                    class="<?php echo esc_attr( $this->meta_name ); ?> wl-autocomplete"
-                    value="<?php echo esc_attr( $label ); ?>"
+                    class="<?php echo esc_attr($this->meta_name); ?> wl-autocomplete"
+                    value="<?php echo esc_attr($label); ?>"
                     style="width:88%"
             />
             <input
                     type="hidden"
-                    class="<?php echo esc_attr( $this->meta_name ); ?>"
+                    class="<?php echo esc_attr($this->meta_name); ?>"
                     name="wl_metaboxes[<?php echo $this->meta_name ?>][]"
-                    value="<?php echo esc_attr( $value ); ?>"
+                    value="<?php echo esc_attr($value); ?>"
             />
 
             <button class="button wl-remove-input wl-button" type="button">
-				<?php esc_html_e( 'Remove', 'wordlift' ); ?>
+				<?php esc_html_e('Remove', 'wordlift'); ?>
             </button>
 
             <div class="wl-input-notice"></div>

src/includes/wp-async-task/class-wordlift-async-task.php

Indentation +287 added lines, -287 removed lines

@@ -9,293 +9,293 @@
 
 abstract class Wordlift_Async_Task {
 
-	/**
-	 * Constant identifier for a task that should be available to logged-in users
-	 *
-	 * See constructor documentation for more details.
-	 */
-	const LOGGED_IN = 1;
-
-	/**
-	 * Constant identifier for a task that should be available to logged-out users
-	 *
-	 * See constructor documentation for more details.
-	 */
-	const LOGGED_OUT = 2;
-
-	/**
-	 * Constant identifier for a task that should be available to all users regardless of auth status
-	 *
-	 * See constructor documentation for more details.
-	 */
-	const BOTH = 3;
-
-	/**
-	 * This is the argument count for the main action set in the constructor. It
-	 * is set to an arbitrarily high value of twenty, but can be overridden if
-	 * necessary
-	 *
-	 * @var int
-	 */
-	protected $argument_count = 20;
-
-	/**
-	 * Priority to fire intermediate action.
-	 *
-	 * @var int
-	 */
-	protected $priority = 10;
-
-	/**
-	 * @var string
-	 */
-	protected $action;
-
-	/**
-	 * @var array
-	 */
-	protected $_body_data;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Constructor to wire up the necessary actions
-	 *
-	 * Which hooks the asynchronous postback happens on can be set by the
-	 * $auth_level parameter. There are essentially three options: logged in users
-	 * only, logged out users only, or both. Set this when you instantiate an
-	 * object by using one of the three class constants to do so:
-	 *  - LOGGED_IN
-	 *  - LOGGED_OUT
-	 *  - BOTH
-	 * $auth_level defaults to BOTH
-	 *
-	 * @throws Exception If the class' $action value hasn't been set
-	 *
-	 * @param int $auth_level The authentication level to use (see above)
-	 */
-	public function __construct( $auth_level = self::BOTH ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		if ( empty( $this->action ) ) {
-			throw new Exception( 'Action not defined for class ' . __CLASS__ );
-		}
-		add_action( $this->action, array(
-			$this,
-			'launch',
-		), (int) $this->priority, (int) $this->argument_count );
-		if ( $auth_level & self::LOGGED_IN ) {
-			add_action( "admin_post_wl_async_$this->action", array(
-				$this,
-				'handle_postback',
-			) );
-		}
-		if ( $auth_level & self::LOGGED_OUT ) {
-			add_action( "admin_post_nopriv_wl_async_$this->action", array(
-				$this,
-				'handle_postback',
-			) );
-		}
-	}
-
-	/**
-	 * Add the shutdown action for launching the real postback if we don't
-	 * get an exception thrown by prepare_data().
-	 *
-	 * @uses func_get_args() To grab any arguments passed by the action
-	 */
-	public function launch() {
-		$data = func_get_args();
-		try {
-			$data = $this->prepare_data( $data );
-		} catch ( Exception $e ) {
-			return;
-		}
-
-		$data['action'] = "wl_async_$this->action";
-		$data['_nonce'] = $this->create_async_nonce();
-
-		$this->_body_data = $data;
-
-		if ( ! has_action( 'shutdown', array(
-			$this,
-			'launch_on_shutdown',
-		) )
-		) {
-			add_action( 'shutdown', array( $this, 'launch_on_shutdown' ) );
-		}
-	}
-
-	/**
-	 * Launch the request on the WordPress shutdown hook
-	 *
-	 * On VIP we got into data races due to the postback sometimes completing
-	 * faster than the data could propogate to the database server cluster.
-	 * This made WordPress get empty data sets from the database without
-	 * failing. On their advice, we're moving the actual firing of the async
-	 * postback to the shutdown hook. Supposedly that will ensure that the
-	 * data at least has time to get into the object cache.
-	 *
-	 * @uses $_COOKIE        To send a cookie header for async postback
-	 * @uses apply_filters()
-	 * @uses admin_url()
-	 * @uses wp_remote_post()
-	 */
-	public function launch_on_shutdown() {
-
-		$this->log->debug( "Launching Async Task [ action :: $this->action ]..." );
-
-		if ( ! empty( $this->_body_data ) ) {
-			$cookies = array();
-			foreach ( $_COOKIE as $name => $value ) {
-				$cookies[] = "$name=" . urlencode( is_array( $value ) ? serialize( $value ) : $value );
-			}
-
-			$request_args = array(
-				'timeout'   => 0.01,
-				'blocking'  => false,
-				'sslverify' => apply_filters( 'https_local_ssl_verify', false ),
-				'body'      => $this->_body_data,
-				'headers'   => array(
-					'cookie' => implode( '; ', $cookies ),
-				),
-			);
-
-			$url = get_site_url( null, 'wl-api' );
-
-			$this->log->debug( "Posting URL $url..." );
-
-			$result = wp_remote_post( $url, $request_args );
-
-			if ( is_wp_error( $result ) ) {
-				$this->log->error( 'Posting URL returned an error: ' . $result->get_error_message() );
-			}
-
-		}
-	}
-
-	/**
-	 * Verify the postback is valid, then fire any scheduled events.
-	 *
-	 * @uses $_POST['_nonce']
-	 * @uses is_user_logged_in()
-	 * @uses add_filter()
-	 * @uses wp_die()
-	 */
-	public function handle_postback() {
-		if ( isset( $_POST['_nonce'] ) && $this->verify_async_nonce( $_POST['_nonce'] ) ) {
-			if ( ! is_user_logged_in() ) {
-				$this->action = "nopriv_$this->action";
-			}
-			$this->run_action();
-		}
-
-		add_filter( 'wp_die_handler', function () {
-			die();
-		} );
-		wp_die();
-	}
-
-	/**
-	 * Create a random, one time use token.
-	 *
-	 * Based entirely on wp_create_nonce() but does not tie the nonce to the
-	 * current logged-in user.
-	 *
-	 * @uses wp_nonce_tick()
-	 * @uses wp_hash()
-	 *
-	 * @return string The one-time use token
-	 */
-	protected function create_async_nonce() {
-		$action = $this->get_nonce_action();
-		$i      = wp_nonce_tick();
-
-		return substr( wp_hash( $i . $action . get_class( $this ), 'nonce' ), - 12, 10 );
-	}
-
-	/**
-	 * Verify that the correct nonce was used within the time limit.
-	 *
-	 * @uses wp_nonce_tick()
-	 * @uses wp_hash()
-	 *
-	 * @param string $nonce Nonce to be verified
-	 *
-	 * @return bool Whether the nonce check passed or failed
-	 */
-	protected function verify_async_nonce( $nonce ) {
-		$action = $this->get_nonce_action();
-		$i      = wp_nonce_tick();
-
-		// Nonce generated 0-12 hours ago
-		if ( substr( wp_hash( $i . $action . get_class( $this ), 'nonce' ), - 12, 10 ) == $nonce ) {
-			return 1;
-		}
-
-		// Nonce generated 12-24 hours ago
-		if ( substr( wp_hash( ( $i - 1 ) . $action . get_class( $this ), 'nonce' ), - 12, 10 ) == $nonce ) {
-			return 2;
-		}
-
-		// Invalid nonce
-		return false;
-	}
-
-	/**
-	 * Get a nonce action based on the $action property of the class
-	 *
-	 * @return string The nonce action for the current instance
-	 */
-	protected function get_nonce_action() {
-		$action = $this->action;
-		if ( substr( $action, 0, 7 ) === 'nopriv_' ) {
-			$action = substr( $action, 7 );
-		}
-		$action = "wl_async_$action";
-
-		return $action;
-	}
-
-	/**
-	 * Prepare any data to be passed to the asynchronous postback
-	 *
-	 * The array this function receives will be a numerically keyed array from
-	 * func_get_args(). It is expected that you will return an associative array
-	 * so that the $_POST values used in the asynchronous call will make sense.
-	 *
-	 * The array you send back may or may not have anything to do with the data
-	 * passed into this method. It all depends on the implementation details and
-	 * what data is needed in the asynchronous postback.
-	 *
-	 * Do not set values for 'action' or '_nonce', as those will get overwritten
-	 * later in launch().
-	 *
-	 * @throws Exception If the postback should not occur for any reason
-	 *
-	 * @param array $data The raw data received by the launch method
-	 *
-	 * @return array The prepared data
-	 */
-	abstract protected function prepare_data( $data );
-
-	/**
-	 * Run the do_action function for the asynchronous postback.
-	 *
-	 * This method needs to fetch and sanitize any and all data from the $_POST
-	 * superglobal and provide them to the do_action call.
-	 *
-	 * The action should be constructed as "wl_async_task_$this->action"
-	 */
-	abstract protected function run_action();
+    /**
+     * Constant identifier for a task that should be available to logged-in users
+     *
+     * See constructor documentation for more details.
+     */
+    const LOGGED_IN = 1;
+
+    /**
+     * Constant identifier for a task that should be available to logged-out users
+     *
+     * See constructor documentation for more details.
+     */
+    const LOGGED_OUT = 2;
+
+    /**
+     * Constant identifier for a task that should be available to all users regardless of auth status
+     *
+     * See constructor documentation for more details.
+     */
+    const BOTH = 3;
+
+    /**
+     * This is the argument count for the main action set in the constructor. It
+     * is set to an arbitrarily high value of twenty, but can be overridden if
+     * necessary
+     *
+     * @var int
+     */
+    protected $argument_count = 20;
+
+    /**
+     * Priority to fire intermediate action.
+     *
+     * @var int
+     */
+    protected $priority = 10;
+
+    /**
+     * @var string
+     */
+    protected $action;
+
+    /**
+     * @var array
+     */
+    protected $_body_data;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Constructor to wire up the necessary actions
+     *
+     * Which hooks the asynchronous postback happens on can be set by the
+     * $auth_level parameter. There are essentially three options: logged in users
+     * only, logged out users only, or both. Set this when you instantiate an
+     * object by using one of the three class constants to do so:
+     *  - LOGGED_IN
+     *  - LOGGED_OUT
+     *  - BOTH
+     * $auth_level defaults to BOTH
+     *
+     * @throws Exception If the class' $action value hasn't been set
+     *
+     * @param int $auth_level The authentication level to use (see above)
+     */
+    public function __construct( $auth_level = self::BOTH ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        if ( empty( $this->action ) ) {
+            throw new Exception( 'Action not defined for class ' . __CLASS__ );
+        }
+        add_action( $this->action, array(
+            $this,
+            'launch',
+        ), (int) $this->priority, (int) $this->argument_count );
+        if ( $auth_level & self::LOGGED_IN ) {
+            add_action( "admin_post_wl_async_$this->action", array(
+                $this,
+                'handle_postback',
+            ) );
+        }
+        if ( $auth_level & self::LOGGED_OUT ) {
+            add_action( "admin_post_nopriv_wl_async_$this->action", array(
+                $this,
+                'handle_postback',
+            ) );
+        }
+    }
+
+    /**
+     * Add the shutdown action for launching the real postback if we don't
+     * get an exception thrown by prepare_data().
+     *
+     * @uses func_get_args() To grab any arguments passed by the action
+     */
+    public function launch() {
+        $data = func_get_args();
+        try {
+            $data = $this->prepare_data( $data );
+        } catch ( Exception $e ) {
+            return;
+        }
+
+        $data['action'] = "wl_async_$this->action";
+        $data['_nonce'] = $this->create_async_nonce();
+
+        $this->_body_data = $data;
+
+        if ( ! has_action( 'shutdown', array(
+            $this,
+            'launch_on_shutdown',
+        ) )
+        ) {
+            add_action( 'shutdown', array( $this, 'launch_on_shutdown' ) );
+        }
+    }
+
+    /**
+     * Launch the request on the WordPress shutdown hook
+     *
+     * On VIP we got into data races due to the postback sometimes completing
+     * faster than the data could propogate to the database server cluster.
+     * This made WordPress get empty data sets from the database without
+     * failing. On their advice, we're moving the actual firing of the async
+     * postback to the shutdown hook. Supposedly that will ensure that the
+     * data at least has time to get into the object cache.
+     *
+     * @uses $_COOKIE        To send a cookie header for async postback
+     * @uses apply_filters()
+     * @uses admin_url()
+     * @uses wp_remote_post()
+     */
+    public function launch_on_shutdown() {
+
+        $this->log->debug( "Launching Async Task [ action :: $this->action ]..." );
+
+        if ( ! empty( $this->_body_data ) ) {
+            $cookies = array();
+            foreach ( $_COOKIE as $name => $value ) {
+                $cookies[] = "$name=" . urlencode( is_array( $value ) ? serialize( $value ) : $value );
+            }
+
+            $request_args = array(
+                'timeout'   => 0.01,
+                'blocking'  => false,
+                'sslverify' => apply_filters( 'https_local_ssl_verify', false ),
+                'body'      => $this->_body_data,
+                'headers'   => array(
+                    'cookie' => implode( '; ', $cookies ),
+                ),
+            );
+
+            $url = get_site_url( null, 'wl-api' );
+
+            $this->log->debug( "Posting URL $url..." );
+
+            $result = wp_remote_post( $url, $request_args );
+
+            if ( is_wp_error( $result ) ) {
+                $this->log->error( 'Posting URL returned an error: ' . $result->get_error_message() );
+            }
+
+        }
+    }
+
+    /**
+     * Verify the postback is valid, then fire any scheduled events.
+     *
+     * @uses $_POST['_nonce']
+     * @uses is_user_logged_in()
+     * @uses add_filter()
+     * @uses wp_die()
+     */
+    public function handle_postback() {
+        if ( isset( $_POST['_nonce'] ) && $this->verify_async_nonce( $_POST['_nonce'] ) ) {
+            if ( ! is_user_logged_in() ) {
+                $this->action = "nopriv_$this->action";
+            }
+            $this->run_action();
+        }
+
+        add_filter( 'wp_die_handler', function () {
+            die();
+        } );
+        wp_die();
+    }
+
+    /**
+     * Create a random, one time use token.
+     *
+     * Based entirely on wp_create_nonce() but does not tie the nonce to the
+     * current logged-in user.
+     *
+     * @uses wp_nonce_tick()
+     * @uses wp_hash()
+     *
+     * @return string The one-time use token
+     */
+    protected function create_async_nonce() {
+        $action = $this->get_nonce_action();
+        $i      = wp_nonce_tick();
+
+        return substr( wp_hash( $i . $action . get_class( $this ), 'nonce' ), - 12, 10 );
+    }
+
+    /**
+     * Verify that the correct nonce was used within the time limit.
+     *
+     * @uses wp_nonce_tick()
+     * @uses wp_hash()
+     *
+     * @param string $nonce Nonce to be verified
+     *
+     * @return bool Whether the nonce check passed or failed
+     */
+    protected function verify_async_nonce( $nonce ) {
+        $action = $this->get_nonce_action();
+        $i      = wp_nonce_tick();
+
+        // Nonce generated 0-12 hours ago
+        if ( substr( wp_hash( $i . $action . get_class( $this ), 'nonce' ), - 12, 10 ) == $nonce ) {
+            return 1;
+        }
+
+        // Nonce generated 12-24 hours ago
+        if ( substr( wp_hash( ( $i - 1 ) . $action . get_class( $this ), 'nonce' ), - 12, 10 ) == $nonce ) {
+            return 2;
+        }
+
+        // Invalid nonce
+        return false;
+    }
+
+    /**
+     * Get a nonce action based on the $action property of the class
+     *
+     * @return string The nonce action for the current instance
+     */
+    protected function get_nonce_action() {
+        $action = $this->action;
+        if ( substr( $action, 0, 7 ) === 'nopriv_' ) {
+            $action = substr( $action, 7 );
+        }
+        $action = "wl_async_$action";
+
+        return $action;
+    }
+
+    /**
+     * Prepare any data to be passed to the asynchronous postback
+     *
+     * The array this function receives will be a numerically keyed array from
+     * func_get_args(). It is expected that you will return an associative array
+     * so that the $_POST values used in the asynchronous call will make sense.
+     *
+     * The array you send back may or may not have anything to do with the data
+     * passed into this method. It all depends on the implementation details and
+     * what data is needed in the asynchronous postback.
+     *
+     * Do not set values for 'action' or '_nonce', as those will get overwritten
+     * later in launch().
+     *
+     * @throws Exception If the postback should not occur for any reason
+     *
+     * @param array $data The raw data received by the launch method
+     *
+     * @return array The prepared data
+     */
+    abstract protected function prepare_data( $data );
+
+    /**
+     * Run the do_action function for the asynchronous postback.
+     *
+     * This method needs to fetch and sanitize any and all data from the $_POST
+     * superglobal and provide them to the do_action call.
+     *
+     * The action should be constructed as "wl_async_task_$this->action"
+     */
+    abstract protected function run_action();
 
 }
 

Spacing +38 added lines, -38 removed lines

@@ -81,28 +81,28 @@ 
 	 *
 	 * @param int $auth_level The authentication level to use (see above)
 	 */
-	public function __construct( $auth_level = self::BOTH ) {
+	public function __construct($auth_level = self::BOTH) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		if ( empty( $this->action ) ) {
-			throw new Exception( 'Action not defined for class ' . __CLASS__ );
+		if (empty($this->action)) {
+			throw new Exception('Action not defined for class '.__CLASS__);
 		}
-		add_action( $this->action, array(
+		add_action($this->action, array(
 			$this,
 			'launch',
-		), (int) $this->priority, (int) $this->argument_count );
-		if ( $auth_level & self::LOGGED_IN ) {
-			add_action( "admin_post_wl_async_$this->action", array(
+		), (int) $this->priority, (int) $this->argument_count);
+		if ($auth_level & self::LOGGED_IN) {
+			add_action("admin_post_wl_async_$this->action", array(
 				$this,
 				'handle_postback',
-			) );
+			));
 		}
-		if ( $auth_level & self::LOGGED_OUT ) {
-			add_action( "admin_post_nopriv_wl_async_$this->action", array(
+		if ($auth_level & self::LOGGED_OUT) {
+			add_action("admin_post_nopriv_wl_async_$this->action", array(
 				$this,
 				'handle_postback',
-			) );
+			));
 		}
 	}
 
@@ -115,8 +115,8 @@ 
 	public function launch() {
 		$data = func_get_args();
 		try {
-			$data = $this->prepare_data( $data );
-		} catch ( Exception $e ) {
+			$data = $this->prepare_data($data);
+		} catch (Exception $e) {
 			return;
 		}
 
@@ -125,12 +125,12 @@ 
 
 		$this->_body_data = $data;
 
-		if ( ! has_action( 'shutdown', array(
+		if ( ! has_action('shutdown', array(
 			$this,
 			'launch_on_shutdown',
-		) )
+		))
 		) {
-			add_action( 'shutdown', array( $this, 'launch_on_shutdown' ) );
+			add_action('shutdown', array($this, 'launch_on_shutdown'));
 		}
 	}
 
@@ -151,32 +151,32 @@ 
 	 */
 	public function launch_on_shutdown() {
 
-		$this->log->debug( "Launching Async Task [ action :: $this->action ]..." );
+		$this->log->debug("Launching Async Task [ action :: $this->action ]...");
 
-		if ( ! empty( $this->_body_data ) ) {
+		if ( ! empty($this->_body_data)) {
 			$cookies = array();
-			foreach ( $_COOKIE as $name => $value ) {
-				$cookies[] = "$name=" . urlencode( is_array( $value ) ? serialize( $value ) : $value );
+			foreach ($_COOKIE as $name => $value) {
+				$cookies[] = "$name=".urlencode(is_array($value) ? serialize($value) : $value);
 			}
 
 			$request_args = array(
 				'timeout'   => 0.01,
 				'blocking'  => false,
-				'sslverify' => apply_filters( 'https_local_ssl_verify', false ),
+				'sslverify' => apply_filters('https_local_ssl_verify', false),
 				'body'      => $this->_body_data,
 				'headers'   => array(
-					'cookie' => implode( '; ', $cookies ),
+					'cookie' => implode('; ', $cookies),
 				),
 			);
 
-			$url = get_site_url( null, 'wl-api' );
+			$url = get_site_url(null, 'wl-api');
 
-			$this->log->debug( "Posting URL $url..." );
+			$this->log->debug("Posting URL $url...");
 
-			$result = wp_remote_post( $url, $request_args );
+			$result = wp_remote_post($url, $request_args);
 
-			if ( is_wp_error( $result ) ) {
-				$this->log->error( 'Posting URL returned an error: ' . $result->get_error_message() );
+			if (is_wp_error($result)) {
+				$this->log->error('Posting URL returned an error: '.$result->get_error_message());
 			}
 
 		}
@@ -191,14 +191,14 @@ 
 	 * @uses wp_die()
 	 */
 	public function handle_postback() {
-		if ( isset( $_POST['_nonce'] ) && $this->verify_async_nonce( $_POST['_nonce'] ) ) {
-			if ( ! is_user_logged_in() ) {
+		if (isset($_POST['_nonce']) && $this->verify_async_nonce($_POST['_nonce'])) {
+			if ( ! is_user_logged_in()) {
 				$this->action = "nopriv_$this->action";
 			}
 			$this->run_action();
 		}
 
-		add_filter( 'wp_die_handler', function () {
+		add_filter('wp_die_handler', function() {
 			die();
 		} );
 		wp_die();
@@ -219,7 +219,7 @@ 
 		$action = $this->get_nonce_action();
 		$i      = wp_nonce_tick();
 
-		return substr( wp_hash( $i . $action . get_class( $this ), 'nonce' ), - 12, 10 );
+		return substr(wp_hash($i.$action.get_class($this), 'nonce'), - 12, 10);
 	}
 
 	/**
@@ -232,17 +232,17 @@ 
 	 *
 	 * @return bool Whether the nonce check passed or failed
 	 */
-	protected function verify_async_nonce( $nonce ) {
+	protected function verify_async_nonce($nonce) {
 		$action = $this->get_nonce_action();
 		$i      = wp_nonce_tick();
 
 		// Nonce generated 0-12 hours ago
-		if ( substr( wp_hash( $i . $action . get_class( $this ), 'nonce' ), - 12, 10 ) == $nonce ) {
+		if (substr(wp_hash($i.$action.get_class($this), 'nonce'), - 12, 10) == $nonce) {
 			return 1;
 		}
 
 		// Nonce generated 12-24 hours ago
-		if ( substr( wp_hash( ( $i - 1 ) . $action . get_class( $this ), 'nonce' ), - 12, 10 ) == $nonce ) {
+		if (substr(wp_hash(($i - 1).$action.get_class($this), 'nonce'), - 12, 10) == $nonce) {
 			return 2;
 		}
 
@@ -257,8 +257,8 @@ 
 	 */
 	protected function get_nonce_action() {
 		$action = $this->action;
-		if ( substr( $action, 0, 7 ) === 'nopriv_' ) {
-			$action = substr( $action, 7 );
+		if (substr($action, 0, 7) === 'nopriv_') {
+			$action = substr($action, 7);
 		}
 		$action = "wl_async_$action";
 
@@ -285,7 +285,7 @@ 
 	 *
 	 * @return array The prepared data
 	 */
-	abstract protected function prepare_data( $data );
+	abstract protected function prepare_data($data);
 
 	/**
 	 * Run the do_action function for the asynchronous postback.

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

Indentation +190 added lines, -190 removed lines

@@ -13,196 +13,196 @@
  */
 class Wordlift_Jsonld_Service {
 
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-
-	/**
-	 * A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	private $website_converter;
-
-	/**
-	 * The singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a JSON-LD service.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Post_Converter $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
-	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	public function __construct( $entity_service, $converter, $website_converter ) {
-
-		$this->entity_service    = $entity_service;
-		$this->converter         = $converter;
-		$this->website_converter = $website_converter;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Process calls to the AJAX 'wl_jsonld' endpoint.
-	 *
-	 * @since 3.8.0
-	 */
-	public function get() {
-		// Clear the buffer to be sure someone doesn't mess with our response.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/406.
-		// See https://codex.wordpress.org/AJAX_in_Plugins.
-		@ob_clean();
-
-		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] );
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null;
-
-		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
-
-	}
-
-	/**
-	 * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
-	 *
-	 * @since 3.18.5
-	 *
-	 * @param mixed $response Variable (usually an array or object) to encode as JSON,
-	 *                           then print and die.
-	 * @param int $status_code The HTTP status code to output.
-	 */
-	private function send_jsonld( $response, $status_code = null ) {
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die();
-		} else {
-			die;
-		}
-	}
-
-	/**
-	 * Get the JSON-LD.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @param bool $is_homepage Whether the JSON-LD for the homepage is being requested.
-	 * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
-	 *
-	 * @return array A JSON-LD structure.
-	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null ) {
-
-		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
-		// e-mails with a low apdex score.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/521
-		Wordlift_NewRelic_Adapter::ignore_apdex();
-
-		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
-			/**
-			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
-			 *
-			 * @since  3.14.0
-			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
-			 */
-			if ( ! apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
-				// Set a reference to the website_converter.
-				$website_converter = $this->website_converter;
-
-				// Send JSON-LD.
-				return $website_converter->create_schema();
-			}
-		}
-
-		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
-			return array();
-		}
-
-		// An array of references which is captured when converting an URI to a
-		// json which we gather to further expand our json-ld.
-		$references = array();
-
-		// Set a reference to the entity_to_jsonld_converter to use in the closures.
-		$entity_to_jsonld_converter = $this->converter;
-
-		// Convert each URI to a JSON-LD array, while gathering referenced entities.
-		// in the references array.
-		$jsonld = array_merge(
-			array( $entity_to_jsonld_converter->convert( $post_id, $references ) ),
-			// Convert each URI in the references array to JSON-LD. We don't output
-			// entities already output above (hence the array_diff).
-			array_filter( array_map( function ( $item ) use ( $entity_to_jsonld_converter, $references ) {
-
-				// "2nd level properties" may not output here, e.g. a post
-				// mentioning an event, located in a place: the place is referenced
-				// via the `@id` but no other properties are loaded.
-				return $entity_to_jsonld_converter->convert( $item, $references );
-			}, $references ) ) );
-
-		// Finally send the JSON-LD.
-		return $jsonld;
-	}
-
-	/**
-	 * Write the JSON-LD in the head.
-	 *
-	 * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
-	 * document head, using the `wp_head` hook.
-	 *
-	 * @since 3.18.5
-	 */
-	public function wp_head() {
-
-		// Determine whether this is the home page or whether we're displaying a single post.
-		$is_homepage = is_home() || is_front_page();
-		$post_id     = is_singular() ? get_the_ID() : null;
-
-		$jsonld = json_encode( $this->get_jsonld( $is_homepage, $post_id ) );
-		?>
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+
+    /**
+     * A {@link Wordlift_Website_Jsonld_Converter} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    private $website_converter;
+
+    /**
+     * The singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
+     */
+    private static $instance;
+
+    /**
+     * Create a JSON-LD service.
+     *
+     * @since 3.8.0
+     *
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Post_Converter $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
+     * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    public function __construct( $entity_service, $converter, $website_converter ) {
+
+        $this->entity_service    = $entity_service;
+        $this->converter         = $converter;
+        $this->website_converter = $website_converter;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Process calls to the AJAX 'wl_jsonld' endpoint.
+     *
+     * @since 3.8.0
+     */
+    public function get() {
+        // Clear the buffer to be sure someone doesn't mess with our response.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/406.
+        // See https://codex.wordpress.org/AJAX_in_Plugins.
+        @ob_clean();
+
+        // Get the parameter from the request.
+        $is_homepage = isset( $_REQUEST['homepage'] );
+        $post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null;
+
+        // Send the generated JSON-LD.
+        $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+
+    }
+
+    /**
+     * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
+     *
+     * @since 3.18.5
+     *
+     * @param mixed $response Variable (usually an array or object) to encode as JSON,
+     *                           then print and die.
+     * @param int $status_code The HTTP status code to output.
+     */
+    private function send_jsonld( $response, $status_code = null ) {
+        @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
+        echo wp_json_encode( $response );
+        if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+            wp_die();
+        } else {
+            die;
+        }
+    }
+
+    /**
+     * Get the JSON-LD.
+     *
+     * @since 3.15.1
+     *
+     * @param bool $is_homepage Whether the JSON-LD for the homepage is being requested.
+     * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
+     *
+     * @return array A JSON-LD structure.
+     */
+    public function get_jsonld( $is_homepage = false, $post_id = null ) {
+
+        // Tell NewRelic to ignore us, otherwise NewRelic customers might receive
+        // e-mails with a low apdex score.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/521
+        Wordlift_NewRelic_Adapter::ignore_apdex();
+
+        // Switch to Website converter if is home page.
+        if ( $is_homepage ) {
+            /**
+             * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
+             *
+             * @since  3.14.0
+             * @api    bool $display_search Whether or not to display json+ld search on the frontend.
+             */
+            if ( ! apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+                // Set a reference to the website_converter.
+                $website_converter = $this->website_converter;
+
+                // Send JSON-LD.
+                return $website_converter->create_schema();
+            }
+        }
+
+        // If no id has been provided return an empty array.
+        if ( ! isset( $post_id ) ) {
+            return array();
+        }
+
+        // An array of references which is captured when converting an URI to a
+        // json which we gather to further expand our json-ld.
+        $references = array();
+
+        // Set a reference to the entity_to_jsonld_converter to use in the closures.
+        $entity_to_jsonld_converter = $this->converter;
+
+        // Convert each URI to a JSON-LD array, while gathering referenced entities.
+        // in the references array.
+        $jsonld = array_merge(
+            array( $entity_to_jsonld_converter->convert( $post_id, $references ) ),
+            // Convert each URI in the references array to JSON-LD. We don't output
+            // entities already output above (hence the array_diff).
+            array_filter( array_map( function ( $item ) use ( $entity_to_jsonld_converter, $references ) {
+
+                // "2nd level properties" may not output here, e.g. a post
+                // mentioning an event, located in a place: the place is referenced
+                // via the `@id` but no other properties are loaded.
+                return $entity_to_jsonld_converter->convert( $item, $references );
+            }, $references ) ) );
+
+        // Finally send the JSON-LD.
+        return $jsonld;
+    }
+
+    /**
+     * Write the JSON-LD in the head.
+     *
+     * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
+     * document head, using the `wp_head` hook.
+     *
+     * @since 3.18.5
+     */
+    public function wp_head() {
+
+        // Determine whether this is the home page or whether we're displaying a single post.
+        $is_homepage = is_home() || is_front_page();
+        $post_id     = is_singular() ? get_the_ID() : null;
+
+        $jsonld = json_encode( $this->get_jsonld( $is_homepage, $post_id ) );
+        ?>
         <script type="application/ld+json"><?php echo $jsonld; ?></script><?php
-	}
+    }
 
 }

Spacing +17 added lines, -17 removed lines

@@ -59,7 +59,7 @@ 
 	 * @param \Wordlift_Post_Converter $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
 	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
 	 */
-	public function __construct( $entity_service, $converter, $website_converter ) {
+	public function __construct($entity_service, $converter, $website_converter) {
 
 		$this->entity_service    = $entity_service;
 		$this->converter         = $converter;
@@ -94,11 +94,11 @@ 
 		@ob_clean();
 
 		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] );
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null;
+		$is_homepage = isset($_REQUEST['homepage']);
+		$post_id     = isset($_REQUEST['id']) && is_numeric($_REQUEST['id']) ? intval($_REQUEST['id']) : null;
 
 		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+		$this->send_jsonld($this->get_jsonld($is_homepage, $post_id));
 
 	}
 
@@ -111,10 +111,10 @@ 
 	 *                           then print and die.
 	 * @param int $status_code The HTTP status code to output.
 	 */
-	private function send_jsonld( $response, $status_code = null ) {
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+	private function send_jsonld($response, $status_code = null) {
+		@header('Content-Type: application/ld+json; charset='.get_option('blog_charset'));
+		echo wp_json_encode($response);
+		if (apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX)) {
 			wp_die();
 		} else {
 			die;
@@ -131,7 +131,7 @@ 
 	 *
 	 * @return array A JSON-LD structure.
 	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null ) {
+	public function get_jsonld($is_homepage = false, $post_id = null) {
 
 		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
 		// e-mails with a low apdex score.
@@ -140,14 +140,14 @@ 
 		Wordlift_NewRelic_Adapter::ignore_apdex();
 
 		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
+		if ($is_homepage) {
 			/**
 			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
 			 *
 			 * @since  3.14.0
 			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
 			 */
-			if ( ! apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+			if ( ! apply_filters('wordlift_disable_website_json_ld', false)) {
 				// Set a reference to the website_converter.
 				$website_converter = $this->website_converter;
 
@@ -157,7 +157,7 @@ 
 		}
 
 		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
+		if ( ! isset($post_id)) {
 			return array();
 		}
 
@@ -171,16 +171,16 @@ 
 		// Convert each URI to a JSON-LD array, while gathering referenced entities.
 		// in the references array.
 		$jsonld = array_merge(
-			array( $entity_to_jsonld_converter->convert( $post_id, $references ) ),
+			array($entity_to_jsonld_converter->convert($post_id, $references)),
 			// Convert each URI in the references array to JSON-LD. We don't output
 			// entities already output above (hence the array_diff).
-			array_filter( array_map( function ( $item ) use ( $entity_to_jsonld_converter, $references ) {
+			array_filter(array_map(function($item) use ($entity_to_jsonld_converter, $references) {
 
 				// "2nd level properties" may not output here, e.g. a post
 				// mentioning an event, located in a place: the place is referenced
 				// via the `@id` but no other properties are loaded.
-				return $entity_to_jsonld_converter->convert( $item, $references );
-			}, $references ) ) );
+				return $entity_to_jsonld_converter->convert($item, $references);
+			}, $references)) );
 
 		// Finally send the JSON-LD.
 		return $jsonld;
@@ -200,7 +200,7 @@ 
 		$is_homepage = is_home() || is_front_page();
 		$post_id     = is_singular() ? get_the_ID() : null;
 
-		$jsonld = json_encode( $this->get_jsonld( $is_homepage, $post_id ) );
+		$jsonld = json_encode($this->get_jsonld($is_homepage, $post_id));
 		?>
         <script type="application/ld+json"><?php echo $jsonld; ?></script><?php
 	}

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

Indentation +99 added lines, -99 removed lines

@@ -7,135 +7,135 @@
  */
 class Wordlift_Log_Service {
 
-	const MESSAGE_TEMPLATE = '%-6s [%-40.40s] %s';
-
-	const ERROR = 4;
-	const WARN = 3;
-	const INFO = 2;
-	const DEBUG = 1;
-	const TRACE = 0;
-
-	/**
-	 * The class related to the logs.
-	 *
-	 * @since  1.0.0
-	 * @access private
-	 * @var string $class_name The class related to the logs.
-	 */
-	private $class_name;
-
-	/**
-	 * The log levels for printing in log lines.
-	 *
-	 * @var array $levels An array of log levels.
-	 */
-	private static $levels = array(
-		self::TRACE => 'TRACE',
-		self::DEBUG => 'DEBUG',
-		self::INFO  => 'INFO',
-		self::WARN  => 'WARN',
-		self::ERROR => 'ERROR',
-	);
+    const MESSAGE_TEMPLATE = '%-6s [%-40.40s] %s';
+
+    const ERROR = 4;
+    const WARN = 3;
+    const INFO = 2;
+    const DEBUG = 1;
+    const TRACE = 0;
+
+    /**
+     * The class related to the logs.
+     *
+     * @since  1.0.0
+     * @access private
+     * @var string $class_name The class related to the logs.
+     */
+    private $class_name;
+
+    /**
+     * The log levels for printing in log lines.
+     *
+     * @var array $levels An array of log levels.
+     */
+    private static $levels = array(
+        self::TRACE => 'TRACE',
+        self::DEBUG => 'DEBUG',
+        self::INFO  => 'INFO',
+        self::WARN  => 'WARN',
+        self::ERROR => 'ERROR',
+    );
 
-	/**
-	 * A singleton instance for legacy logging.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $instance A singleton instance for legacy logging.
-	 */
-	private static $instance = null;
+    /**
+     * A singleton instance for legacy logging.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Log_Service $instance A singleton instance for legacy logging.
+     */
+    private static $instance = null;
 
-	/**
-	 * Create an instance of the Log service.
-	 * @since 1.0.0
-	 *
-	 * @param string $class_name The class related to the logs.
-	 */
-	public function __construct( $class_name ) {
+    /**
+     * Create an instance of the Log service.
+     * @since 1.0.0
+     *
+     * @param string $class_name The class related to the logs.
+     */
+    public function __construct( $class_name ) {
 
-		$this->class_name = $class_name;
+        $this->class_name = $class_name;
 
-	}
+    }
 
-	/**
-	 * Get the ROOT logger.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @return \Wordlift_Log_Service A singleton instance for legacy logging.
-	 */
-	public static function get_instance() {
+    /**
+     * Get the ROOT logger.
+     *
+     * @since 3.10.0
+     *
+     * @return \Wordlift_Log_Service A singleton instance for legacy logging.
+     */
+    public static function get_instance() {
 
-		return self::$instance ?: self::$instance = new Wordlift_Log_Service( 'ROOT' );
-	}
+        return self::$instance ?: self::$instance = new Wordlift_Log_Service( 'ROOT' );
+    }
 
 
-	public static function get_logger( $class_name ) {
+    public static function get_logger( $class_name ) {
 
-		return new Wordlift_Log_Service( $class_name );
+        return new Wordlift_Log_Service( $class_name );
 
-	}
+    }
 
-	/**
-	 * Log a message.
-	 *
-	 * @since 1.0.0
-	 *
-	 * @param string $level   The log level.
-	 * @param string $message The message to log.
-	 */
-	public function log( $level, $message ) {
+    /**
+     * Log a message.
+     *
+     * @since 1.0.0
+     *
+     * @param string $level   The log level.
+     * @param string $message The message to log.
+     */
+    public function log( $level, $message ) {
 
-		// Bail out if WordLift log level isn't defined, and WP debug is disabled.
-		if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::ERROR
-			 && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
-			return;
-		}
+        // Bail out if WordLift log level isn't defined, and WP debug is disabled.
+        if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::ERROR
+             && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
+            return;
+        }
 
-		// Bail out if the log message is below the minimum log level.
-		if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
-			return;
-		}
+        // Bail out if the log message is below the minimum log level.
+        if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
+            return;
+        }
 
-		// Bail out if there's a filter and we don't match it.
-		if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$this->class_name($|,)/", WL_LOG_FILTER ) ) {
-			return;
-		}
+        // Bail out if there's a filter and we don't match it.
+        if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$this->class_name($|,)/", WL_LOG_FILTER ) ) {
+            return;
+        }
 
-		// Finally log the message.
-		error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
+        // Finally log the message.
+        error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
 
-	}
+    }
 
-	public function error( $message ) {
+    public function error( $message ) {
 
-		$this->log( self::ERROR, $message );
+        $this->log( self::ERROR, $message );
 
-	}
+    }
 
-	public function warn( $message ) {
+    public function warn( $message ) {
 
-		$this->log( self::WARN, $message );
+        $this->log( self::WARN, $message );
 
-	}
+    }
 
-	public function info( $message ) {
+    public function info( $message ) {
 
-		$this->log( self::INFO, $message );
+        $this->log( self::INFO, $message );
 
-	}
+    }
 
-	public function debug( $message ) {
+    public function debug( $message ) {
 
-		$this->log( self::DEBUG, $message );
+        $this->log( self::DEBUG, $message );
 
-	}
+    }
 
-	public function trace( $message ) {
+    public function trace( $message ) {
 
-		$this->log( self::TRACE, $message );
+        $this->log( self::TRACE, $message );
 
-	}
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -52,7 +52,7 @@ 
 	 *
 	 * @param string $class_name The class related to the logs.
 	 */
-	public function __construct( $class_name ) {
+	public function __construct($class_name) {
 
 		$this->class_name = $class_name;
 
@@ -67,13 +67,13 @@ 
 	 */
 	public static function get_instance() {
 
-		return self::$instance ?: self::$instance = new Wordlift_Log_Service( 'ROOT' );
+		return self::$instance ?: self::$instance = new Wordlift_Log_Service('ROOT');
 	}
 
 
-	public static function get_logger( $class_name ) {
+	public static function get_logger($class_name) {
 
-		return new Wordlift_Log_Service( $class_name );
+		return new Wordlift_Log_Service($class_name);
 
 	}
 
@@ -85,56 +85,56 @@ 
 	 * @param string $level   The log level.
 	 * @param string $message The message to log.
 	 */
-	public function log( $level, $message ) {
+	public function log($level, $message) {
 
 		// Bail out if WordLift log level isn't defined, and WP debug is disabled.
-		if ( ! defined( 'WL_LOG_LEVEL' ) && $level < self::ERROR
-			 && ( ! defined( 'WP_DEBUG' ) || false === WP_DEBUG ) ) {
+		if ( ! defined('WL_LOG_LEVEL') && $level < self::ERROR
+			 && ( ! defined('WP_DEBUG') || false === WP_DEBUG)) {
 			return;
 		}
 
 		// Bail out if the log message is below the minimum log level.
-		if ( defined( 'WL_LOG_LEVEL' ) && $level < intval( WL_LOG_LEVEL ) ) {
+		if (defined('WL_LOG_LEVEL') && $level < intval(WL_LOG_LEVEL)) {
 			return;
 		}
 
 		// Bail out if there's a filter and we don't match it.
-		if ( defined( 'WL_LOG_FILTER' ) && 1 !== preg_match( "/(^|,)$this->class_name($|,)/", WL_LOG_FILTER ) ) {
+		if (defined('WL_LOG_FILTER') && 1 !== preg_match("/(^|,)$this->class_name($|,)/", WL_LOG_FILTER)) {
 			return;
 		}
 
 		// Finally log the message.
-		error_log( sprintf( self::MESSAGE_TEMPLATE, self::$levels[ $level ], $this->class_name, is_array( $message ) ? implode( ', ', $message ) : $message ) );
+		error_log(sprintf(self::MESSAGE_TEMPLATE, self::$levels[$level], $this->class_name, is_array($message) ? implode(', ', $message) : $message));
 
 	}
 
-	public function error( $message ) {
+	public function error($message) {
 
-		$this->log( self::ERROR, $message );
+		$this->log(self::ERROR, $message);
 
 	}
 
-	public function warn( $message ) {
+	public function warn($message) {
 
-		$this->log( self::WARN, $message );
+		$this->log(self::WARN, $message);
 
 	}
 
-	public function info( $message ) {
+	public function info($message) {
 
-		$this->log( self::INFO, $message );
+		$this->log(self::INFO, $message);
 
 	}
 
-	public function debug( $message ) {
+	public function debug($message) {
 
-		$this->log( self::DEBUG, $message );
+		$this->log(self::DEBUG, $message);
 
 	}
 
-	public function trace( $message ) {
+	public function trace($message) {
 
-		$this->log( self::TRACE, $message );
+		$this->log(self::TRACE, $message);
 
 	}