insideout10 / wordlift-plugin

src/vendor/deliciousbrains/wp-background-processing/classes/wp-background-process.php

Indentation +764 added lines, -764 removed lines

@@ -13,774 +13,774 @@
  */
 abstract class WP_Background_Process extends WP_Async_Request {
 
-	/**
-	 * Action
-	 *
-	 * (default value: 'background_process')
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $action = 'background_process';
-
-	/**
-	 * Start time of current process.
-	 *
-	 * (default value: 0)
-	 *
-	 * @var int
-	 * @access protected
-	 */
-	protected $start_time = 0;
-
-	/**
-	 * Cron_hook_identifier
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $cron_hook_identifier;
-
-	/**
-	 * Cron_interval_identifier
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $cron_interval_identifier;
-
-	/**
-	 * Restrict object instantiation when using unserialize.
-	 *
-	 * @var bool|array
-	 */
-	protected $allowed_batch_data_classes = true;
-
-	/**
-	 * The status set when process is cancelling.
-	 *
-	 * @var int
-	 */
-	const STATUS_CANCELLED = 1;
-
-	/**
-	 * The status set when process is paused or pausing.
-	 *
-	 * @var int;
-	 */
-	const STATUS_PAUSED = 2;
-
-	/**
-	 * Initiate new background process.
-	 *
-	 * @param bool|array $allowed_batch_data_classes Optional. Array of class names that can be unserialized. Default true (any class).
-	 */
-	public function __construct( $allowed_batch_data_classes = true ) {
-		parent::__construct();
-
-		if ( empty( $allowed_batch_data_classes ) && false !== $allowed_batch_data_classes ) {
-			$allowed_batch_data_classes = true;
-		}
-
-		if ( ! is_bool( $allowed_batch_data_classes ) && ! is_array( $allowed_batch_data_classes ) ) {
-			$allowed_batch_data_classes = true;
-		}
-
-		// If allowed_batch_data_classes property set in subclass,
-		// only apply override if not allowing any class.
-		if ( true === $this->allowed_batch_data_classes || true !== $allowed_batch_data_classes ) {
-			$this->allowed_batch_data_classes = $allowed_batch_data_classes;
-		}
-
-		$this->cron_hook_identifier     = $this->identifier . '_cron';
-		$this->cron_interval_identifier = $this->identifier . '_cron_interval';
-
-		add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
-		add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
-	}
-
-	/**
-	 * Schedule the cron healthcheck and dispatch an async request to start processing the queue.
-	 *
-	 * @access public
-	 * @return array|WP_Error|false HTTP Response array, WP_Error on failure, or false if not attempted.
-	 */
-	public function dispatch() {
-		if ( $this->is_processing() ) {
-			// Process already running.
-			return false;
-		}
-
-		// Schedule the cron healthcheck.
-		$this->schedule_event();
-
-		// Perform remote post.
-		return parent::dispatch();
-	}
-
-	/**
-	 * Push to the queue.
-	 *
-	 * Note, save must be called in order to persist queued items to a batch for processing.
-	 *
-	 * @param mixed $data Data.
-	 *
-	 * @return $this
-	 */
-	public function push_to_queue( $data ) {
-		$this->data[] = $data;
-
-		return $this;
-	}
-
-	/**
-	 * Save the queued items for future processing.
-	 *
-	 * @return $this
-	 */
-	public function save() {
-		$key = $this->generate_key();
-
-		if ( ! empty( $this->data ) ) {
-			update_site_option( $key, $this->data );
-		}
-
-		// Clean out data so that new data isn't prepended with closed session's data.
-		$this->data = array();
-
-		return $this;
-	}
-
-	/**
-	 * Update a batch's queued items.
-	 *
-	 * @param string $key  Key.
-	 * @param array  $data Data.
-	 *
-	 * @return $this
-	 */
-	public function update( $key, $data ) {
-		if ( ! empty( $data ) ) {
-			update_site_option( $key, $data );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Delete a batch of queued items.
-	 *
-	 * @param string $key Key.
-	 *
-	 * @return $this
-	 */
-	public function delete( $key ) {
-		delete_site_option( $key );
-
-		return $this;
-	}
-
-	/**
-	 * Delete entire job queue.
-	 */
-	public function delete_all() {
-		$batches = $this->get_batches();
-
-		foreach ( $batches as $batch ) {
-			$this->delete( $batch->key );
-		}
-
-		delete_site_option( $this->get_status_key() );
-
-		$this->cancelled();
-	}
-
-	/**
-	 * Cancel job on next batch.
-	 */
-	public function cancel() {
-		update_site_option( $this->get_status_key(), self::STATUS_CANCELLED );
-
-		// Just in case the job was paused at the time.
-		$this->dispatch();
-	}
-
-	/**
-	 * Has the process been cancelled?
-	 *
-	 * @return bool
-	 */
-	public function is_cancelled() {
-		$status = get_site_option( $this->get_status_key(), 0 );
-
-		return absint( $status ) === self::STATUS_CANCELLED;
-	}
-
-	/**
-	 * Called when background process has been cancelled.
-	 */
-	protected function cancelled() {
-		do_action( $this->identifier . '_cancelled' );
-	}
-
-	/**
-	 * Pause job on next batch.
-	 */
-	public function pause() {
-		update_site_option( $this->get_status_key(), self::STATUS_PAUSED );
-	}
-
-	/**
-	 * Is the job paused?
-	 *
-	 * @return bool
-	 */
-	public function is_paused() {
-		$status = get_site_option( $this->get_status_key(), 0 );
-
-		return absint( $status ) === self::STATUS_PAUSED;
-	}
-
-	/**
-	 * Called when background process has been paused.
-	 */
-	protected function paused() {
-		do_action( $this->identifier . '_paused' );
-	}
-
-	/**
-	 * Resume job.
-	 */
-	public function resume() {
-		delete_site_option( $this->get_status_key() );
-
-		$this->schedule_event();
-		$this->dispatch();
-		$this->resumed();
-	}
-
-	/**
-	 * Called when background process has been resumed.
-	 */
-	protected function resumed() {
-		do_action( $this->identifier . '_resumed' );
-	}
-
-	/**
-	 * Is queued?
-	 *
-	 * @return bool
-	 */
-	public function is_queued() {
-		return ! $this->is_queue_empty();
-	}
-
-	/**
-	 * Is the tool currently active, e.g. starting, working, paused or cleaning up?
-	 *
-	 * @return bool
-	 */
-	public function is_active() {
-		return $this->is_queued() || $this->is_processing() || $this->is_paused() || $this->is_cancelled();
-	}
-
-	/**
-	 * Generate key for a batch.
-	 *
-	 * Generates a unique key based on microtime. Queue items are
-	 * given a unique key so that they can be merged upon save.
-	 *
-	 * @param int    $length Optional max length to trim key to, defaults to 64 characters.
-	 * @param string $key    Optional string to append to identifier before hash, defaults to "batch".
-	 *
-	 * @return string
-	 */
-	protected function generate_key( $length = 64, $key = 'batch' ) {
-		$unique  = md5( microtime() . wp_rand() );
-		$prepend = $this->identifier . '_' . $key . '_';
-
-		return substr( $prepend . $unique, 0, $length );
-	}
-
-	/**
-	 * Get the status key.
-	 *
-	 * @return string
-	 */
-	protected function get_status_key() {
-		return $this->identifier . '_status';
-	}
-
-	/**
-	 * Maybe process a batch of queued items.
-	 *
-	 * Checks whether data exists within the queue and that
-	 * the process is not already running.
-	 */
-	public function maybe_handle() {
-		// Don't lock up other requests while processing.
-		session_write_close();
-
-		if ( $this->is_processing() ) {
-			// Background process already running.
-			return $this->maybe_wp_die();
-		}
-
-		if ( $this->is_cancelled() ) {
-			$this->clear_scheduled_event();
-			$this->delete_all();
-
-			return $this->maybe_wp_die();
-		}
-
-		if ( $this->is_paused() ) {
-			$this->clear_scheduled_event();
-			$this->paused();
-
-			return $this->maybe_wp_die();
-		}
-
-		if ( $this->is_queue_empty() ) {
-			// No data to process.
-			return $this->maybe_wp_die();
-		}
-
-		check_ajax_referer( $this->identifier, 'nonce' );
-
-		$this->handle();
-
-		return $this->maybe_wp_die();
-	}
-
-	/**
-	 * Is queue empty?
-	 *
-	 * @return bool
-	 */
-	protected function is_queue_empty() {
-		return empty( $this->get_batch() );
-	}
-
-	/**
-	 * Is process running?
-	 *
-	 * Check whether the current process is already running
-	 * in a background process.
-	 *
-	 * @return bool
-	 *
-	 * @deprecated 1.1.0 Superseded.
-	 * @see        is_processing()
-	 */
-	protected function is_process_running() {
-		return $this->is_processing();
-	}
-
-	/**
-	 * Is the background process currently running?
-	 *
-	 * @return bool
-	 */
-	public function is_processing() {
-		if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
-			// Process already running.
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Lock process.
-	 *
-	 * Lock the process so that multiple instances can't run simultaneously.
-	 * Override if applicable, but the duration should be greater than that
-	 * defined in the time_exceeded() method.
-	 */
-	protected function lock_process() {
-		$this->start_time = time(); // Set start time of current process.
-
-		$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
-		$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
-
-		set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
-	}
-
-	/**
-	 * Unlock process.
-	 *
-	 * Unlock the process so that other instances can spawn.
-	 *
-	 * @return $this
-	 */
-	protected function unlock_process() {
-		delete_site_transient( $this->identifier . '_process_lock' );
-
-		return $this;
-	}
-
-	/**
-	 * Get batch.
-	 *
-	 * @return stdClass Return the first batch of queued items.
-	 */
-	protected function get_batch() {
-		return array_reduce(
-			$this->get_batches( 1 ),
-			static function ( $carry, $batch ) {
-				return $batch;
-			},
-			array()
-		);
-	}
-
-	/**
-	 * Get batches.
-	 *
-	 * @param int $limit Number of batches to return, defaults to all.
-	 *
-	 * @return array of stdClass
-	 */
-	public function get_batches( $limit = 0 ) {
-		global $wpdb;
-
-		if ( empty( $limit ) || ! is_int( $limit ) ) {
-			$limit = 0;
-		}
-
-		$table        = $wpdb->options;
-		$column       = 'option_name';
-		$key_column   = 'option_id';
-		$value_column = 'option_value';
-
-		if ( is_multisite() ) {
-			$table        = $wpdb->sitemeta;
-			$column       = 'meta_key';
-			$key_column   = 'meta_id';
-			$value_column = 'meta_value';
-		}
-
-		$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
-
-		$sql = '
+    /**
+     * Action
+     *
+     * (default value: 'background_process')
+     *
+     * @var string
+     * @access protected
+     */
+    protected $action = 'background_process';
+
+    /**
+     * Start time of current process.
+     *
+     * (default value: 0)
+     *
+     * @var int
+     * @access protected
+     */
+    protected $start_time = 0;
+
+    /**
+     * Cron_hook_identifier
+     *
+     * @var string
+     * @access protected
+     */
+    protected $cron_hook_identifier;
+
+    /**
+     * Cron_interval_identifier
+     *
+     * @var string
+     * @access protected
+     */
+    protected $cron_interval_identifier;
+
+    /**
+     * Restrict object instantiation when using unserialize.
+     *
+     * @var bool|array
+     */
+    protected $allowed_batch_data_classes = true;
+
+    /**
+     * The status set when process is cancelling.
+     *
+     * @var int
+     */
+    const STATUS_CANCELLED = 1;
+
+    /**
+     * The status set when process is paused or pausing.
+     *
+     * @var int;
+     */
+    const STATUS_PAUSED = 2;
+
+    /**
+     * Initiate new background process.
+     *
+     * @param bool|array $allowed_batch_data_classes Optional. Array of class names that can be unserialized. Default true (any class).
+     */
+    public function __construct( $allowed_batch_data_classes = true ) {
+        parent::__construct();
+
+        if ( empty( $allowed_batch_data_classes ) && false !== $allowed_batch_data_classes ) {
+            $allowed_batch_data_classes = true;
+        }
+
+        if ( ! is_bool( $allowed_batch_data_classes ) && ! is_array( $allowed_batch_data_classes ) ) {
+            $allowed_batch_data_classes = true;
+        }
+
+        // If allowed_batch_data_classes property set in subclass,
+        // only apply override if not allowing any class.
+        if ( true === $this->allowed_batch_data_classes || true !== $allowed_batch_data_classes ) {
+            $this->allowed_batch_data_classes = $allowed_batch_data_classes;
+        }
+
+        $this->cron_hook_identifier     = $this->identifier . '_cron';
+        $this->cron_interval_identifier = $this->identifier . '_cron_interval';
+
+        add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
+        add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
+    }
+
+    /**
+     * Schedule the cron healthcheck and dispatch an async request to start processing the queue.
+     *
+     * @access public
+     * @return array|WP_Error|false HTTP Response array, WP_Error on failure, or false if not attempted.
+     */
+    public function dispatch() {
+        if ( $this->is_processing() ) {
+            // Process already running.
+            return false;
+        }
+
+        // Schedule the cron healthcheck.
+        $this->schedule_event();
+
+        // Perform remote post.
+        return parent::dispatch();
+    }
+
+    /**
+     * Push to the queue.
+     *
+     * Note, save must be called in order to persist queued items to a batch for processing.
+     *
+     * @param mixed $data Data.
+     *
+     * @return $this
+     */
+    public function push_to_queue( $data ) {
+        $this->data[] = $data;
+
+        return $this;
+    }
+
+    /**
+     * Save the queued items for future processing.
+     *
+     * @return $this
+     */
+    public function save() {
+        $key = $this->generate_key();
+
+        if ( ! empty( $this->data ) ) {
+            update_site_option( $key, $this->data );
+        }
+
+        // Clean out data so that new data isn't prepended with closed session's data.
+        $this->data = array();
+
+        return $this;
+    }
+
+    /**
+     * Update a batch's queued items.
+     *
+     * @param string $key  Key.
+     * @param array  $data Data.
+     *
+     * @return $this
+     */
+    public function update( $key, $data ) {
+        if ( ! empty( $data ) ) {
+            update_site_option( $key, $data );
+        }
+
+        return $this;
+    }
+
+    /**
+     * Delete a batch of queued items.
+     *
+     * @param string $key Key.
+     *
+     * @return $this
+     */
+    public function delete( $key ) {
+        delete_site_option( $key );
+
+        return $this;
+    }
+
+    /**
+     * Delete entire job queue.
+     */
+    public function delete_all() {
+        $batches = $this->get_batches();
+
+        foreach ( $batches as $batch ) {
+            $this->delete( $batch->key );
+        }
+
+        delete_site_option( $this->get_status_key() );
+
+        $this->cancelled();
+    }
+
+    /**
+     * Cancel job on next batch.
+     */
+    public function cancel() {
+        update_site_option( $this->get_status_key(), self::STATUS_CANCELLED );
+
+        // Just in case the job was paused at the time.
+        $this->dispatch();
+    }
+
+    /**
+     * Has the process been cancelled?
+     *
+     * @return bool
+     */
+    public function is_cancelled() {
+        $status = get_site_option( $this->get_status_key(), 0 );
+
+        return absint( $status ) === self::STATUS_CANCELLED;
+    }
+
+    /**
+     * Called when background process has been cancelled.
+     */
+    protected function cancelled() {
+        do_action( $this->identifier . '_cancelled' );
+    }
+
+    /**
+     * Pause job on next batch.
+     */
+    public function pause() {
+        update_site_option( $this->get_status_key(), self::STATUS_PAUSED );
+    }
+
+    /**
+     * Is the job paused?
+     *
+     * @return bool
+     */
+    public function is_paused() {
+        $status = get_site_option( $this->get_status_key(), 0 );
+
+        return absint( $status ) === self::STATUS_PAUSED;
+    }
+
+    /**
+     * Called when background process has been paused.
+     */
+    protected function paused() {
+        do_action( $this->identifier . '_paused' );
+    }
+
+    /**
+     * Resume job.
+     */
+    public function resume() {
+        delete_site_option( $this->get_status_key() );
+
+        $this->schedule_event();
+        $this->dispatch();
+        $this->resumed();
+    }
+
+    /**
+     * Called when background process has been resumed.
+     */
+    protected function resumed() {
+        do_action( $this->identifier . '_resumed' );
+    }
+
+    /**
+     * Is queued?
+     *
+     * @return bool
+     */
+    public function is_queued() {
+        return ! $this->is_queue_empty();
+    }
+
+    /**
+     * Is the tool currently active, e.g. starting, working, paused or cleaning up?
+     *
+     * @return bool
+     */
+    public function is_active() {
+        return $this->is_queued() || $this->is_processing() || $this->is_paused() || $this->is_cancelled();
+    }
+
+    /**
+     * Generate key for a batch.
+     *
+     * Generates a unique key based on microtime. Queue items are
+     * given a unique key so that they can be merged upon save.
+     *
+     * @param int    $length Optional max length to trim key to, defaults to 64 characters.
+     * @param string $key    Optional string to append to identifier before hash, defaults to "batch".
+     *
+     * @return string
+     */
+    protected function generate_key( $length = 64, $key = 'batch' ) {
+        $unique  = md5( microtime() . wp_rand() );
+        $prepend = $this->identifier . '_' . $key . '_';
+
+        return substr( $prepend . $unique, 0, $length );
+    }
+
+    /**
+     * Get the status key.
+     *
+     * @return string
+     */
+    protected function get_status_key() {
+        return $this->identifier . '_status';
+    }
+
+    /**
+     * Maybe process a batch of queued items.
+     *
+     * Checks whether data exists within the queue and that
+     * the process is not already running.
+     */
+    public function maybe_handle() {
+        // Don't lock up other requests while processing.
+        session_write_close();
+
+        if ( $this->is_processing() ) {
+            // Background process already running.
+            return $this->maybe_wp_die();
+        }
+
+        if ( $this->is_cancelled() ) {
+            $this->clear_scheduled_event();
+            $this->delete_all();
+
+            return $this->maybe_wp_die();
+        }
+
+        if ( $this->is_paused() ) {
+            $this->clear_scheduled_event();
+            $this->paused();
+
+            return $this->maybe_wp_die();
+        }
+
+        if ( $this->is_queue_empty() ) {
+            // No data to process.
+            return $this->maybe_wp_die();
+        }
+
+        check_ajax_referer( $this->identifier, 'nonce' );
+
+        $this->handle();
+
+        return $this->maybe_wp_die();
+    }
+
+    /**
+     * Is queue empty?
+     *
+     * @return bool
+     */
+    protected function is_queue_empty() {
+        return empty( $this->get_batch() );
+    }
+
+    /**
+     * Is process running?
+     *
+     * Check whether the current process is already running
+     * in a background process.
+     *
+     * @return bool
+     *
+     * @deprecated 1.1.0 Superseded.
+     * @see        is_processing()
+     */
+    protected function is_process_running() {
+        return $this->is_processing();
+    }
+
+    /**
+     * Is the background process currently running?
+     *
+     * @return bool
+     */
+    public function is_processing() {
+        if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
+            // Process already running.
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Lock process.
+     *
+     * Lock the process so that multiple instances can't run simultaneously.
+     * Override if applicable, but the duration should be greater than that
+     * defined in the time_exceeded() method.
+     */
+    protected function lock_process() {
+        $this->start_time = time(); // Set start time of current process.
+
+        $lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
+        $lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
+
+        set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
+    }
+
+    /**
+     * Unlock process.
+     *
+     * Unlock the process so that other instances can spawn.
+     *
+     * @return $this
+     */
+    protected function unlock_process() {
+        delete_site_transient( $this->identifier . '_process_lock' );
+
+        return $this;
+    }
+
+    /**
+     * Get batch.
+     *
+     * @return stdClass Return the first batch of queued items.
+     */
+    protected function get_batch() {
+        return array_reduce(
+            $this->get_batches( 1 ),
+            static function ( $carry, $batch ) {
+                return $batch;
+            },
+            array()
+        );
+    }
+
+    /**
+     * Get batches.
+     *
+     * @param int $limit Number of batches to return, defaults to all.
+     *
+     * @return array of stdClass
+     */
+    public function get_batches( $limit = 0 ) {
+        global $wpdb;
+
+        if ( empty( $limit ) || ! is_int( $limit ) ) {
+            $limit = 0;
+        }
+
+        $table        = $wpdb->options;
+        $column       = 'option_name';
+        $key_column   = 'option_id';
+        $value_column = 'option_value';
+
+        if ( is_multisite() ) {
+            $table        = $wpdb->sitemeta;
+            $column       = 'meta_key';
+            $key_column   = 'meta_id';
+            $value_column = 'meta_value';
+        }
+
+        $key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';
+
+        $sql = '
 			SELECT *
 			FROM ' . $table . '
 			WHERE ' . $column . ' LIKE %s
 			ORDER BY ' . $key_column . ' ASC
 			';
 
-		$args = array( $key );
-
-		if ( ! empty( $limit ) ) {
-			$sql .= ' LIMIT %d';
-
-			$args[] = $limit;
-		}
-
-		$items = $wpdb->get_results( $wpdb->prepare( $sql, $args ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-
-		$batches = array();
-
-		if ( ! empty( $items ) ) {
-			$allowed_classes = $this->allowed_batch_data_classes;
-
-			$batches = array_map(
-				static function ( $item ) use ( $column, $value_column, $allowed_classes ) {
-					$batch       = new stdClass();
-					$batch->key  = $item->{$column};
-					$batch->data = static::maybe_unserialize( $item->{$value_column}, $allowed_classes );
-
-					return $batch;
-				},
-				$items
-			);
-		}
-
-		return $batches;
-	}
-
-	/**
-	 * Handle a dispatched request.
-	 *
-	 * Pass each queue item to the task handler, while remaining
-	 * within server memory and time limit constraints.
-	 */
-	protected function handle() {
-		$this->lock_process();
-
-		/**
-		 * Number of seconds to sleep between batches. Defaults to 0 seconds, minimum 0.
-		 *
-		 * @param int $seconds
-		 */
-		$throttle_seconds = max(
-			0,
-			apply_filters(
-				$this->identifier . '_seconds_between_batches',
-				apply_filters(
-					$this->prefix . '_seconds_between_batches',
-					0
-				)
-			)
-		);
-
-		do {
-			$batch = $this->get_batch();
-
-			foreach ( $batch->data as $key => $value ) {
-				$task = $this->task( $value );
-
-				if ( false !== $task ) {
-					$batch->data[ $key ] = $task;
-				} else {
-					unset( $batch->data[ $key ] );
-				}
-
-				// Keep the batch up to date while processing it.
-				if ( ! empty( $batch->data ) ) {
-					$this->update( $batch->key, $batch->data );
-				}
-
-				// Let the server breathe a little.
-				sleep( $throttle_seconds );
-
-				// Batch limits reached, or pause or cancel request.
-				if ( $this->time_exceeded() || $this->memory_exceeded() || $this->is_paused() || $this->is_cancelled() ) {
-					break;
-				}
-			}
-
-			// Delete current batch if fully processed.
-			if ( empty( $batch->data ) ) {
-				$this->delete( $batch->key );
-			}
-		} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() && ! $this->is_paused() && ! $this->is_cancelled() );
-
-		$this->unlock_process();
-
-		// Start next batch or complete process.
-		if ( ! $this->is_queue_empty() ) {
-			$this->dispatch();
-		} else {
-			$this->complete();
-		}
-
-		return $this->maybe_wp_die();
-	}
-
-	/**
-	 * Memory exceeded?
-	 *
-	 * Ensures the batch process never exceeds 90%
-	 * of the maximum WordPress memory.
-	 *
-	 * @return bool
-	 */
-	protected function memory_exceeded() {
-		$memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
-		$current_memory = memory_get_usage( true );
-		$return         = false;
-
-		if ( $current_memory >= $memory_limit ) {
-			$return = true;
-		}
-
-		return apply_filters( $this->identifier . '_memory_exceeded', $return );
-	}
-
-	/**
-	 * Get memory limit in bytes.
-	 *
-	 * @return int
-	 */
-	protected function get_memory_limit() {
-		if ( function_exists( 'ini_get' ) ) {
-			$memory_limit = ini_get( 'memory_limit' );
-		} else {
-			// Sensible default.
-			$memory_limit = '128M';
-		}
-
-		if ( ! $memory_limit || -1 === intval( $memory_limit ) ) {
-			// Unlimited, set to 32GB.
-			$memory_limit = '32000M';
-		}
-
-		return wp_convert_hr_to_bytes( $memory_limit );
-	}
-
-	/**
-	 * Time limit exceeded?
-	 *
-	 * Ensures the batch never exceeds a sensible time limit.
-	 * A timeout limit of 30s is common on shared hosting.
-	 *
-	 * @return bool
-	 */
-	protected function time_exceeded() {
-		$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
-		$return = false;
-
-		if ( time() >= $finish ) {
-			$return = true;
-		}
-
-		return apply_filters( $this->identifier . '_time_exceeded', $return );
-	}
-
-	/**
-	 * Complete processing.
-	 *
-	 * Override if applicable, but ensure that the below actions are
-	 * performed, or, call parent::complete().
-	 */
-	protected function complete() {
-		delete_site_option( $this->get_status_key() );
-
-		// Remove the cron healthcheck job from the cron schedule.
-		$this->clear_scheduled_event();
-
-		$this->completed();
-	}
-
-	/**
-	 * Called when background process has completed.
-	 */
-	protected function completed() {
-		do_action( $this->identifier . '_completed' );
-	}
-
-	/**
-	 * Get the cron healthcheck interval in minutes.
-	 *
-	 * Default is 5 minutes, minimum is 1 minute.
-	 *
-	 * @return int
-	 */
-	public function get_cron_interval() {
-		$interval = 5;
-
-		if ( property_exists( $this, 'cron_interval' ) ) {
-			$interval = $this->cron_interval;
-		}
-
-		$interval = apply_filters( $this->cron_interval_identifier, $interval );
-
-		return is_int( $interval ) && 0 < $interval ? $interval : 5;
-	}
-
-	/**
-	 * Schedule the cron healthcheck job.
-	 *
-	 * @access public
-	 *
-	 * @param mixed $schedules Schedules.
-	 *
-	 * @return mixed
-	 */
-	public function schedule_cron_healthcheck( $schedules ) {
-		$interval = $this->get_cron_interval();
-
-		if ( 1 === $interval ) {
-			$display = __( 'Every Minute' );
-		} else {
-			$display = sprintf( __( 'Every %d Minutes' ), $interval );
-		}
-
-		// Adds an "Every NNN Minute(s)" schedule to the existing cron schedules.
-		$schedules[ $this->cron_interval_identifier ] = array(
-			'interval' => MINUTE_IN_SECONDS * $interval,
-			'display'  => $display,
-		);
-
-		return $schedules;
-	}
-
-	/**
-	 * Handle cron healthcheck event.
-	 *
-	 * Restart the background process if not already running
-	 * and data exists in the queue.
-	 */
-	public function handle_cron_healthcheck() {
-		if ( $this->is_processing() ) {
-			// Background process already running.
-			exit;
-		}
-
-		if ( $this->is_queue_empty() ) {
-			// No data to process.
-			$this->clear_scheduled_event();
-			exit;
-		}
-
-		$this->dispatch();
-	}
-
-	/**
-	 * Schedule the cron healthcheck event.
-	 */
-	protected function schedule_event() {
-		if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
-			wp_schedule_event( time() + ( $this->get_cron_interval() * MINUTE_IN_SECONDS ), $this->cron_interval_identifier, $this->cron_hook_identifier );
-		}
-	}
-
-	/**
-	 * Clear scheduled cron healthcheck event.
-	 */
-	protected function clear_scheduled_event() {
-		$timestamp = wp_next_scheduled( $this->cron_hook_identifier );
-
-		if ( $timestamp ) {
-			wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
-		}
-	}
-
-	/**
-	 * Cancel the background process.
-	 *
-	 * Stop processing queue items, clear cron job and delete batch.
-	 *
-	 * @deprecated 1.1.0 Superseded.
-	 * @see        cancel()
-	 */
-	public function cancel_process() {
-		$this->cancel();
-	}
-
-	/**
-	 * Perform task with queued item.
-	 *
-	 * Override this method to perform any actions required on each
-	 * queue item. Return the modified item for further processing
-	 * in the next pass through. Or, return false to remove the
-	 * item from the queue.
-	 *
-	 * @param mixed $item Queue item to iterate over.
-	 *
-	 * @return mixed
-	 */
-	abstract protected function task( $item );
-
-	/**
-	 * Maybe unserialize data, but not if an object.
-	 *
-	 * @param mixed      $data            Data to be unserialized.
-	 * @param bool|array $allowed_classes Array of class names that can be unserialized.
-	 *
-	 * @return mixed
-	 */
-	protected static function maybe_unserialize( $data, $allowed_classes ) {
-		if ( is_serialized( $data ) ) {
-			$options = array();
-			if ( is_bool( $allowed_classes ) || is_array( $allowed_classes ) ) {
-				$options['allowed_classes'] = $allowed_classes;
-			}
-
-			return @unserialize( $data, $options ); // @phpcs:ignore
-		}
-
-		return $data;
-	}
+        $args = array( $key );
+
+        if ( ! empty( $limit ) ) {
+            $sql .= ' LIMIT %d';
+
+            $args[] = $limit;
+        }
+
+        $items = $wpdb->get_results( $wpdb->prepare( $sql, $args ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+
+        $batches = array();
+
+        if ( ! empty( $items ) ) {
+            $allowed_classes = $this->allowed_batch_data_classes;
+
+            $batches = array_map(
+                static function ( $item ) use ( $column, $value_column, $allowed_classes ) {
+                    $batch       = new stdClass();
+                    $batch->key  = $item->{$column};
+                    $batch->data = static::maybe_unserialize( $item->{$value_column}, $allowed_classes );
+
+                    return $batch;
+                },
+                $items
+            );
+        }
+
+        return $batches;
+    }
+
+    /**
+     * Handle a dispatched request.
+     *
+     * Pass each queue item to the task handler, while remaining
+     * within server memory and time limit constraints.
+     */
+    protected function handle() {
+        $this->lock_process();
+
+        /**
+         * Number of seconds to sleep between batches. Defaults to 0 seconds, minimum 0.
+         *
+         * @param int $seconds
+         */
+        $throttle_seconds = max(
+            0,
+            apply_filters(
+                $this->identifier . '_seconds_between_batches',
+                apply_filters(
+                    $this->prefix . '_seconds_between_batches',
+                    0
+                )
+            )
+        );
+
+        do {
+            $batch = $this->get_batch();
+
+            foreach ( $batch->data as $key => $value ) {
+                $task = $this->task( $value );
+
+                if ( false !== $task ) {
+                    $batch->data[ $key ] = $task;
+                } else {
+                    unset( $batch->data[ $key ] );
+                }
+
+                // Keep the batch up to date while processing it.
+                if ( ! empty( $batch->data ) ) {
+                    $this->update( $batch->key, $batch->data );
+                }
+
+                // Let the server breathe a little.
+                sleep( $throttle_seconds );
+
+                // Batch limits reached, or pause or cancel request.
+                if ( $this->time_exceeded() || $this->memory_exceeded() || $this->is_paused() || $this->is_cancelled() ) {
+                    break;
+                }
+            }
+
+            // Delete current batch if fully processed.
+            if ( empty( $batch->data ) ) {
+                $this->delete( $batch->key );
+            }
+        } while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() && ! $this->is_paused() && ! $this->is_cancelled() );
+
+        $this->unlock_process();
+
+        // Start next batch or complete process.
+        if ( ! $this->is_queue_empty() ) {
+            $this->dispatch();
+        } else {
+            $this->complete();
+        }
+
+        return $this->maybe_wp_die();
+    }
+
+    /**
+     * Memory exceeded?
+     *
+     * Ensures the batch process never exceeds 90%
+     * of the maximum WordPress memory.
+     *
+     * @return bool
+     */
+    protected function memory_exceeded() {
+        $memory_limit   = $this->get_memory_limit() * 0.9; // 90% of max memory
+        $current_memory = memory_get_usage( true );
+        $return         = false;
+
+        if ( $current_memory >= $memory_limit ) {
+            $return = true;
+        }
+
+        return apply_filters( $this->identifier . '_memory_exceeded', $return );
+    }
+
+    /**
+     * Get memory limit in bytes.
+     *
+     * @return int
+     */
+    protected function get_memory_limit() {
+        if ( function_exists( 'ini_get' ) ) {
+            $memory_limit = ini_get( 'memory_limit' );
+        } else {
+            // Sensible default.
+            $memory_limit = '128M';
+        }
+
+        if ( ! $memory_limit || -1 === intval( $memory_limit ) ) {
+            // Unlimited, set to 32GB.
+            $memory_limit = '32000M';
+        }
+
+        return wp_convert_hr_to_bytes( $memory_limit );
+    }
+
+    /**
+     * Time limit exceeded?
+     *
+     * Ensures the batch never exceeds a sensible time limit.
+     * A timeout limit of 30s is common on shared hosting.
+     *
+     * @return bool
+     */
+    protected function time_exceeded() {
+        $finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
+        $return = false;
+
+        if ( time() >= $finish ) {
+            $return = true;
+        }
+
+        return apply_filters( $this->identifier . '_time_exceeded', $return );
+    }
+
+    /**
+     * Complete processing.
+     *
+     * Override if applicable, but ensure that the below actions are
+     * performed, or, call parent::complete().
+     */
+    protected function complete() {
+        delete_site_option( $this->get_status_key() );
+
+        // Remove the cron healthcheck job from the cron schedule.
+        $this->clear_scheduled_event();
+
+        $this->completed();
+    }
+
+    /**
+     * Called when background process has completed.
+     */
+    protected function completed() {
+        do_action( $this->identifier . '_completed' );
+    }
+
+    /**
+     * Get the cron healthcheck interval in minutes.
+     *
+     * Default is 5 minutes, minimum is 1 minute.
+     *
+     * @return int
+     */
+    public function get_cron_interval() {
+        $interval = 5;
+
+        if ( property_exists( $this, 'cron_interval' ) ) {
+            $interval = $this->cron_interval;
+        }
+
+        $interval = apply_filters( $this->cron_interval_identifier, $interval );
+
+        return is_int( $interval ) && 0 < $interval ? $interval : 5;
+    }
+
+    /**
+     * Schedule the cron healthcheck job.
+     *
+     * @access public
+     *
+     * @param mixed $schedules Schedules.
+     *
+     * @return mixed
+     */
+    public function schedule_cron_healthcheck( $schedules ) {
+        $interval = $this->get_cron_interval();
+
+        if ( 1 === $interval ) {
+            $display = __( 'Every Minute' );
+        } else {
+            $display = sprintf( __( 'Every %d Minutes' ), $interval );
+        }
+
+        // Adds an "Every NNN Minute(s)" schedule to the existing cron schedules.
+        $schedules[ $this->cron_interval_identifier ] = array(
+            'interval' => MINUTE_IN_SECONDS * $interval,
+            'display'  => $display,
+        );
+
+        return $schedules;
+    }
+
+    /**
+     * Handle cron healthcheck event.
+     *
+     * Restart the background process if not already running
+     * and data exists in the queue.
+     */
+    public function handle_cron_healthcheck() {
+        if ( $this->is_processing() ) {
+            // Background process already running.
+            exit;
+        }
+
+        if ( $this->is_queue_empty() ) {
+            // No data to process.
+            $this->clear_scheduled_event();
+            exit;
+        }
+
+        $this->dispatch();
+    }
+
+    /**
+     * Schedule the cron healthcheck event.
+     */
+    protected function schedule_event() {
+        if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
+            wp_schedule_event( time() + ( $this->get_cron_interval() * MINUTE_IN_SECONDS ), $this->cron_interval_identifier, $this->cron_hook_identifier );
+        }
+    }
+
+    /**
+     * Clear scheduled cron healthcheck event.
+     */
+    protected function clear_scheduled_event() {
+        $timestamp = wp_next_scheduled( $this->cron_hook_identifier );
+
+        if ( $timestamp ) {
+            wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
+        }
+    }
+
+    /**
+     * Cancel the background process.
+     *
+     * Stop processing queue items, clear cron job and delete batch.
+     *
+     * @deprecated 1.1.0 Superseded.
+     * @see        cancel()
+     */
+    public function cancel_process() {
+        $this->cancel();
+    }
+
+    /**
+     * Perform task with queued item.
+     *
+     * Override this method to perform any actions required on each
+     * queue item. Return the modified item for further processing
+     * in the next pass through. Or, return false to remove the
+     * item from the queue.
+     *
+     * @param mixed $item Queue item to iterate over.
+     *
+     * @return mixed
+     */
+    abstract protected function task( $item );
+
+    /**
+     * Maybe unserialize data, but not if an object.
+     *
+     * @param mixed      $data            Data to be unserialized.
+     * @param bool|array $allowed_classes Array of class names that can be unserialized.
+     *
+     * @return mixed
+     */
+    protected static function maybe_unserialize( $data, $allowed_classes ) {
+        if ( is_serialized( $data ) ) {
+            $options = array();
+            if ( is_bool( $allowed_classes ) || is_array( $allowed_classes ) ) {
+                $options['allowed_classes'] = $allowed_classes;
+            }
+
+            return @unserialize( $data, $options ); // @phpcs:ignore
+        }
+
+        return $data;
+    }
 }

src/vendor/deliciousbrains/wp-background-processing/classes/wp-async-request.php

Indentation +187 added lines, -187 removed lines

@@ -12,191 +12,191 @@
  */
 abstract class WP_Async_Request {
 
-	/**
-	 * Prefix
-	 *
-	 * (default value: 'wp')
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $prefix = 'wp';
-
-	/**
-	 * Action
-	 *
-	 * (default value: 'async_request')
-	 *
-	 * @var string
-	 * @access protected
-	 */
-	protected $action = 'async_request';
-
-	/**
-	 * Identifier
-	 *
-	 * @var mixed
-	 * @access protected
-	 */
-	protected $identifier;
-
-	/**
-	 * Data
-	 *
-	 * (default value: array())
-	 *
-	 * @var array
-	 * @access protected
-	 */
-	protected $data = array();
-
-	/**
-	 * Initiate new async request.
-	 */
-	public function __construct() {
-		$this->identifier = $this->prefix . '_' . $this->action;
-
-		add_action( 'wp_ajax_' . $this->identifier, array( $this, 'maybe_handle' ) );
-		add_action( 'wp_ajax_nopriv_' . $this->identifier, array( $this, 'maybe_handle' ) );
-	}
-
-	/**
-	 * Set data used during the request.
-	 *
-	 * @param array $data Data.
-	 *
-	 * @return $this
-	 */
-	public function data( $data ) {
-		$this->data = $data;
-
-		return $this;
-	}
-
-	/**
-	 * Dispatch the async request.
-	 *
-	 * @return array|WP_Error|false HTTP Response array, WP_Error on failure, or false if not attempted.
-	 */
-	public function dispatch() {
-		$url  = add_query_arg( $this->get_query_args(), $this->get_query_url() );
-		$args = $this->get_post_args();
-
-		return wp_remote_post( esc_url_raw( $url ), $args );
-	}
-
-	/**
-	 * Get query args.
-	 *
-	 * @return array
-	 */
-	protected function get_query_args() {
-		if ( property_exists( $this, 'query_args' ) ) {
-			return $this->query_args;
-		}
-
-		$args = array(
-			'action' => $this->identifier,
-			'nonce'  => wp_create_nonce( $this->identifier ),
-		);
-
-		/**
-		 * Filters the post arguments used during an async request.
-		 *
-		 * @param array $url
-		 */
-		return apply_filters( $this->identifier . '_query_args', $args );
-	}
-
-	/**
-	 * Get query URL.
-	 *
-	 * @return string
-	 */
-	protected function get_query_url() {
-		if ( property_exists( $this, 'query_url' ) ) {
-			return $this->query_url;
-		}
-
-		$url = admin_url( 'admin-ajax.php' );
-
-		/**
-		 * Filters the post arguments used during an async request.
-		 *
-		 * @param string $url
-		 */
-		return apply_filters( $this->identifier . '_query_url', $url );
-	}
-
-	/**
-	 * Get post args.
-	 *
-	 * @return array
-	 */
-	protected function get_post_args() {
-		if ( property_exists( $this, 'post_args' ) ) {
-			return $this->post_args;
-		}
-
-		$args = array(
-			'timeout'   => 5,
-			'blocking'  => false,
-			'body'      => $this->data,
-			'cookies'   => $_COOKIE, // Passing cookies ensures request is performed as initiating user.
-			'sslverify' => apply_filters( 'https_local_ssl_verify', false ), // Local requests, fine to pass false.
-		);
-
-		/**
-		 * Filters the post arguments used during an async request.
-		 *
-		 * @param array $args
-		 */
-		return apply_filters( $this->identifier . '_post_args', $args );
-	}
-
-	/**
-	 * Maybe handle a dispatched request.
-	 *
-	 * Check for correct nonce and pass to handler.
-	 *
-	 * @return void|mixed
-	 */
-	public function maybe_handle() {
-		// Don't lock up other requests while processing.
-		session_write_close();
-
-		check_ajax_referer( $this->identifier, 'nonce' );
-
-		$this->handle();
-
-		return $this->maybe_wp_die();
-	}
-
-	/**
-	 * Should the process exit with wp_die?
-	 *
-	 * @param mixed $return What to return if filter says don't die, default is null.
-	 *
-	 * @return void|mixed
-	 */
-	protected function maybe_wp_die( $return = null ) {
-		/**
-		 * Should wp_die be used?
-		 *
-		 * @return bool
-		 */
-		if ( apply_filters( $this->identifier . '_wp_die', true ) ) {
-			wp_die();
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Handle a dispatched request.
-	 *
-	 * Override this method to perform any actions required
-	 * during the async request.
-	 */
-	abstract protected function handle();
+    /**
+     * Prefix
+     *
+     * (default value: 'wp')
+     *
+     * @var string
+     * @access protected
+     */
+    protected $prefix = 'wp';
+
+    /**
+     * Action
+     *
+     * (default value: 'async_request')
+     *
+     * @var string
+     * @access protected
+     */
+    protected $action = 'async_request';
+
+    /**
+     * Identifier
+     *
+     * @var mixed
+     * @access protected
+     */
+    protected $identifier;
+
+    /**
+     * Data
+     *
+     * (default value: array())
+     *
+     * @var array
+     * @access protected
+     */
+    protected $data = array();
+
+    /**
+     * Initiate new async request.
+     */
+    public function __construct() {
+        $this->identifier = $this->prefix . '_' . $this->action;
+
+        add_action( 'wp_ajax_' . $this->identifier, array( $this, 'maybe_handle' ) );
+        add_action( 'wp_ajax_nopriv_' . $this->identifier, array( $this, 'maybe_handle' ) );
+    }
+
+    /**
+     * Set data used during the request.
+     *
+     * @param array $data Data.
+     *
+     * @return $this
+     */
+    public function data( $data ) {
+        $this->data = $data;
+
+        return $this;
+    }
+
+    /**
+     * Dispatch the async request.
+     *
+     * @return array|WP_Error|false HTTP Response array, WP_Error on failure, or false if not attempted.
+     */
+    public function dispatch() {
+        $url  = add_query_arg( $this->get_query_args(), $this->get_query_url() );
+        $args = $this->get_post_args();
+
+        return wp_remote_post( esc_url_raw( $url ), $args );
+    }
+
+    /**
+     * Get query args.
+     *
+     * @return array
+     */
+    protected function get_query_args() {
+        if ( property_exists( $this, 'query_args' ) ) {
+            return $this->query_args;
+        }
+
+        $args = array(
+            'action' => $this->identifier,
+            'nonce'  => wp_create_nonce( $this->identifier ),
+        );
+
+        /**
+         * Filters the post arguments used during an async request.
+         *
+         * @param array $url
+         */
+        return apply_filters( $this->identifier . '_query_args', $args );
+    }
+
+    /**
+     * Get query URL.
+     *
+     * @return string
+     */
+    protected function get_query_url() {
+        if ( property_exists( $this, 'query_url' ) ) {
+            return $this->query_url;
+        }
+
+        $url = admin_url( 'admin-ajax.php' );
+
+        /**
+         * Filters the post arguments used during an async request.
+         *
+         * @param string $url
+         */
+        return apply_filters( $this->identifier . '_query_url', $url );
+    }
+
+    /**
+     * Get post args.
+     *
+     * @return array
+     */
+    protected function get_post_args() {
+        if ( property_exists( $this, 'post_args' ) ) {
+            return $this->post_args;
+        }
+
+        $args = array(
+            'timeout'   => 5,
+            'blocking'  => false,
+            'body'      => $this->data,
+            'cookies'   => $_COOKIE, // Passing cookies ensures request is performed as initiating user.
+            'sslverify' => apply_filters( 'https_local_ssl_verify', false ), // Local requests, fine to pass false.
+        );
+
+        /**
+         * Filters the post arguments used during an async request.
+         *
+         * @param array $args
+         */
+        return apply_filters( $this->identifier . '_post_args', $args );
+    }
+
+    /**
+     * Maybe handle a dispatched request.
+     *
+     * Check for correct nonce and pass to handler.
+     *
+     * @return void|mixed
+     */
+    public function maybe_handle() {
+        // Don't lock up other requests while processing.
+        session_write_close();
+
+        check_ajax_referer( $this->identifier, 'nonce' );
+
+        $this->handle();
+
+        return $this->maybe_wp_die();
+    }
+
+    /**
+     * Should the process exit with wp_die?
+     *
+     * @param mixed $return What to return if filter says don't die, default is null.
+     *
+     * @return void|mixed
+     */
+    protected function maybe_wp_die( $return = null ) {
+        /**
+         * Should wp_die be used?
+         *
+         * @return bool
+         */
+        if ( apply_filters( $this->identifier . '_wp_die', true ) ) {
+            wp_die();
+        }
+
+        return $return;
+    }
+
+    /**
+     * Handle a dispatched request.
+     *
+     * Override this method to perform any actions required
+     * during the async request.
+     */
+    abstract protected function handle();
 }

src/vendor/deliciousbrains/wp-background-processing/wp-background-processing.php

Indentation +2 added lines, -2 removed lines

@@ -17,8 +17,8 @@
  */
 
 if ( ! class_exists( 'WP_Async_Request' ) ) {
-	require_once plugin_dir_path( __FILE__ ) . 'classes/wp-async-request.php';
+    require_once plugin_dir_path( __FILE__ ) . 'classes/wp-async-request.php';
 }
 if ( ! class_exists( 'WP_Background_Process' ) ) {
-	require_once plugin_dir_path( __FILE__ ) . 'classes/wp-background-process.php';
+    require_once plugin_dir_path( __FILE__ ) . 'classes/wp-background-process.php';
 }

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

Indentation +474 added lines, -474 removed lines

@@ -20,481 +20,481 @@
  */
 class Wordlift_Jsonld_Service {
 
-	/**
-	 * Creative work types.
-	 *
-	 * @var string[]
-	 */
-	private static $creative_work_types = array(
-		'AmpStory',
-		'ArchiveComponent',
-		'Article',
-		'Atlas',
-		'Blog',
-		'Book',
-		'Chapter',
-		'Claim',
-		'Clip',
-		'Code',
-		'Collection',
-		'ComicStory',
-		'Comment',
-		'Conversation',
-		'Course',
-		'CreativeWork',
-		'CreativeWorkSeason',
-		'CreativeWorkSeries',
-		'DataCatalog',
-		'Dataset',
-		'DefinedTermSet',
-		'Diet',
-		'DigitalDocument',
-		'Drawing',
-		'EducationalOccupationalCredential',
-		'Episode',
-		'ExercisePlan',
-		'Game',
-		'Guide',
-		'HowTo',
-		'HowToDirection',
-		'HowToSection',
-		'HowToStep',
-		'HowToTip',
-		'HyperToc',
-		'HyperTocEntry',
-		'LearningResource',
-		'Legislation',
-		'Manuscript',
-		'Map',
-		'MathSolver',
-		'MediaObject',
-		'Menu',
-		'MenuSection',
-		'Message',
-		'Movie',
-		'MusicComposition',
-		'MusicPlaylist',
-		'MusicRecording',
-		'Painting',
-		'Photograph',
-		'Play',
-		'Poster',
-		'PublicationIssue',
-		'PublicationVolume',
-		'Quotation',
-		'Review',
-		'Sculpture',
-		'Season',
-		'SheetMusic',
-		'ShortStory',
-		'SoftwareApplication',
-		'SoftwareSourceCode',
-		'SpecialAnnouncement',
-		'Thesis',
-		'TvSeason',
-		'TvSeries',
-		'VisualArtwork',
-		'WebContent',
-		'WebPage',
-		'WebPageElement',
-		'WebSite',
-		'AdvertiserContentArticle',
-		'NewsArticle',
-		'Report',
-		'SatiricalArticle',
-		'ScholarlyArticle',
-		'SocialMediaPosting',
-		'TechArticle',
-		'AnalysisNewsArticle',
-		'AskPublicNewsArticle',
-		'BackgroundNewsArticle',
-		'OpinionNewsArticle',
-		'ReportageNewsArticle',
-		'ReviewNewsArticle',
-		'MedicalScholarlyArticle',
-		'BlogPosting',
-		'DiscussionForumPosting',
-		'LiveBlogPosting',
-		'ApiReference',
-		'Audiobook',
-		'MovieClip',
-		'RadioClip',
-		'TvClip',
-		'VideoGameClip',
-		'ProductCollection',
-		'ComicCoverArt',
-		'Answer',
-		'CorrectionComment',
-		'Question',
-		'PodcastSeason',
-		'RadioSeason',
-		'TvSeason',
-		'BookSeries',
-		'MovieSeries',
-		'Periodical',
-		'PodcastSeries',
-		'RadioSeries',
-		'TvSeries',
-		'VideoGameSeries',
-		'ComicSeries',
-		'Newspaper',
-		'DataFeed',
-		'CompleteDataFeed',
-		'CategoryCodeSet',
-		'NoteDigitalDocument',
-		'PresentationDigitalDocument',
-		'SpreadsheetDigitalDocument',
-		'TextDigitalDocument',
-		'PodcastEpisode',
-		'RadioEpisode',
-		'TvEpisode',
-		'VideoGame',
-		'Recipe',
-		'Course',
-		'Quiz',
-		'LegislationObject',
-		'AudioObject',
-		'DModel',
-		'DataDownload',
-		'ImageObject',
-		'LegislationObject',
-		'MusicVideoObject',
-		'VideoObject',
-		'Audiobook',
-		'Barcode',
-		'EmailMessage',
-		'MusicAlbum',
-		'MusicRelease',
-		'ComicIssue',
-		'ClaimReview',
-		'CriticReview',
-		'EmployerReview',
-		'MediaReview',
-		'Recommendation',
-		'UserReview',
-		'ReviewNewsArticle',
-		'MobileApplication',
-		'VideoGame',
-		'WebApplication',
-		'CoverArt',
-		'ComicCoverArt',
-		'HealthTopicContent',
-		'AboutPage',
-		'CheckoutPage',
-		'CollectionPage',
-		'ContactPage',
-		'FaqPage',
-		'ItemPage',
-		'MedicalWebPage',
-		'ProfilePage',
-		'QaPage',
-		'RealEstateListing',
-		'SearchResultsPage',
-		'MediaGallery',
-		'ImageGallery',
-		'VideoGallery',
-		'SiteNavigationElement',
-		'Table',
-		'WpAdBlock',
-		'WpFooter',
-		'WpHeader',
-		'WpSideBar',
-	);
-
-	/**
-	 * 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;
-
-	/**
-	 * 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_Term_JsonLd_Adapter} instance.
-	 *
-	 * @since  3.32.0
-	 * @access private
-	 * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 */
-	private $term_jsonld_adapter;
-
-	/**
-	 * 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;
-
-	/**
-	 * Create a JSON-LD service.
-	 *
-	 * @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.
-	 * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
-	 *
-	 * @since 3.8.0
-	 */
-	public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
-		$this->entity_service      = $entity_service;
-		$this->converter           = $converter;
-		$this->website_converter   = $website_converter;
-		$this->term_jsonld_adapter = $term_jsonld_adapter;
-		self::$instance            = $this;
-	}
-
-	/**
-	 * Get the singleton instance for the JSON-LD service.
-	 *
-	 * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
-	 * @since 3.15.1
-	 */
-	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.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@ob_clean();
-
-		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// 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.
-	 *
-	 * @param mixed $response Variable (usually an array or object) to encode as JSON,
-	 *                           then print and die.
-	 *
-	 * @since 3.18.5
-	 */
-	private function send_jsonld( $response ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@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.
-	 *
-	 * @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.
-	 * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
-	 *
-	 * @return array A JSON-LD structure.
-	 * @since 3.15.1
-	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
-
-		/**
-		 * Filter name: wl_before_get_jsonld
-		 *
-		 * @var bool $is_homepage Whether the JSON-LD for the homepage is being requested.
-		 * @var int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
-		 * @var int $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
-		 *
-		 * @since 3.52.7
-		 */
-		do_action( 'wl_before_get_jsonld', $is_homepage, $post_id, $context );
-
-		// 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 ) ) {
-				return array();
-			}
-
-			// 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();
-		$references_infos = array();
-
-		// Set a reference to the entity_to_jsonld_converter to use in the closures.
-		$entity_to_jsonld_converter = $this->converter;
-
-		$relations = new Relations();
-		$jsonld    = $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos, $relations );
-
-		$graph = new Graph( $jsonld, $entity_to_jsonld_converter, Wordlift_Term_JsonLd_Adapter::get_instance() );
-
-		$schema_type = is_array( $jsonld['@type'] ) ? $jsonld['@type'] : array( $jsonld['@type'] );
-
-		// Add `about`/`mentions` only for `CreativeWork` and descendants.
-		if ( array_intersect( $schema_type, self::$creative_work_types ) ) {
-
-			foreach ( $relations->toArray() as $relation ) {
-
-				// Setting about or mentions by label match is currently supported only for posts
-				if ( Object_Type_Enum::POST !== $relation->get_object()->get_type() ) {
-					continue;
-				}
-
-				// Add the `mentions`/`about` prop.
-				$this->add_mention_or_about( $jsonld, $post_id, $relation );
-			}
-			$graph->set_main_jsonld( $jsonld );
-		}
-
-		$jsonld_arr = $graph->add_references( $references )
-							->add_relations( $relations )
-							->add_required_reference_infos( $references_infos )
-							->render( $context );
-
-		/**
-		 * Filter name: wl_after_get_jsonld
-		 *
-		 * @return array
-		 * @since 3.27.2
-		 * @var $jsonld_arr array The final jsonld before outputting to page.
-		 * @var $post_id int The post id for which the jsonld is generated.
-		 */
-		$jsonld_arr = apply_filters( 'wl_after_get_jsonld', $jsonld_arr, $post_id, $context );
-
-		return $jsonld_arr;
-	}
-
-	/**
-	 * 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 = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
-		?>
+    /**
+     * Creative work types.
+     *
+     * @var string[]
+     */
+    private static $creative_work_types = array(
+        'AmpStory',
+        'ArchiveComponent',
+        'Article',
+        'Atlas',
+        'Blog',
+        'Book',
+        'Chapter',
+        'Claim',
+        'Clip',
+        'Code',
+        'Collection',
+        'ComicStory',
+        'Comment',
+        'Conversation',
+        'Course',
+        'CreativeWork',
+        'CreativeWorkSeason',
+        'CreativeWorkSeries',
+        'DataCatalog',
+        'Dataset',
+        'DefinedTermSet',
+        'Diet',
+        'DigitalDocument',
+        'Drawing',
+        'EducationalOccupationalCredential',
+        'Episode',
+        'ExercisePlan',
+        'Game',
+        'Guide',
+        'HowTo',
+        'HowToDirection',
+        'HowToSection',
+        'HowToStep',
+        'HowToTip',
+        'HyperToc',
+        'HyperTocEntry',
+        'LearningResource',
+        'Legislation',
+        'Manuscript',
+        'Map',
+        'MathSolver',
+        'MediaObject',
+        'Menu',
+        'MenuSection',
+        'Message',
+        'Movie',
+        'MusicComposition',
+        'MusicPlaylist',
+        'MusicRecording',
+        'Painting',
+        'Photograph',
+        'Play',
+        'Poster',
+        'PublicationIssue',
+        'PublicationVolume',
+        'Quotation',
+        'Review',
+        'Sculpture',
+        'Season',
+        'SheetMusic',
+        'ShortStory',
+        'SoftwareApplication',
+        'SoftwareSourceCode',
+        'SpecialAnnouncement',
+        'Thesis',
+        'TvSeason',
+        'TvSeries',
+        'VisualArtwork',
+        'WebContent',
+        'WebPage',
+        'WebPageElement',
+        'WebSite',
+        'AdvertiserContentArticle',
+        'NewsArticle',
+        'Report',
+        'SatiricalArticle',
+        'ScholarlyArticle',
+        'SocialMediaPosting',
+        'TechArticle',
+        'AnalysisNewsArticle',
+        'AskPublicNewsArticle',
+        'BackgroundNewsArticle',
+        'OpinionNewsArticle',
+        'ReportageNewsArticle',
+        'ReviewNewsArticle',
+        'MedicalScholarlyArticle',
+        'BlogPosting',
+        'DiscussionForumPosting',
+        'LiveBlogPosting',
+        'ApiReference',
+        'Audiobook',
+        'MovieClip',
+        'RadioClip',
+        'TvClip',
+        'VideoGameClip',
+        'ProductCollection',
+        'ComicCoverArt',
+        'Answer',
+        'CorrectionComment',
+        'Question',
+        'PodcastSeason',
+        'RadioSeason',
+        'TvSeason',
+        'BookSeries',
+        'MovieSeries',
+        'Periodical',
+        'PodcastSeries',
+        'RadioSeries',
+        'TvSeries',
+        'VideoGameSeries',
+        'ComicSeries',
+        'Newspaper',
+        'DataFeed',
+        'CompleteDataFeed',
+        'CategoryCodeSet',
+        'NoteDigitalDocument',
+        'PresentationDigitalDocument',
+        'SpreadsheetDigitalDocument',
+        'TextDigitalDocument',
+        'PodcastEpisode',
+        'RadioEpisode',
+        'TvEpisode',
+        'VideoGame',
+        'Recipe',
+        'Course',
+        'Quiz',
+        'LegislationObject',
+        'AudioObject',
+        'DModel',
+        'DataDownload',
+        'ImageObject',
+        'LegislationObject',
+        'MusicVideoObject',
+        'VideoObject',
+        'Audiobook',
+        'Barcode',
+        'EmailMessage',
+        'MusicAlbum',
+        'MusicRelease',
+        'ComicIssue',
+        'ClaimReview',
+        'CriticReview',
+        'EmployerReview',
+        'MediaReview',
+        'Recommendation',
+        'UserReview',
+        'ReviewNewsArticle',
+        'MobileApplication',
+        'VideoGame',
+        'WebApplication',
+        'CoverArt',
+        'ComicCoverArt',
+        'HealthTopicContent',
+        'AboutPage',
+        'CheckoutPage',
+        'CollectionPage',
+        'ContactPage',
+        'FaqPage',
+        'ItemPage',
+        'MedicalWebPage',
+        'ProfilePage',
+        'QaPage',
+        'RealEstateListing',
+        'SearchResultsPage',
+        'MediaGallery',
+        'ImageGallery',
+        'VideoGallery',
+        'SiteNavigationElement',
+        'Table',
+        'WpAdBlock',
+        'WpFooter',
+        'WpHeader',
+        'WpSideBar',
+    );
+
+    /**
+     * 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;
+
+    /**
+     * 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_Term_JsonLd_Adapter} instance.
+     *
+     * @since  3.32.0
+     * @access private
+     * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     */
+    private $term_jsonld_adapter;
+
+    /**
+     * 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;
+
+    /**
+     * Create a JSON-LD service.
+     *
+     * @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.
+     * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
+     *
+     * @since 3.8.0
+     */
+    public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
+        $this->entity_service      = $entity_service;
+        $this->converter           = $converter;
+        $this->website_converter   = $website_converter;
+        $this->term_jsonld_adapter = $term_jsonld_adapter;
+        self::$instance            = $this;
+    }
+
+    /**
+     * Get the singleton instance for the JSON-LD service.
+     *
+     * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
+     * @since 3.15.1
+     */
+    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.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @ob_clean();
+
+        // Get the parameter from the request.
+        $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // 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.
+     *
+     * @param mixed $response Variable (usually an array or object) to encode as JSON,
+     *                           then print and die.
+     *
+     * @since 3.18.5
+     */
+    private function send_jsonld( $response ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @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.
+     *
+     * @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.
+     * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
+     *
+     * @return array A JSON-LD structure.
+     * @since 3.15.1
+     */
+    public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
+
+        /**
+         * Filter name: wl_before_get_jsonld
+         *
+         * @var bool $is_homepage Whether the JSON-LD for the homepage is being requested.
+         * @var int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
+         * @var int $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
+         *
+         * @since 3.52.7
+         */
+        do_action( 'wl_before_get_jsonld', $is_homepage, $post_id, $context );
+
+        // 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 ) ) {
+                return array();
+            }
+
+            // 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();
+        $references_infos = array();
+
+        // Set a reference to the entity_to_jsonld_converter to use in the closures.
+        $entity_to_jsonld_converter = $this->converter;
+
+        $relations = new Relations();
+        $jsonld    = $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos, $relations );
+
+        $graph = new Graph( $jsonld, $entity_to_jsonld_converter, Wordlift_Term_JsonLd_Adapter::get_instance() );
+
+        $schema_type = is_array( $jsonld['@type'] ) ? $jsonld['@type'] : array( $jsonld['@type'] );
+
+        // Add `about`/`mentions` only for `CreativeWork` and descendants.
+        if ( array_intersect( $schema_type, self::$creative_work_types ) ) {
+
+            foreach ( $relations->toArray() as $relation ) {
+
+                // Setting about or mentions by label match is currently supported only for posts
+                if ( Object_Type_Enum::POST !== $relation->get_object()->get_type() ) {
+                    continue;
+                }
+
+                // Add the `mentions`/`about` prop.
+                $this->add_mention_or_about( $jsonld, $post_id, $relation );
+            }
+            $graph->set_main_jsonld( $jsonld );
+        }
+
+        $jsonld_arr = $graph->add_references( $references )
+                            ->add_relations( $relations )
+                            ->add_required_reference_infos( $references_infos )
+                            ->render( $context );
+
+        /**
+         * Filter name: wl_after_get_jsonld
+         *
+         * @return array
+         * @since 3.27.2
+         * @var $jsonld_arr array The final jsonld before outputting to page.
+         * @var $post_id int The post id for which the jsonld is generated.
+         */
+        $jsonld_arr = apply_filters( 'wl_after_get_jsonld', $jsonld_arr, $post_id, $context );
+
+        return $jsonld_arr;
+    }
+
+    /**
+     * 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 = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
+        ?>
 		<script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script>
 		<?php
-	}
-
-	/**
-	 * @param array    $jsonld
-	 * @param Relation $relation
-	 *
-	 * @return void
-	 */
-	private function add_mention_or_about( &$jsonld, $post_id, $relation ) {
-		$content_service = Wordpress_Content_Service::get_instance();
-		$entity_service  = Wordlift_Entity_Service::get_instance();
-
-		$object     = $relation->get_object();
-		$entity_uri = $content_service->get_entity_id( $object );
-		$labels     = $entity_service->get_labels( $object->get_id(), $object->get_type() );
-
-		$escaped_labels = array_map(
-			function ( $value ) {
-				return preg_quote( $value, '/' );
-			},
-			$labels
-		);
-
-		$matches = false;
-
-		// When the title is empty, then we shouldn't yield a match to about section.
-		if ( array_filter( $escaped_labels ) ) {
-			// Check if the labels match any part of the title.
-			$post    = get_post( $post_id );
-			$matches = $this->check_title_match( $escaped_labels, $post->post_title );
-		}
-
-		if ( $entity_uri ) {
-			// If the title matches, assign the entity to the about, otherwise to the mentions.
-			$property_name              = $matches ? 'about' : 'mentions';
-			$jsonld[ $property_name ]   = isset( $jsonld[ $property_name ] ) ? (array) $jsonld[ $property_name ] : array();
-			$jsonld[ $property_name ][] = array( '@id' => $entity_uri );
-		}
-
-	}
-
-	/**
-	 * Check if the labels match any part of the title.
-	 *
-	 * @param $labels array The labels to check.
-	 * @param $title string The title to check.
-	 *
-	 * @return boolean
-	 */
-	public function check_title_match( $labels, $title ) {
-
-		// If the title is empty, then we shouldn't yield a match to about section.
-		if ( empty( $title ) ) {
-			return false;
-		}
-
-		// Check if the labels match any part of the title.
-		return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
-
-	}
+    }
+
+    /**
+     * @param array    $jsonld
+     * @param Relation $relation
+     *
+     * @return void
+     */
+    private function add_mention_or_about( &$jsonld, $post_id, $relation ) {
+        $content_service = Wordpress_Content_Service::get_instance();
+        $entity_service  = Wordlift_Entity_Service::get_instance();
+
+        $object     = $relation->get_object();
+        $entity_uri = $content_service->get_entity_id( $object );
+        $labels     = $entity_service->get_labels( $object->get_id(), $object->get_type() );
+
+        $escaped_labels = array_map(
+            function ( $value ) {
+                return preg_quote( $value, '/' );
+            },
+            $labels
+        );
+
+        $matches = false;
+
+        // When the title is empty, then we shouldn't yield a match to about section.
+        if ( array_filter( $escaped_labels ) ) {
+            // Check if the labels match any part of the title.
+            $post    = get_post( $post_id );
+            $matches = $this->check_title_match( $escaped_labels, $post->post_title );
+        }
+
+        if ( $entity_uri ) {
+            // If the title matches, assign the entity to the about, otherwise to the mentions.
+            $property_name              = $matches ? 'about' : 'mentions';
+            $jsonld[ $property_name ]   = isset( $jsonld[ $property_name ] ) ? (array) $jsonld[ $property_name ] : array();
+            $jsonld[ $property_name ][] = array( '@id' => $entity_uri );
+        }
+
+    }
+
+    /**
+     * Check if the labels match any part of the title.
+     *
+     * @param $labels array The labels to check.
+     * @param $title string The title to check.
+     *
+     * @return boolean
+     */
+    public function check_title_match( $labels, $title ) {
+
+        // If the title is empty, then we shouldn't yield a match to about section.
+        if ( empty( $title ) ) {
+            return false;
+        }
+
+        // Check if the labels match any part of the title.
+        return 1 === preg_match( '/\b(' . implode( '|', $labels ) . ')\b/iu', $title );
+
+    }
 
 }

