khaihihi

wp-content/plugins/wordpress-seo/frontend/schema/class-schema-faq-question-list.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * WPSEO plugin file.
+ *
+ * @package WPSEO\Frontend\Schema
+ */
+
+/**
+ * Returns a question object for each question in an FAQ block.
+ *
+ * @since 11.1
+ *
+ * @property array                   $data   The Schema array.
+ * @property WP_Block_Parser_Block[] $blocks The block we're taking the questions out of.
+ * @property WPSEO_Schema_Context    context A value object with context variables.
+ * @property array                   ids
+ * @property int                     count
+ */
+class WPSEO_Schema_FAQ_Question_List {
+
+	/**
+	 * The Schema array.
+	 *
+	 * @var array
+	 */
+	private $data = [];
+
+	/**
+	 * All the blocks of this block-type.
+	 *
+	 * @var WP_Block_Parser_Block
+	 */
+	private $blocks;
+
+	/**
+	 * Number of questions on the page.
+	 *
+	 * @var int
+	 */
+	private $count;
+
+	/**
+	 * IDs of the questions on the page.
+	 *
+	 * @var array
+	 */
+	private $ids;
+
+	/**
+	 * WPSEO_Schema_FAQ_Question_List constructor.
+	 *
+	 * @param WP_Block_Parser_Block[] $blocks  An array of the FAQ blocks on this page.
+	 * @param WPSEO_Schema_Context    $context A value object with context variables.
+	 */
+	public function __construct( $blocks, $context ) {
+		$this->blocks  = $blocks;
+		$this->context = $context;
+		$this->count   = 1;
+	}
+
+	/**
+	 * Find an image based on its URL and generate a Schema object for it.
+	 *
+	 * @return array The Schema with a question list added.
+	 */
+	public function generate() {
+		$this->prepare_blocks();
+
+		$this->data[] = [
+			'@type'            => 'ItemList',
+			'mainEntityOfPage' => [ '@id' => $this->get_schema_id() ],
+			'numberOfItems'    => $this->count,
+			'itemListElement'  => $this->ids,
+		];
+
+		return $this->data;
+	}
+
+	/**
+	 * Determine whether we're part of an article or a webpage.
+	 *
+	 * @return string A reference URL.
+	 */
+	private function get_schema_id() {
+		if ( $this->context->site_represents !== false && WPSEO_Schema_Article::is_article_post_type() ) {
+			return $this->context->canonical . WPSEO_Schema_IDs::ARTICLE_HASH;
+		}
+
+		return $this->context->canonical . WPSEO_Schema_IDs::WEBPAGE_HASH;
+	}
+
+	/**
+	 * Loop through the blocks of our type.
+	 */
+	private function prepare_blocks() {
+		foreach ( $this->blocks as $block ) {
+			$this->prepare_questions( $block );
+		}
+	}
+
+	/**
+	 * Prepare our data.
+	 *
+	 * @param WP_Block_Parser_Block[] $block The block to prepare the questions for.
+	 */
+	private function prepare_questions( $block ) {
+		foreach ( $block['attrs']['questions'] as $question ) {
+			if ( ! isset( $question['jsonAnswer'] ) || empty( $question['jsonAnswer'] ) ) {
+				continue;
+			}
+			$this->count ++;
+			$this->ids[] = [ '@id' => $this->context->canonical . '#' . esc_attr( $question['id'] ) ];
+		}
+	}
+}