b84cc656e5
- All 49 PHP includes files: expand minimal file docblocks to include a short description (satisfies Generic.Commenting.DocComment.MissingShort) Format: <?php\n/**\n * Filename-derived description.\n *\n * @package ...\n */ - settings.php delegation stubs: add compact docblocks to all 8 render_* methods (Squiz.Commenting.FunctionComment.Missing, lines 93-231) - settings.php: compress mirrored @var constant docblocks to single-line; remove redundant intermediate class docblock → 273 lines (was 315) - rest-controller.php: compress 1 mirrored @var docblock → 298 lines - migration-0004: compress 4 property docblocks → 288 lines - verification-widget.php line 111: cast days_since to int + phpcs:ignore - verification-metabox.php line 80: phpcs:ignore on hardcoded badge_class - peptide-metaboxes.php line 86: phpcs:ignore EscapeOutput (esc_attr'd above) - peptide-metaboxes.php lines 147/148: Yoda null !== dose_min/dose_max - peptide-metaboxes.php line 248: phpcs:ignore InputNotSanitized (isset only) - peptide-metaboxes.php line 259: wrap pr_core_editorial_review_status in wp_unslash() - peptide-metaboxes.php line 262: Yoda 'published' !== old_status Agent-Session: claude-adopt-ci-20260616
117 lines
3.2 KiB
PHP
117 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* Jsonld Faq.
|
|
*
|
|
* @package Peptide_Repo_Core
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* Reads _pr_faq_items post-meta (JSON array of {question, answer} objects)
|
|
*
|
|
* @package Peptide_Repo_Core
|
|
*/
|
|
|
|
/**
|
|
* Builds the schema.org FAQPage graph piece for a peptide page.
|
|
*
|
|
* What: Reads _pr_faq_items post-meta (JSON array of {question, answer} objects)
|
|
* and produces a FAQPage node suitable for injection into Yoast's graph.
|
|
* Emits nothing when the meta is empty or absent.
|
|
*
|
|
* Who calls it: PR_Core_Jsonld::build_faq_piece() during graph assembly.
|
|
* Dependencies: WordPress get_post_meta(), get_permalink().
|
|
*
|
|
* @see frontend/class-pr-core-jsonld.php — Orchestrator that calls this builder.
|
|
* @see cpt/class-pr-core-schema-sanitizers.php — sanitize_faq_items() used on save.
|
|
* @see ARCHITECTURE.md — §2.7 JSON-LD output.
|
|
*/
|
|
class PR_Core_Jsonld_Faq {
|
|
|
|
/**
|
|
* Meta key holding the FAQ items JSON array.
|
|
*
|
|
* @var string Meta key holding the FAQ items JSON array.
|
|
*/
|
|
public const META_FAQ_ITEMS = '_pr_faq_items';
|
|
|
|
/**
|
|
* Build a FAQPage node for a post, or return null if no items exist.
|
|
*
|
|
* @param int $post_id WordPress post ID.
|
|
* @param string $permalink Canonical permalink for @id construction.
|
|
* @return array<string, mixed>|null FAQPage schema node, or null when no items.
|
|
*/
|
|
public function build( int $post_id, string $permalink ): ?array {
|
|
$items = $this->get_validated_items( $post_id );
|
|
|
|
if ( empty( $items ) ) {
|
|
return null;
|
|
}
|
|
|
|
return array(
|
|
'@type' => 'FAQPage',
|
|
'@id' => $permalink . '#faq',
|
|
'mainEntity' => array_map( array( $this, 'build_question' ), $items ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Build a single Question node from a FAQ item array.
|
|
*
|
|
* @param array{question: string, answer: string} $item Sanitized FAQ item.
|
|
* @return array<string, mixed> Schema.org Question node.
|
|
*/
|
|
private function build_question( array $item ): array {
|
|
return array(
|
|
'@type' => 'Question',
|
|
'name' => esc_html( $item['question'] ),
|
|
'acceptedAnswer' => array(
|
|
'@type' => 'Answer',
|
|
'text' => esc_html( $item['answer'] ),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Read and validate _pr_faq_items meta, returning only well-formed items.
|
|
*
|
|
* Returns empty array when meta is absent, empty, or malformed.
|
|
* Does not trust stored values — re-validates each item at read time.
|
|
*
|
|
* @param int $post_id WordPress post ID.
|
|
* @return array<int, array{question: string, answer: string}> Validated items.
|
|
*/
|
|
private function get_validated_items( int $post_id ): array {
|
|
$raw = get_post_meta( $post_id, self::META_FAQ_ITEMS, true );
|
|
|
|
if ( ! is_string( $raw ) || '' === $raw ) {
|
|
return array();
|
|
}
|
|
|
|
$decoded = json_decode( $raw, true );
|
|
|
|
if ( ! is_array( $decoded ) || empty( $decoded ) ) {
|
|
return array();
|
|
}
|
|
|
|
$valid = array();
|
|
foreach ( $decoded as $item ) {
|
|
if ( ! is_array( $item ) ) {
|
|
continue;
|
|
}
|
|
$question = sanitize_text_field( (string) ( $item['question'] ?? '' ) );
|
|
$answer = sanitize_textarea_field( (string) ( $item['answer'] ?? '' ) );
|
|
if ( '' !== $question && '' !== $answer ) {
|
|
$valid[] = array(
|
|
'question' => $question,
|
|
'answer' => $answer,
|
|
);
|
|
}
|
|
}
|
|
|
|
return $valid;
|
|
}
|
|
}
|