src/includes/class-wordlift-post-to-jsonld-converter.php

Indentation +440 added lines, -440 removed lines

@@ -18,470 +18,470 @@
  */
 class Wordlift_Post_To_Jsonld_Converter extends Wordlift_Abstract_Post_To_Jsonld_Converter {
 
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * @var false
-	 */
-	private $disable_convert_filters;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
-	 * @param Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.10.0
-	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
-		parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
-		$this->disable_convert_filters = $disable_convert_filters;
-		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
-
-		self::$instance = $this;
-
-	}
-
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	public function new_instance_with_filters_disabled() {
-		return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int              $post_id The post id.
-	 * @param array<Reference> $references An array of entity references.
-	 * @param array            $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), $relations = null ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references, $references_infos, $relations );
-
-		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
-			$jsonld['@type'] = 'WebPage';
-		}
-
-		// Get the entity name.
-		$jsonld['headline'] = $post->post_title;
-
-		// Convert entities as `Article`.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/1731
-		$custom_fields = Wordlift_Entity_Service::get_instance()->is_entity( $post_id )
-			? $this->entity_type_service->get_custom_fields_for_term( $this->entity_type_service->get_term_by_slug( 'article' ) )
-			: $this->entity_type_service->get_custom_fields_for_post( $post_id );
-
-		if ( isset( $custom_fields ) ) {
-			$this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
-		}
-
-		// Set the published and modified dates.
-		/*
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * @var false
+     */
+    private $disable_convert_filters;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
+     * @param Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.10.0
+     */
+    public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
+        parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
+        $this->disable_convert_filters = $disable_convert_filters;
+        // Set a reference to the logger.
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+
+        self::$instance = $this;
+
+    }
+
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    public function new_instance_with_filters_disabled() {
+        return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int              $post_id The post id.
+     * @param array<Reference> $references An array of entity references.
+     * @param array            $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    public function convert( $post_id, &$references = array(), &$references_infos = array(), $relations = null ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the base JSON-LD and the list of entities referenced by this entity.
+        $jsonld = parent::convert( $post_id, $references, $references_infos, $relations );
+
+        // Set WebPage by default.
+        if ( empty( $jsonld['@type'] ) ) {
+            $jsonld['@type'] = 'WebPage';
+        }
+
+        // Get the entity name.
+        $jsonld['headline'] = $post->post_title;
+
+        // Convert entities as `Article`.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/1731
+        $custom_fields = Wordlift_Entity_Service::get_instance()->is_entity( $post_id )
+            ? $this->entity_type_service->get_custom_fields_for_term( $this->entity_type_service->get_term_by_slug( 'article' ) )
+            : $this->entity_type_service->get_custom_fields_for_post( $post_id );
+
+        if ( isset( $custom_fields ) ) {
+            $this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
+        }
+
+        // Set the published and modified dates.
+        /*
 		 * Set the `datePublished` and `dateModified` using the local timezone.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/887
 		 *
 		 * @since 3.20.0
 		 */
-		try {
-			$default_timezone = date_default_timezone_get();
-			$timezone         = get_option( 'timezone_string' );
-			if ( ! empty( $timezone ) ) {
-				date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-				date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-			} else {
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-			}
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-		}
-
-		// Get the word count for the post.
-		/*
+        try {
+            $default_timezone = date_default_timezone_get();
+            $timezone         = get_option( 'timezone_string' );
+            if ( ! empty( $timezone ) ) {
+                date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
+                date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+            } else {
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+            }
+        } catch ( Exception $e ) {
+            $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+            $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+        }
+
+        // Get the word count for the post.
+        /*
 		 * Do not display the `wordCount` on a `WebPage`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/888
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
-			$jsonld['wordCount'] = $post_adapter->word_count();
-		}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter        = new Wordlift_Post_Adapter( $post_id );
+            $jsonld['wordCount'] = $post_adapter->word_count();
+        }
 
-		/*
+        /*
 		 * Add keywords, articleSection, commentCount and inLanguage properties to `Article` JSON-LD
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1140
 		 *
 		 * @since 3.27.2
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter    = new Wordlift_Post_Adapter( $post_id );
-			$keywords        = $post_adapter->keywords();
-			$article_section = $post_adapter->article_section();
-			$comment_count   = $post_adapter->comment_count();
-			$locale          = $post_adapter->locale();
-
-			if ( isset( $keywords ) ) {
-				$jsonld['keywords'] = $keywords;
-			}
-			if ( ! empty( $article_section ) ) {
-				$jsonld['articleSection'] = $article_section;
-			}
-			$jsonld['commentCount'] = $comment_count;
-			$jsonld['inLanguage']   = $locale;
-		}
-
-		// Set the publisher.
-		$this->set_publisher( $jsonld );
-
-		/**
-		 * Call the `wl_post_jsonld_author` filter.
-		 *
-		 * This filter checks if there are co-authors or a single author and
-		 * returns a JSON-LD fragment for the author(s).
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * }
-		 *
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 *
-		 * @since 3.51.4
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 */
-		$ret_val = apply_filters(
-			'wl_jsonld_author',
-			array(
-				'author'     => $this->get_author( $post->post_author, $references ),
-				'references' => $references,
-			),
-			$post_id
-		);
-
-		// Set the values returned by the author filter.
-		/*
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter    = new Wordlift_Post_Adapter( $post_id );
+            $keywords        = $post_adapter->keywords();
+            $article_section = $post_adapter->article_section();
+            $comment_count   = $post_adapter->comment_count();
+            $locale          = $post_adapter->locale();
+
+            if ( isset( $keywords ) ) {
+                $jsonld['keywords'] = $keywords;
+            }
+            if ( ! empty( $article_section ) ) {
+                $jsonld['articleSection'] = $article_section;
+            }
+            $jsonld['commentCount'] = $comment_count;
+            $jsonld['inLanguage']   = $locale;
+        }
+
+        // Set the publisher.
+        $this->set_publisher( $jsonld );
+
+        /**
+         * Call the `wl_post_jsonld_author` filter.
+         *
+         * This filter checks if there are co-authors or a single author and
+         * returns a JSON-LD fragment for the author(s).
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * }
+         *
+         * @param int $post_id The {@link WP_Post} `id`.
+         *
+         * @since 3.51.4
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         */
+        $ret_val = apply_filters(
+            'wl_jsonld_author',
+            array(
+                'author'     => $this->get_author( $post->post_author, $references ),
+                'references' => $references,
+            ),
+            $post_id
+        );
+
+        // Set the values returned by the author filter.
+        /*
 		 * Do not add the author JSON-LD if an invalid author was referenced in a post.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1728
 		 *
 		 * @since 3.53.2
 		 */
-		if ( ! empty( $ret_val['author'] ) ) {
-			$jsonld['author'] = $ret_val['author'];
-			$references       = $ret_val['references'];
-		}
-
-		// Return the JSON-LD if filters are disabled by the client.
-		if ( $this->disable_convert_filters ) {
-			return $jsonld;
-		}
-
-		/**
-		 * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * @type Relations $relations A set of `Relation`s.
-		 * }
-		 * @since 3.25.0
-		 * @since 3.43.0 The filter provides a `Relations` instance.
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 *
-		 * @api
-		 */
-		$ret_val = apply_filters(
-			'wl_post_jsonld_array',
-			array(
-				'jsonld'           => $jsonld,
-				'references'       => $references, // This one is only an array of post IDs.
-				'references_infos' => $references_infos,
-				'relations'        => $relations,
-			),
-			$post_id
-		);
-
-		$jsonld     = $ret_val['jsonld'];
-		$references = $ret_val['references'];
-
-		/**
-		 * Call the `wl_post_jsonld` filter.
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 * @param array $references The array of referenced entities.
-		 *
-		 * @since 3.14.0
-		 *
-		 * @api
-		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
-	}
-
-	/**
-	 * Get the author's JSON-LD fragment.
-	 *
-	 * The JSON-LD fragment is generated using the {@link WP_User}'s data or
-	 * the referenced entity if configured for the {@link WP_User}.
-	 *
-	 * @param int   $author_id The author {@link WP_User}'s `id`.
-	 * @param array $references An array of referenced entities.
-	 *
-	 * @return string|array A JSON-LD structure.
-	 * @since 3.14.0
-	 */
-	public function get_author( $author_id, &$references ) {
-
-		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
-
-		if ( ! empty( $entity_id ) && 'publish' === get_post_status( $entity_id ) ) {
-			// Add the author to the references.
-			$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
-			$references[] = $entity_id;
-
-			// Return the JSON-LD for the referenced entity.
-			return array(
-				'@id' => $author_uri,
-			);
-		}
-
-		// If there's no entity bound return a simple author structure.
-		if ( false !== get_userdata( $author_id ) ) {
-			$author            = get_the_author_meta( 'display_name', $author_id );
-			$author_first_name = get_the_author_meta( 'first_name', $author_id );
-			$author_last_name  = get_the_author_meta( 'last_name', $author_id );
-			$author_uri        = $this->user_service->get_uri( $author_id );
-
-			return array(
-				'@type'      => 'Person',
-				'@id'        => $author_uri,
-				'name'       => $author,
-				'givenName'  => $author_first_name,
-				'familyName' => $author_last_name,
-				'url'        => get_author_posts_url( $author_id ),
-			);
-		}
-
-		// No valid entity or author so return empty array
-		return array();
-	}
-
-	/**
-	 * Enrich the provided params array with publisher data, if available.
-	 *
-	 * @param array $params The parameters array.
-	 *
-	 * @since 3.10.0
-	 */
-	protected function set_publisher( &$params ) {
-
-		// If the publisher id isn't set don't do anything.
-		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-		if ( empty( $publisher_id ) ) {
-			return;
-		}
-
-		// Get the post instance.
-		$post = get_post( $publisher_id );
-		if ( ! is_a( $post, '\WP_Post' ) ) {
-			// Publisher not found.
-			return;
-		}
-
-		// Get the item id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
-
-		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
-
-		// Get the name.
-		$name = $post->post_title;
-
-		// Set the publisher data.
-		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
-			'@id'   => $id,
-			'name'  => $name,
-		);
-
-		// Add the sameAs values associated with the publisher.
-		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
-			$params['publisher']['sameAs'] = $sameas;
-		}
-
-		// Set the logo, only for http://schema.org/Organization as Person doesn't
-		// support the logo property.
-		//
-		// See http://schema.org/logo.
-		if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
-			return;
-		}
-
-		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
-
-		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
-			return;
-		}
-
-		// Copy over some useful properties.
-		//
-		// See https://developers.google.com/search/docs/data-types/articles.
-		$params['publisher']['logo']['@type'] = 'ImageObject';
-		$params['publisher']['logo']['url']   = $publisher_logo['url'];
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		$params['publisher']['logo']['width']  = $publisher_logo['width'];
-		$params['publisher']['logo']['height'] = $publisher_logo['height'];
-
-	}
-
-	/**
-	 * Get the publisher logo structure.
-	 *
-	 * The function returns false when the publisher logo cannot be determined, i.e.:
-	 *  - the post has no featured image.
-	 *  - the featured image has no file.
-	 *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
-	 *  of errors.
-	 * @since 3.19.2
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
-	 */
-	private function get_publisher_logo( $post_id ) {
-
-		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
-
-		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
-
-			return false;
-		}
-
-		// Get the uploads base URL.
-		$uploads_dir = wp_upload_dir();
-
-		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
-
-		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
-
-			return false;
-		}
-
-		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
-
-		// Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
-
-			$attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
-			if ( $attachment_image_src ) {
-				return array(
-					'url'    => $attachment_image_src[0],
-					'width'  => $attachment_image_src[1],
-					'height' => $attachment_image_src[2],
-				);
-			}
-
-			// Bail out if we cant fetch wp_get_attachment_image_src
-			return false;
-
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
-
-			return false;
-		}
-
-		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
-		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
-
-		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
-
-			return false;
-		}
-
-		// Get the actual size.
-		$size = $publisher_logo_editor->get_size();
-
-		// Finally return the array with data.
-		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
-			'width'  => $size['width'],
-			'height' => $size['height'],
-		);
-	}
+        if ( ! empty( $ret_val['author'] ) ) {
+            $jsonld['author'] = $ret_val['author'];
+            $references       = $ret_val['references'];
+        }
+
+        // Return the JSON-LD if filters are disabled by the client.
+        if ( $this->disable_convert_filters ) {
+            return $jsonld;
+        }
+
+        /**
+         * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * @type Relations $relations A set of `Relation`s.
+         * }
+         * @since 3.25.0
+         * @since 3.43.0 The filter provides a `Relations` instance.
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         *
+         * @api
+         */
+        $ret_val = apply_filters(
+            'wl_post_jsonld_array',
+            array(
+                'jsonld'           => $jsonld,
+                'references'       => $references, // This one is only an array of post IDs.
+                'references_infos' => $references_infos,
+                'relations'        => $relations,
+            ),
+            $post_id
+        );
+
+        $jsonld     = $ret_val['jsonld'];
+        $references = $ret_val['references'];
+
+        /**
+         * Call the `wl_post_jsonld` filter.
+         *
+         * @param array $jsonld The JSON-LD structure.
+         * @param int $post_id The {@link WP_Post} `id`.
+         * @param array $references The array of referenced entities.
+         *
+         * @since 3.14.0
+         *
+         * @api
+         */
+        return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+    }
+
+    /**
+     * Get the author's JSON-LD fragment.
+     *
+     * The JSON-LD fragment is generated using the {@link WP_User}'s data or
+     * the referenced entity if configured for the {@link WP_User}.
+     *
+     * @param int   $author_id The author {@link WP_User}'s `id`.
+     * @param array $references An array of referenced entities.
+     *
+     * @return string|array A JSON-LD structure.
+     * @since 3.14.0
+     */
+    public function get_author( $author_id, &$references ) {
+
+        // Get the entity bound to this user.
+        $entity_id = $this->user_service->get_entity( $author_id );
+
+        if ( ! empty( $entity_id ) && 'publish' === get_post_status( $entity_id ) ) {
+            // Add the author to the references.
+            $author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
+            $references[] = $entity_id;
+
+            // Return the JSON-LD for the referenced entity.
+            return array(
+                '@id' => $author_uri,
+            );
+        }
+
+        // If there's no entity bound return a simple author structure.
+        if ( false !== get_userdata( $author_id ) ) {
+            $author            = get_the_author_meta( 'display_name', $author_id );
+            $author_first_name = get_the_author_meta( 'first_name', $author_id );
+            $author_last_name  = get_the_author_meta( 'last_name', $author_id );
+            $author_uri        = $this->user_service->get_uri( $author_id );
+
+            return array(
+                '@type'      => 'Person',
+                '@id'        => $author_uri,
+                'name'       => $author,
+                'givenName'  => $author_first_name,
+                'familyName' => $author_last_name,
+                'url'        => get_author_posts_url( $author_id ),
+            );
+        }
+
+        // No valid entity or author so return empty array
+        return array();
+    }
+
+    /**
+     * Enrich the provided params array with publisher data, if available.
+     *
+     * @param array $params The parameters array.
+     *
+     * @since 3.10.0
+     */
+    protected function set_publisher( &$params ) {
+
+        // If the publisher id isn't set don't do anything.
+        $publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
+        if ( empty( $publisher_id ) ) {
+            return;
+        }
+
+        // Get the post instance.
+        $post = get_post( $publisher_id );
+        if ( ! is_a( $post, '\WP_Post' ) ) {
+            // Publisher not found.
+            return;
+        }
+
+        // Get the item id.
+        $id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
+
+        // Get the type.
+        $type = $this->entity_type_service->get( $publisher_id );
+
+        // Get the name.
+        $name = $post->post_title;
+
+        // Set the publisher data.
+        $params['publisher'] = array(
+            '@type' => $this->relative_to_context( $type['uri'] ),
+            '@id'   => $id,
+            'name'  => $name,
+        );
+
+        // Add the sameAs values associated with the publisher.
+        $storage_factory = Wordlift_Storage_Factory::get_instance();
+        $sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
+        if ( ! empty( $sameas ) ) {
+            $params['publisher']['sameAs'] = $sameas;
+        }
+
+        // Set the logo, only for http://schema.org/Organization as Person doesn't
+        // support the logo property.
+        //
+        // See http://schema.org/logo.
+        if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
+            return;
+        }
+
+        // Get the publisher logo.
+        $publisher_logo = $this->get_publisher_logo( $post->ID );
+
+        // Bail out if the publisher logo isn't set.
+        if ( false === $publisher_logo ) {
+            return;
+        }
+
+        // Copy over some useful properties.
+        //
+        // See https://developers.google.com/search/docs/data-types/articles.
+        $params['publisher']['logo']['@type'] = 'ImageObject';
+        $params['publisher']['logo']['url']   = $publisher_logo['url'];
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        $params['publisher']['logo']['width']  = $publisher_logo['width'];
+        $params['publisher']['logo']['height'] = $publisher_logo['height'];
+
+    }
+
+    /**
+     * Get the publisher logo structure.
+     *
+     * The function returns false when the publisher logo cannot be determined, i.e.:
+     *  - the post has no featured image.
+     *  - the featured image has no file.
+     *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
+     *  of errors.
+     * @since 3.19.2
+     * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
+     */
+    private function get_publisher_logo( $post_id ) {
+
+        // Get the featured image for the post.
+        $thumbnail_id = get_post_thumbnail_id( $post_id );
+
+        // Bail out if thumbnail not available.
+        if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
+            $this->log->info( "Featured image not set for post $post_id." );
+
+            return false;
+        }
+
+        // Get the uploads base URL.
+        $uploads_dir = wp_upload_dir();
+
+        // Get the attachment metadata.
+        $metadata = wp_get_attachment_metadata( $thumbnail_id );
+
+        // Bail out if the file isn't set.
+        if ( ! isset( $metadata['file'] ) ) {
+            $this->log->warn( "Featured image file not found for post $post_id." );
+
+            return false;
+        }
+
+        // Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
+        $path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+
+        // Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
+        if ( ! file_exists( $path ) ) {
+            $this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+
+            $attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
+            if ( $attachment_image_src ) {
+                return array(
+                    'url'    => $attachment_image_src[0],
+                    'width'  => $attachment_image_src[1],
+                    'height' => $attachment_image_src[2],
+                );
+            }
+
+            // Bail out if we cant fetch wp_get_attachment_image_src
+            return false;
+
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $original_file_editor = wp_get_image_editor( $path );
+        if ( is_wp_error( $original_file_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+
+            return false;
+        }
+
+        // Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
+        // and we don't actually know the end values.
+        $publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+
+        // If the file doesn't exist yet, create it.
+        if ( ! file_exists( $publisher_logo_path ) ) {
+            $original_file_editor->resize( 600, 60 );
+            $original_file_editor->save( $publisher_logo_path );
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
+        if ( is_wp_error( $publisher_logo_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+
+            return false;
+        }
+
+        // Get the actual size.
+        $size = $publisher_logo_editor->get_size();
+
+        // Finally return the array with data.
+        return array(
+            'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+            'width'  => $size['width'],
+            'height' => $size['height'],
+        );
+    }
 
 }

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

Indentation +468 added lines, -468 removed lines

@@ -19,147 +19,147 @@ 
  */
 class Wordlift_Entity_Type_Service {
 
-	/**
-	 * The {@link Wordlift_Schema_Service} instance.
-	 *
-	 * @since  3.7.0
-	 * @access private
-	 * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
-	 */
-	private $schema_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Wordlift_Entity_Type_Service constructor.
-	 *
-	 * @since 3.7.0
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
-
-		$this->schema_service = Wordlift_Schema_Service::get_instance();
-
-		$this->prepare_post_types();
-
-	}
-
-	/**
-	 * Prepare post types for Gutenberg use
-	 *
-	 * @since 3.26.0
-	 */
-	private function prepare_post_types() {
-
-		add_action(
-			'init',
-			function () {
-				// Add post type support for 'custom-fields' for all post types. Specifically needed in Gutenberg
-				$post_types = get_post_types();
-				foreach ( $post_types as $post_type ) {
-					add_post_type_support( $post_type, 'custom-fields' );
-				}
-			}
-		);
-	}
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} singleton instance.
-	 *
-	 * @since  3.7.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $instance The {@link Wordlift_Entity_Type_Service} singleton instance.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the {@link Wordlift_Entity_Type_Service} singleton instance.
-	 *
-	 * @return \Wordlift_Entity_Type_Service The {@link Wordlift_Entity_Type_Service} singleton instance.
-	 * @since 3.7.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the types associated with the specified entity post id.
-	 *
-	 * We have a strategy to define the entity type, given that everything is
-	 * an entity, i.e. also posts/pages and custom post types.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|null {
-	 * An array of type properties or null if no term is associated
-	 *
-	 * @type string css_class     The css class, e.g. `wl-thing`.
-	 * @type string uri           The schema.org class URI, e.g. `http://schema.org/Thing`.
-	 * @type array  same_as       An array of same as attributes.
-	 * @type array  custom_fields An array of custom fields.
-	 * }
-	 * @since 3.33.9 The `linked_data` key has been removed.
-	 *
-	 * @since 3.20.0 This function will **not** return entity types introduced with 3.20.0.
-	 *
-	 * @since 3.18.0 The cases are the following:
-	 *  1. the post has a term from the Entity Types Taxonomy: the term defines
-	 *     the entity type, e.g. Organization, Person, ...
-	 *  2. the post doesn't have a term from the Entity Types Taxonomy:
-	 *      a) the post is a `wl_entity` custom post type, then the post is
-	 *           assigned the `Thing` entity type by default.
-	 *      b) the post is a `post` post type, then the post is
-	 *           assigned the `Article` entity type by default.
-	 *      c) the post is a custom post type then it is
-	 *          assigned the `WebPage` entity type by default.
-	 */
-	public function get( $post_id ) {
-
-		$this->log->trace( "Getting the post type for post $post_id..." );
-
-		// Get the post type.
-		$post_type = get_post_type( $post_id );
-
-		// Return `web-page` for non entities.
-		if ( ! self::is_valid_entity_post_type( $post_type ) ) {
-			$this->log->info( "Returning `web-page` for post $post_id." );
-
-			return $this->schema_service->get_schema( 'web-page' );
-		}
-
-		// Get the type from the associated classification.
-		$terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-		// Return the schema type if there is a term found.
-		if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
-			// Cycle through the terms and return the first one with a valid schema.
-			foreach ( $terms as $term ) {
-				$this->log->debug( "Found `{$term->slug}` term for post $post_id." );
-
-				// Try to get the schema for the term.
-				$schema = $this->schema_service->get_schema( $term->slug );
-
-				// If found, return it, ignoring the other types.
-				if ( null !== $schema ) {
-					// Return the entity type with the specified id.
-					return $schema;
-				}
-			}
-
-			/*
+    /**
+     * The {@link Wordlift_Schema_Service} instance.
+     *
+     * @since  3.7.0
+     * @access private
+     * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
+     */
+    private $schema_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Wordlift_Entity_Type_Service constructor.
+     *
+     * @since 3.7.0
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Service' );
+
+        $this->schema_service = Wordlift_Schema_Service::get_instance();
+
+        $this->prepare_post_types();
+
+    }
+
+    /**
+     * Prepare post types for Gutenberg use
+     *
+     * @since 3.26.0
+     */
+    private function prepare_post_types() {
+
+        add_action(
+            'init',
+            function () {
+                // Add post type support for 'custom-fields' for all post types. Specifically needed in Gutenberg
+                $post_types = get_post_types();
+                foreach ( $post_types as $post_type ) {
+                    add_post_type_support( $post_type, 'custom-fields' );
+                }
+            }
+        );
+    }
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} singleton instance.
+     *
+     * @since  3.7.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $instance The {@link Wordlift_Entity_Type_Service} singleton instance.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the {@link Wordlift_Entity_Type_Service} singleton instance.
+     *
+     * @return \Wordlift_Entity_Type_Service The {@link Wordlift_Entity_Type_Service} singleton instance.
+     * @since 3.7.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the types associated with the specified entity post id.
+     *
+     * We have a strategy to define the entity type, given that everything is
+     * an entity, i.e. also posts/pages and custom post types.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|null {
+     * An array of type properties or null if no term is associated
+     *
+     * @type string css_class     The css class, e.g. `wl-thing`.
+     * @type string uri           The schema.org class URI, e.g. `http://schema.org/Thing`.
+     * @type array  same_as       An array of same as attributes.
+     * @type array  custom_fields An array of custom fields.
+     * }
+     * @since 3.33.9 The `linked_data` key has been removed.
+     *
+     * @since 3.20.0 This function will **not** return entity types introduced with 3.20.0.
+     *
+     * @since 3.18.0 The cases are the following:
+     *  1. the post has a term from the Entity Types Taxonomy: the term defines
+     *     the entity type, e.g. Organization, Person, ...
+     *  2. the post doesn't have a term from the Entity Types Taxonomy:
+     *      a) the post is a `wl_entity` custom post type, then the post is
+     *           assigned the `Thing` entity type by default.
+     *      b) the post is a `post` post type, then the post is
+     *           assigned the `Article` entity type by default.
+     *      c) the post is a custom post type then it is
+     *          assigned the `WebPage` entity type by default.
+     */
+    public function get( $post_id ) {
+
+        $this->log->trace( "Getting the post type for post $post_id..." );
+
+        // Get the post type.
+        $post_type = get_post_type( $post_id );
+
+        // Return `web-page` for non entities.
+        if ( ! self::is_valid_entity_post_type( $post_type ) ) {
+            $this->log->info( "Returning `web-page` for post $post_id." );
+
+            return $this->schema_service->get_schema( 'web-page' );
+        }
+
+        // Get the type from the associated classification.
+        $terms = wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+        // Return the schema type if there is a term found.
+        if ( ! is_wp_error( $terms ) && ! empty( $terms ) ) {
+            // Cycle through the terms and return the first one with a valid schema.
+            foreach ( $terms as $term ) {
+                $this->log->debug( "Found `{$term->slug}` term for post $post_id." );
+
+                // Try to get the schema for the term.
+                $schema = $this->schema_service->get_schema( $term->slug );
+
+                // If found, return it, ignoring the other types.
+                if ( null !== $schema ) {
+                    // Return the entity type with the specified id.
+                    return $schema;
+                }
+            }
+
+            /*
 			 * When a schema isn't found, we return `thing`. Schema may not be found because
 			 * the new schema classes that we support since #852 aren't configured in the schema
 			 * service.
@@ -169,93 +169,93 @@ 
 			 * @since 3.20.0
 			 */
 
-			return $this->schema_service->get_schema( 'thing' );
-		}
-
-		// If it's a page or post return `Article`.
-		if ( in_array( $post_type, array( 'post', 'page' ), true ) ) {
-			$this->log->debug( "Post $post_id has no terms, and it's a `post` type, returning `Article`." );
-
-			// Return "Article" schema type for posts.
-			return $this->schema_service->get_schema( 'article' );
-		}
-
-		// Return "Thing" schema type for entities.
-		$this->log->debug( "Post $post_id has no terms, but it's a `wl_entity` type, returning `Thing`." );
-
-		// Return the entity type with the specified id.
-		return $this->schema_service->get_schema( 'thing' );
-
-	}
-
-	/**
-	 * Get the term ids of the entity types associated to the specified post.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|WP_Error An array of entity types ids or a {@link WP_Error}.
-	 * @since 3.20.0
-	 */
-	public function get_ids( $post_id ) {
-
-		return wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array( 'fields' => 'ids' ) );
-	}
-
-	/**
-	 * Get the camel case names of the entity types associated to the specified post.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|WP_Error An array of entity types camel case names or a {@link WP_Error}.
-	 * @since 3.20.0
-	 */
-	public function get_names( $post_id ) {
-
-		$ids = $this->get_ids( $post_id );
-
-		// Filter out invalid terms (ones without _wl_name term meta)
-		return array_values(
-			array_filter(
-				array_map(
-					function ( $id ) {
-						return get_term_meta( $id, '_wl_name', true );
-					},
-					$ids
-				)
-			)
-		);
-	}
-
-	/**
-	 * Set the main type for the specified entity post, given the type URI.
-	 *
-	 * @param int    $post_id The post id.
-	 * @param string $type_uri The type URI.
-	 * @param bool   $replace Whether the provided type must replace the existing types, by default `true`.
-	 *
-	 * @since 3.8.0
-	 */
-	public function set( $post_id, $type_uri, $replace = true ) {
-
-		// If the type URI is empty we remove the type.
-		if ( empty( $type_uri ) ) {
-			$this->log->debug( "Removing entity type for post $post_id..." );
-
-			wp_set_object_terms( $post_id, null, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-
-			return;
-		}
-
-		$this->log->debug( "Setting entity type for post $post_id..." );
-
-		// if the `$type_uri` starts with `wl-`, we're looking at the class name, which is `wl-` + slug.
-		$term = ( 0 === strpos( $type_uri, 'wl-' ) )
-			// Get term by slug.
-			? $this->get_term_by_slug( substr( $type_uri, 3 ) )
-			// Get term by URI.
-			: $this->get_term_by_uri( $type_uri );
-
-		/*
+            return $this->schema_service->get_schema( 'thing' );
+        }
+
+        // If it's a page or post return `Article`.
+        if ( in_array( $post_type, array( 'post', 'page' ), true ) ) {
+            $this->log->debug( "Post $post_id has no terms, and it's a `post` type, returning `Article`." );
+
+            // Return "Article" schema type for posts.
+            return $this->schema_service->get_schema( 'article' );
+        }
+
+        // Return "Thing" schema type for entities.
+        $this->log->debug( "Post $post_id has no terms, but it's a `wl_entity` type, returning `Thing`." );
+
+        // Return the entity type with the specified id.
+        return $this->schema_service->get_schema( 'thing' );
+
+    }
+
+    /**
+     * Get the term ids of the entity types associated to the specified post.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|WP_Error An array of entity types ids or a {@link WP_Error}.
+     * @since 3.20.0
+     */
+    public function get_ids( $post_id ) {
+
+        return wp_get_object_terms( $post_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, array( 'fields' => 'ids' ) );
+    }
+
+    /**
+     * Get the camel case names of the entity types associated to the specified post.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|WP_Error An array of entity types camel case names or a {@link WP_Error}.
+     * @since 3.20.0
+     */
+    public function get_names( $post_id ) {
+
+        $ids = $this->get_ids( $post_id );
+
+        // Filter out invalid terms (ones without _wl_name term meta)
+        return array_values(
+            array_filter(
+                array_map(
+                    function ( $id ) {
+                        return get_term_meta( $id, '_wl_name', true );
+                    },
+                    $ids
+                )
+            )
+        );
+    }
+
+    /**
+     * Set the main type for the specified entity post, given the type URI.
+     *
+     * @param int    $post_id The post id.
+     * @param string $type_uri The type URI.
+     * @param bool   $replace Whether the provided type must replace the existing types, by default `true`.
+     *
+     * @since 3.8.0
+     */
+    public function set( $post_id, $type_uri, $replace = true ) {
+
+        // If the type URI is empty we remove the type.
+        if ( empty( $type_uri ) ) {
+            $this->log->debug( "Removing entity type for post $post_id..." );
+
+            wp_set_object_terms( $post_id, null, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+
+            return;
+        }
+
+        $this->log->debug( "Setting entity type for post $post_id..." );
+
+        // if the `$type_uri` starts with `wl-`, we're looking at the class name, which is `wl-` + slug.
+        $term = ( 0 === strpos( $type_uri, 'wl-' ) )
+            // Get term by slug.
+            ? $this->get_term_by_slug( substr( $type_uri, 3 ) )
+            // Get term by URI.
+            : $this->get_term_by_uri( $type_uri );
+
+        /*
 		 * We always want to assign a type to an entity otherwise it won't show in the Vocabulary and it won't be
 		 * connected to Articles via mentions. We realized that the client JS code is passing `wl-other` when the
 		 * entity type isn't "notable". In which case we couldn't find an entity type.
@@ -266,245 +266,245 @@ 
 		 *
 		 * @since 3.23.4
 		 */
-		if ( false === $term ) {
-			$this->log->warn( "No term found for URI $type_uri, will use Thing." );
-
-			$term = $this->get_term_by_slug( 'thing' );
-
-			// We still need to be able to bali out here, for example WordPress 5.1 tests create posts before our taxonomy
-			// is installed.
-			if ( false === $term ) {
-				return;
-			}
-		}
-
-		$this->log->debug( "Setting entity type [ post id :: $post_id ][ term id :: $term->term_id ][ term slug :: $term->slug ][ type uri :: $type_uri ]..." );
-
-		// `$replace` is passed to decide whether to replace or append the term.
-		wp_set_object_terms( $post_id, $term->term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, ! $replace );
-
-	}
-
-	/**
-	 * Get an entity type term given its slug.
-	 *
-	 * @param string $slug The slug.
-	 *
-	 * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
-	 *                             or `$term` was not found.
-	 * @since 3.20.0
-	 */
-	public function get_term_by_slug( $slug ) {
-
-		return get_term_by( 'slug', $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
-	}
-
-	/**
-	 * Get an entity type term given its URI.
-	 *
-	 * @param string $uri The uri.
-	 *
-	 * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
-	 *                             or `$term` was not found.
-	 * @since 3.20.0
-	 */
-	public function get_term_by_uri( $uri ) {
-
-		$terms = get_terms(
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-			array(
-				'fields'     => 'all',
-				'get'        => 'all',
-				'number'     => 1,
-				'meta_query' => array(
-					array(
-						// Don't use a reference to Wordlift_Schemaorg_Class_Service, unless
-						// `WL_ALL_ENTITY_TYPES` is set to true.
-						'key'   => '_wl_uri',
-						'value' => $uri,
-					),
-				),
-				'orderby'    => 'term_id',
-				'order'      => 'ASC',
-			)
-		);
-
-		return is_array( $terms ) && ! empty( $terms ) ? $terms[0] : false;
-	}
-
-	/**
-	 * Check whether an entity type is set for the {@link WP_Post} with the
-	 * specified id.
-	 *
-	 * @param int    $post_id The {@link WP_Post}'s `id`.
-	 * @param string $uri The entity type URI.
-	 *
-	 * @return bool True if an entity type is set otherwise false.
-	 * @since 3.15.0
-	 */
-	public function has_entity_type( $post_id, $uri = null ) {
-
-		$this->log->debug( "Checking if post $post_id has an entity type [ $uri ]..." );
-
-		// If an URI hasn't been specified just check whether we have at least
-		// one entity type.
-		if ( null === $uri ) {
-			return has_term( '', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $post_id );
-		}
-
-		$has_entity_type = $this->has_post_term_by_uri( $post_id, $uri );
-
-		$this->log->debug( "Post $post_id has $uri type: " . ( $has_entity_type ? 'yes' : 'no' ) );
-
-		// Check whether the post has an entity type with that URI.
-		return $has_entity_type;
-	}
-
-	/**
-	 * Get the list of entity types' terms for the specified {@link WP_Post}.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @return array|WP_Error An array of entity types' terms or {@link WP_Error}.
-	 * @since 3.15.0
-	 */
-	private function get_post_terms( $post_id ) {
-
-		return wp_get_object_terms(
-			$post_id,
-			Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-			array(
-				'hide_empty' => false,
-				// Because of #334 (and the AAM plugin) we changed fields from 'id=>slug' to 'all'.
-				// An issue has been opened with the AAM plugin author as well.
-				//
-				// see https://github.com/insideout10/wordlift-plugin/issues/334
-				// see https://wordpress.org/support/topic/idslug-not-working-anymore?replies=1#post-8806863
-				'fields'     => 'all',
-			)
-		);
-	}
-
-	/**
-	 * Get an entity type term given its URI.
-	 *
-	 * @param int    $post_id The {@link WP_Post} id.
-	 * @param string $uri The entity type URI.
-	 *
-	 * @return bool True if the post has that type URI bound to it otherwise false.
-	 * @since 3.15.0
-	 *
-	 * @since 3.20.0 function renamed to `has_post_term_by_uri` and return type changed to `bool`.
-	 */
-	private function has_post_term_by_uri( $post_id, $uri ) {
-
-		// Get the post terms bound to the specified post.
-		$terms = $this->get_post_terms( $post_id );
-
-		// Look for a term if the specified URI.
-		foreach ( $terms as $term ) {
-			$term_uri = get_term_meta( $term->term_id, '_wl_uri', true );
-			if ( $uri === $term_uri ) {
-				return true;
-			}
-		}
-
-		// Return null.
-		return false;
-	}
-
-	/**
-	 * Get the custom fields for a specific post.
-	 *
-	 * @param int $post_id The post ID.
-	 *
-	 * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
-	 * @since 3.25.2
-	 */
-	public function get_custom_fields_for_post( $post_id ) {
-
-		// Return custom fields for this specific entity's type.
-		$types = $this->get_ids( $post_id );
-
-		/** @var WP_Term[] $terms */
-		$terms = array_filter(
-			array_map(
-				function ( $item ) {
-					return get_term( $item );
-				},
-				$types
-			),
-			function ( $item ) {
-				return isset( $item ) && is_a( $item, 'WP_Term' );
-			}
-		);
-
-		$term_slugs = array_map(
-			function ( $item ) {
-				return $item->slug;
-			},
-			$terms
-		);
-
-		$term_slugs[] = 'thing';
-
-		return $this->get_custom_fields_by_term_slugs( $term_slugs );
-	}
-
-	/**
-	 * Get the custom fields for a specific term.
-	 *
-	 * @param int $term_id The term ID.
-	 *
-	 * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
-	 * @since 3.32.0
-	 */
-	public function get_custom_fields_for_term( $term_id ) {
-		$selected_entity_types   = get_term_meta( $term_id, 'wl_entity_type' );
-		$selected_entity_types[] = 'thing';
-		$selected_entity_types   = array_unique( $selected_entity_types );
-
-		return $this->get_custom_fields_by_term_slugs( $selected_entity_types );
-	}
-
-	/**
-	 * Determines whether a post type can be used for entities.
-	 *
-	 * Criteria is that the post type is public. The list of valid post types
-	 * can be overridden with a filter.
-	 *
-	 * @param string $post_type A post type name.
-	 *
-	 * @return bool Return true if the post type can be used for entities, otherwise false.
-	 * @since 3.15.0
-	 */
-	public static function is_valid_entity_post_type( $post_type ) {
-
-		return in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true );
-	}
-
-	/**
-	 * @param $term_slugs
-	 *
-	 * @return array
-	 */
-	private function get_custom_fields_by_term_slugs( $term_slugs ) {
-		$schema_service = Wordlift_Schema_Service::get_instance();
-
-		return array_reduce(
-			$term_slugs,
-			function ( $carry, $item ) use ( $schema_service ) {
-
-				$schema = $schema_service->get_schema( $item );
-
-				if ( ! isset( $schema['custom_fields'] ) ) {
-					return $carry;
-				}
-
-				return $carry + $schema['custom_fields'];
-			},
-			array()
-		);
-	}
+        if ( false === $term ) {
+            $this->log->warn( "No term found for URI $type_uri, will use Thing." );
+
+            $term = $this->get_term_by_slug( 'thing' );
+
+            // We still need to be able to bali out here, for example WordPress 5.1 tests create posts before our taxonomy
+            // is installed.
+            if ( false === $term ) {
+                return;
+            }
+        }
+
+        $this->log->debug( "Setting entity type [ post id :: $post_id ][ term id :: $term->term_id ][ term slug :: $term->slug ][ type uri :: $type_uri ]..." );
+
+        // `$replace` is passed to decide whether to replace or append the term.
+        wp_set_object_terms( $post_id, $term->term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, ! $replace );
+
+    }
+
+    /**
+     * Get an entity type term given its slug.
+     *
+     * @param string $slug The slug.
+     *
+     * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
+     *                             or `$term` was not found.
+     * @since 3.20.0
+     */
+    public function get_term_by_slug( $slug ) {
+
+        return get_term_by( 'slug', $slug, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME );
+    }
+
+    /**
+     * Get an entity type term given its URI.
+     *
+     * @param string $uri The uri.
+     *
+     * @return false|WP_Term WP_Term instance on success. Will return false if `$taxonomy` does not exist
+     *                             or `$term` was not found.
+     * @since 3.20.0
+     */
+    public function get_term_by_uri( $uri ) {
+
+        $terms = get_terms(
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+            array(
+                'fields'     => 'all',
+                'get'        => 'all',
+                'number'     => 1,
+                'meta_query' => array(
+                    array(
+                        // Don't use a reference to Wordlift_Schemaorg_Class_Service, unless
+                        // `WL_ALL_ENTITY_TYPES` is set to true.
+                        'key'   => '_wl_uri',
+                        'value' => $uri,
+                    ),
+                ),
+                'orderby'    => 'term_id',
+                'order'      => 'ASC',
+            )
+        );
+
+        return is_array( $terms ) && ! empty( $terms ) ? $terms[0] : false;
+    }
+
+    /**
+     * Check whether an entity type is set for the {@link WP_Post} with the
+     * specified id.
+     *
+     * @param int    $post_id The {@link WP_Post}'s `id`.
+     * @param string $uri The entity type URI.
+     *
+     * @return bool True if an entity type is set otherwise false.
+     * @since 3.15.0
+     */
+    public function has_entity_type( $post_id, $uri = null ) {
+
+        $this->log->debug( "Checking if post $post_id has an entity type [ $uri ]..." );
+
+        // If an URI hasn't been specified just check whether we have at least
+        // one entity type.
+        if ( null === $uri ) {
+            return has_term( '', Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME, $post_id );
+        }
+
+        $has_entity_type = $this->has_post_term_by_uri( $post_id, $uri );
+
+        $this->log->debug( "Post $post_id has $uri type: " . ( $has_entity_type ? 'yes' : 'no' ) );
+
+        // Check whether the post has an entity type with that URI.
+        return $has_entity_type;
+    }
+
+    /**
+     * Get the list of entity types' terms for the specified {@link WP_Post}.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @return array|WP_Error An array of entity types' terms or {@link WP_Error}.
+     * @since 3.15.0
+     */
+    private function get_post_terms( $post_id ) {
+
+        return wp_get_object_terms(
+            $post_id,
+            Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+            array(
+                'hide_empty' => false,
+                // Because of #334 (and the AAM plugin) we changed fields from 'id=>slug' to 'all'.
+                // An issue has been opened with the AAM plugin author as well.
+                //
+                // see https://github.com/insideout10/wordlift-plugin/issues/334
+                // see https://wordpress.org/support/topic/idslug-not-working-anymore?replies=1#post-8806863
+                'fields'     => 'all',
+            )
+        );
+    }
+
+    /**
+     * Get an entity type term given its URI.
+     *
+     * @param int    $post_id The {@link WP_Post} id.
+     * @param string $uri The entity type URI.
+     *
+     * @return bool True if the post has that type URI bound to it otherwise false.
+     * @since 3.15.0
+     *
+     * @since 3.20.0 function renamed to `has_post_term_by_uri` and return type changed to `bool`.
+     */
+    private function has_post_term_by_uri( $post_id, $uri ) {
+
+        // Get the post terms bound to the specified post.
+        $terms = $this->get_post_terms( $post_id );
+
+        // Look for a term if the specified URI.
+        foreach ( $terms as $term ) {
+            $term_uri = get_term_meta( $term->term_id, '_wl_uri', true );
+            if ( $uri === $term_uri ) {
+                return true;
+            }
+        }
+
+        // Return null.
+        return false;
+    }
+
+    /**
+     * Get the custom fields for a specific post.
+     *
+     * @param int $post_id The post ID.
+     *
+     * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
+     * @since 3.25.2
+     */
+    public function get_custom_fields_for_post( $post_id ) {
+
+        // Return custom fields for this specific entity's type.
+        $types = $this->get_ids( $post_id );
+
+        /** @var WP_Term[] $terms */
+        $terms = array_filter(
+            array_map(
+                function ( $item ) {
+                    return get_term( $item );
+                },
+                $types
+            ),
+            function ( $item ) {
+                return isset( $item ) && is_a( $item, 'WP_Term' );
+            }
+        );
+
+        $term_slugs = array_map(
+            function ( $item ) {
+                return $item->slug;
+            },
+            $terms
+        );
+
+        $term_slugs[] = 'thing';
+
+        return $this->get_custom_fields_by_term_slugs( $term_slugs );
+    }
+
+    /**
+     * Get the custom fields for a specific term.
+     *
+     * @param int $term_id The term ID.
+     *
+     * @return array An array of custom fields (see `custom_fields` in Wordlift_Schema_Service).
+     * @since 3.32.0
+     */
+    public function get_custom_fields_for_term( $term_id ) {
+        $selected_entity_types   = get_term_meta( $term_id, 'wl_entity_type' );
+        $selected_entity_types[] = 'thing';
+        $selected_entity_types   = array_unique( $selected_entity_types );
+
+        return $this->get_custom_fields_by_term_slugs( $selected_entity_types );
+    }
+
+    /**
+     * Determines whether a post type can be used for entities.
+     *
+     * Criteria is that the post type is public. The list of valid post types
+     * can be overridden with a filter.
+     *
+     * @param string $post_type A post type name.
+     *
+     * @return bool Return true if the post type can be used for entities, otherwise false.
+     * @since 3.15.0
+     */
+    public static function is_valid_entity_post_type( $post_type ) {
+
+        return in_array( $post_type, Wordlift_Entity_Service::valid_entity_post_types(), true );
+    }
+
+    /**
+     * @param $term_slugs
+     *
+     * @return array
+     */
+    private function get_custom_fields_by_term_slugs( $term_slugs ) {
+        $schema_service = Wordlift_Schema_Service::get_instance();
+
+        return array_reduce(
+            $term_slugs,
+            function ( $carry, $item ) use ( $schema_service ) {
+
+                $schema = $schema_service->get_schema( $item );
+
+                if ( ! isset( $schema['custom_fields'] ) ) {
+                    return $carry;
+                }
+
+                return $carry + $schema['custom_fields'];
+            },
+            array()
+        );
+    }
 
 }

src/classes/videoobject/jsonld/class-jsonld.php

Indentation +170 added lines, -170 removed lines

@@ -11,175 +11,175 @@
 use Wordlift\Videoobject\Data\Video_Storage\Storage;
 
 class Jsonld {
-	/**
-	 * @var Storage
-	 */
-	private $video_storage;
-
-	/**
-	 * Jsonld constructor.
-	 *
-	 * @param $video_storage Storage
-	 */
-	public function __construct( $video_storage ) {
-		add_action( 'wl_post_jsonld', array( $this, 'wl_post_jsonld' ), 10, 2 );
-		add_filter( 'wl_after_get_jsonld', array( $this, 'wl_after_get_jsonld' ), 10, 2 );
-		$this->video_storage = $video_storage;
-	}
-
-	public function wl_after_get_jsonld( $jsonld, $post_id ) {
-		if ( 0 === count( $jsonld ) ) {
-			return $jsonld;
-		}
-		$current_item = $jsonld[0];
-
-		if ( ! is_array( $current_item ) || ! array_key_exists( '@type', $current_item ) ) {
-			// Cant determine type return early.
-			return $jsonld;
-		}
-
-		$type = $current_item['@type'];
-		if ( is_string( $type ) ) {
-			$type = array( $type );
-		}
-		// If its a article or descendant of article, then dont add the
-		// videoobject in this hook, they will be already added to video property.
-		if ( array_intersect( Jsonld_Article_Wrapper::$article_types, $type ) ) {
-			return $jsonld;
-		}
-
-		$videos_jsonld = $this->get_videos_jsonld( $post_id );
-		if ( 0 === count( $videos_jsonld ) ) {
-			return $jsonld;
-		}
-
-		// check if we have @id in jsonld for first item.
-		$id = array_key_exists( '@id', $current_item ) ? $current_item['@id'] : '';
-
-		foreach ( $videos_jsonld as &$video_jsonld ) {
-			if ( ! $id ) {
-				continue;
-			}
-			if ( ! array_key_exists( 'mentions', $video_jsonld ) ) {
-				$video_jsonld['mentions'] = array( '@id' => $id );
-			} else {
-				$video_jsonld['mentions'] = array_merge( $video_jsonld['mentions'], array( '@id' => $id ) );
-			}
-		}
-
-		return array_merge( $jsonld, $videos_jsonld );
-	}
-
-	/**
-	 * @param $existing_video_data string | array associative or sequential array.
-	 * @param $new_video_data array Sequential array.
-	 *
-	 * @return array
-	 */
-	private function merge_video_data( $existing_video_data, $new_video_data ) {
-		if ( ! is_array( $existing_video_data ) ) {
-			$new_video_data[] = $existing_video_data;
-
-			return $new_video_data;
-		}
-
-		if ( $this->is_associative_array( $existing_video_data ) ) {
-			$new_video_data[] = $existing_video_data;
-
-			return $new_video_data;
-		}
-
-		return array_merge( $existing_video_data, $new_video_data );
-	}
-
-	public function wl_post_jsonld( $jsonld, $post_id ) {
-
-		$video_jsonld = $this->get_videos_jsonld( $post_id );
-		if ( count( $video_jsonld ) === 0 ) {
-			return $jsonld;
-		}
-		// Before adding the video jsonld check if the key
-		// is present and additional data might be present,
-		// if not present just add the data and return early.
-		if ( ! array_key_exists( 'video', $jsonld ) ) {
-			$jsonld['video'] = $video_jsonld;
-
-			return $jsonld;
-		}
-
-		// since key exists, we need to merge the data based on type.
-		$previous_video_data = $jsonld['video'];
-		$jsonld['video']     = $this->merge_video_data( $previous_video_data, $video_jsonld );
-
-		return $jsonld;
-	}
-
-	/**
-	 * @param $post_id int Post id.
-	 *
-	 * @return array
-	 */
-	public function get_videos_jsonld( $post_id ) {
-
-		$videos = $this->video_storage->get_all_videos( $post_id );
-
-		$jsonld = array();
-
-		foreach ( $videos as $video ) {
-			/**
-			 * @var $video Video
-			 */
-			$description = $video->description;
-			if ( ! $video->description ) {
-				// If description is empty then use the video title as description
-				$description = $video->name;
-			}
-			$single_jsonld = array(
-				'@context'     => 'http://schema.org',
-				'@type'        => 'VideoObject',
-				'name'         => $video->name,
-				'description'  => $description,
-				'contentUrl'   => $video->content_url,
-				'uploadDate'   => $video->upload_date,
-				'thumbnailUrl' => $video->thumbnail_urls,
-				'duration'     => $video->duration,
-			);
-
-			if ( $video->embed_url ) {
-				$single_jsonld['embedUrl'] = $video->embed_url;
-			}
-
-			if ( $video->views ) {
-				$single_jsonld['interactionStatistic'] = array(
-					'@type'                => 'InteractionCounter',
-					'interactionType'      => array(
-						'@type' => 'http://schema.org/WatchAction',
-					),
-					'userInteractionCount' => $video->views,
-				);
-			}
-
-			if ( $video->is_live_video ) {
-				$single_jsonld['publication'] = array(
-					'@type'           => 'BroadcastEvent',
-					'isLiveBroadcast' => true,
-					'startDate'       => $video->live_video_start_date,
-					'endDate'         => $video->live_video_end_date,
-				);
-			}
-
-			$jsonld[] = $single_jsonld;
-		}
-
-		return $jsonld;
-	}
-
-	private function is_associative_array( $arr ) {
-		if ( array() === $arr ) {
-			return false;
-		}
-
-		return array_keys( $arr ) !== range( 0, count( $arr ) - 1 );
-	}
+    /**
+     * @var Storage
+     */
+    private $video_storage;
+
+    /**
+     * Jsonld constructor.
+     *
+     * @param $video_storage Storage
+     */
+    public function __construct( $video_storage ) {
+        add_action( 'wl_post_jsonld', array( $this, 'wl_post_jsonld' ), 10, 2 );
+        add_filter( 'wl_after_get_jsonld', array( $this, 'wl_after_get_jsonld' ), 10, 2 );
+        $this->video_storage = $video_storage;
+    }
+
+    public function wl_after_get_jsonld( $jsonld, $post_id ) {
+        if ( 0 === count( $jsonld ) ) {
+            return $jsonld;
+        }
+        $current_item = $jsonld[0];
+
+        if ( ! is_array( $current_item ) || ! array_key_exists( '@type', $current_item ) ) {
+            // Cant determine type return early.
+            return $jsonld;
+        }
+
+        $type = $current_item['@type'];
+        if ( is_string( $type ) ) {
+            $type = array( $type );
+        }
+        // If its a article or descendant of article, then dont add the
+        // videoobject in this hook, they will be already added to video property.
+        if ( array_intersect( Jsonld_Article_Wrapper::$article_types, $type ) ) {
+            return $jsonld;
+        }
+
+        $videos_jsonld = $this->get_videos_jsonld( $post_id );
+        if ( 0 === count( $videos_jsonld ) ) {
+            return $jsonld;
+        }
+
+        // check if we have @id in jsonld for first item.
+        $id = array_key_exists( '@id', $current_item ) ? $current_item['@id'] : '';
+
+        foreach ( $videos_jsonld as &$video_jsonld ) {
+            if ( ! $id ) {
+                continue;
+            }
+            if ( ! array_key_exists( 'mentions', $video_jsonld ) ) {
+                $video_jsonld['mentions'] = array( '@id' => $id );
+            } else {
+                $video_jsonld['mentions'] = array_merge( $video_jsonld['mentions'], array( '@id' => $id ) );
+            }
+        }
+
+        return array_merge( $jsonld, $videos_jsonld );
+    }
+
+    /**
+     * @param $existing_video_data string | array associative or sequential array.
+     * @param $new_video_data array Sequential array.
+     *
+     * @return array
+     */
+    private function merge_video_data( $existing_video_data, $new_video_data ) {
+        if ( ! is_array( $existing_video_data ) ) {
+            $new_video_data[] = $existing_video_data;
+
+            return $new_video_data;
+        }
+
+        if ( $this->is_associative_array( $existing_video_data ) ) {
+            $new_video_data[] = $existing_video_data;
+
+            return $new_video_data;
+        }
+
+        return array_merge( $existing_video_data, $new_video_data );
+    }
+
+    public function wl_post_jsonld( $jsonld, $post_id ) {
+
+        $video_jsonld = $this->get_videos_jsonld( $post_id );
+        if ( count( $video_jsonld ) === 0 ) {
+            return $jsonld;
+        }
+        // Before adding the video jsonld check if the key
+        // is present and additional data might be present,
+        // if not present just add the data and return early.
+        if ( ! array_key_exists( 'video', $jsonld ) ) {
+            $jsonld['video'] = $video_jsonld;
+
+            return $jsonld;
+        }
+
+        // since key exists, we need to merge the data based on type.
+        $previous_video_data = $jsonld['video'];
+        $jsonld['video']     = $this->merge_video_data( $previous_video_data, $video_jsonld );
+
+        return $jsonld;
+    }
+
+    /**
+     * @param $post_id int Post id.
+     *
+     * @return array
+     */
+    public function get_videos_jsonld( $post_id ) {
+
+        $videos = $this->video_storage->get_all_videos( $post_id );
+
+        $jsonld = array();
+
+        foreach ( $videos as $video ) {
+            /**
+             * @var $video Video
+             */
+            $description = $video->description;
+            if ( ! $video->description ) {
+                // If description is empty then use the video title as description
+                $description = $video->name;
+            }
+            $single_jsonld = array(
+                '@context'     => 'http://schema.org',
+                '@type'        => 'VideoObject',
+                'name'         => $video->name,
+                'description'  => $description,
+                'contentUrl'   => $video->content_url,
+                'uploadDate'   => $video->upload_date,
+                'thumbnailUrl' => $video->thumbnail_urls,
+                'duration'     => $video->duration,
+            );
+
+            if ( $video->embed_url ) {
+                $single_jsonld['embedUrl'] = $video->embed_url;
+            }
+
+            if ( $video->views ) {
+                $single_jsonld['interactionStatistic'] = array(
+                    '@type'                => 'InteractionCounter',
+                    'interactionType'      => array(
+                        '@type' => 'http://schema.org/WatchAction',
+                    ),
+                    'userInteractionCount' => $video->views,
+                );
+            }
+
+            if ( $video->is_live_video ) {
+                $single_jsonld['publication'] = array(
+                    '@type'           => 'BroadcastEvent',
+                    'isLiveBroadcast' => true,
+                    'startDate'       => $video->live_video_start_date,
+                    'endDate'         => $video->live_video_end_date,
+                );
+            }
+
+            $jsonld[] = $single_jsonld;
+        }
+
+        return $jsonld;
+    }
+
+    private function is_associative_array( $arr ) {
+        if ( array() === $arr ) {
+            return false;
+        }
+
+        return array_keys( $arr ) !== range( 0, count( $arr ) - 1 );
+    }
 
 }

src/modules/include-exclude/includes/Jsonld_Interceptor.php

Indentation +46 added lines, -46 removed lines

@@ -4,51 +4,51 @@
 
 class Jsonld_Interceptor {
 
-	/** @var Plugin_Enabled $plugin_enabled */
-	private $plugin_enabled;
-
-	public function __construct( $plugin_enabled ) {
-		$this->plugin_enabled = $plugin_enabled;
-	}
-
-	public function register_hooks() {
-		add_action( 'wl_before_get_jsonld', array( $this, 'before_get_jsonld' ), 10, 2 );
-		add_filter( 'wl_after_get_jsonld', array( $this, 'after_get_jsonld' ) );
-	}
-
-	public function before_get_jsonld( $is_homepage = false, $post_id = null ) {
-		if ( null !== filter_input( INPUT_SERVER, 'HTTP_X_WORDLIFT_BYPASS_INCLUDE_EXCLUDE' ) ) {
-			clean_post_cache( $post_id );
-		}
-	}
-
-	public function after_get_jsonld( $jsonld_arr ) {
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Stage-0: Filter Called with default ' . $this->plugin_enabled->get_configuration()->get_default() );
-		if ( ! is_array( $jsonld_arr ) || empty( $jsonld_arr ) || ! isset( $jsonld_arr[0]['url'] ) || null !== filter_input( INPUT_SERVER, 'HTTP_X_WORDLIFT_BYPASS_INCLUDE_EXCLUDE' ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Not Matched' );
-
-			return $jsonld_arr;
-		}
-
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Matched for ' . $jsonld_arr[0]['url'] );
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Note: To bypass the Include/Exclude filter add a `x-wordlift-bypass-include-exclude` HTTP request header with any value.' );
-
-		// If the URLs are included then publish them.
-		if ( $this->plugin_enabled->are_urls_included( $jsonld_arr[0]['url'] ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@header( 'X-Wordlift-IncludeExclude-Stage-2: URL Included' );
-
-			return $jsonld_arr;
-		}
-
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'X-Wordlift-IncludeExclude-Stage-2: URL Excluded' );
-
-		return array();
-	}
+    /** @var Plugin_Enabled $plugin_enabled */
+    private $plugin_enabled;
+
+    public function __construct( $plugin_enabled ) {
+        $this->plugin_enabled = $plugin_enabled;
+    }
+
+    public function register_hooks() {
+        add_action( 'wl_before_get_jsonld', array( $this, 'before_get_jsonld' ), 10, 2 );
+        add_filter( 'wl_after_get_jsonld', array( $this, 'after_get_jsonld' ) );
+    }
+
+    public function before_get_jsonld( $is_homepage = false, $post_id = null ) {
+        if ( null !== filter_input( INPUT_SERVER, 'HTTP_X_WORDLIFT_BYPASS_INCLUDE_EXCLUDE' ) ) {
+            clean_post_cache( $post_id );
+        }
+    }
+
+    public function after_get_jsonld( $jsonld_arr ) {
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Stage-0: Filter Called with default ' . $this->plugin_enabled->get_configuration()->get_default() );
+        if ( ! is_array( $jsonld_arr ) || empty( $jsonld_arr ) || ! isset( $jsonld_arr[0]['url'] ) || null !== filter_input( INPUT_SERVER, 'HTTP_X_WORDLIFT_BYPASS_INCLUDE_EXCLUDE' ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Not Matched' );
+
+            return $jsonld_arr;
+        }
+
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Stage-1: Condition Matched for ' . $jsonld_arr[0]['url'] );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Note: To bypass the Include/Exclude filter add a `x-wordlift-bypass-include-exclude` HTTP request header with any value.' );
+
+        // If the URLs are included then publish them.
+        if ( $this->plugin_enabled->are_urls_included( $jsonld_arr[0]['url'] ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @header( 'X-Wordlift-IncludeExclude-Stage-2: URL Included' );
+
+            return $jsonld_arr;
+        }
+
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @header( 'X-Wordlift-IncludeExclude-Stage-2: URL Excluded' );
+
+        return array();
+    }
 
 }