peptide-repo/peptide-repo-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style: fix non-auto-fixable PHPCS violations — docblocks + wp_parse_url

Browse Source 
All inline `/** @var ... */` single-line docblocks on class constants
and the $reader property are expanded to multi-line form with a proper
short description as the first tag (resolves
Generic.Commenting.DocComment.MissingShort on 8 locations across 2 files).

parse_url() → wp_parse_url() in sanitize_url() per WPCS
WordPress.WP.AlternativeFunctions.parse_url_parse_url (1 location).

No behaviour change: pure style/documentation fixes.

Agent-Session: prcore-jsonld-phpcs-20260623
This commit is contained in:
peptiderepo
2026-06-23 04:41:17 +00:00
parent f7df9cfc06
commit edb4afe71e
2 changed files with 41 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
includes/frontend/class-pr-core-jsonld-article.php
View File

@@ -39,7 +39,11 @@ declare(strict_types=1);
*/ */
class PR_Core_Jsonld_Article { class PR_Core_Jsonld_Article {
/** @var PR_Core_Prab_Meta_Reader Meta reader instance. */ /**
* Meta reader instance.
*
* @var PR_Core_Prab_Meta_Reader
*/
private PR_Core_Prab_Meta_Reader $reader; private PR_Core_Prab_Meta_Reader $reader;
/** /**

44
includes/frontend/class-pr-core-prab-meta-reader.php
View File

@@ -27,25 +27,53 @@ declare(strict_types=1);
*/ */
class PR_Core_Prab_Meta_Reader { class PR_Core_Prab_Meta_Reader {
/** @var string Presence = opt-in trigger; value must equal 1. */ /**
* Schema version meta key; presence opts the post in, value must equal 1.
*
* @var string
*/
public const META_SCHEMA_VERSION = '_prab_schema_version'; public const META_SCHEMA_VERSION = '_prab_schema_version';
/** @var string JSON array of {url, title, doi?, quality_score?} citation objects. */ /**
* Citations meta key; JSON array of {url, title, doi?, quality_score?} objects.
*
* @var string
*/
public const META_CITATIONS = '_prab_citations'; public const META_CITATIONS = '_prab_citations';
/** @var string JSON array of peptide post IDs (ints) for `about` linkage. */ /**
* About-peptides meta key; JSON array of peptide post IDs (ints) for schema `about`.
*
* @var string
*/
public const META_ABOUT_PEPTIDES = '_prab_about_peptides'; public const META_ABOUT_PEPTIDES = '_prab_about_peptides';
/** @var string Review mode: 'human' | 'editorial-system'. */ /**
* Review mode meta key; value is 'human' or 'editorial-system'.
*
* @var string
*/
public const META_REVIEW_MODE = '_prab_review_mode'; public const META_REVIEW_MODE = '_prab_review_mode';
/** @var string ISO 8601 datetime of last review. */ /**
* Reviewed-at meta key; ISO 8601 datetime of last review.
*
* @var string
*/
public const META_REVIEWED_AT = '_prab_reviewed_at'; public const META_REVIEWED_AT = '_prab_reviewed_at';
/** @var string WP user ID of the Review Queue approver. */ /**
* Reviewed-by meta key; stores the WP user ID of the Review Queue approver.
*
* @var string
*/
public const META_REVIEWED_BY = '_prab_reviewed_by'; public const META_REVIEWED_BY = '_prab_reviewed_by';
/** @var int The only schema version this reader supports. */ /**
* The only schema version this reader currently supports.
*
* @var int
*/
private const SUPPORTED_VERSION = 1; private const SUPPORTED_VERSION = 1;
/** /**
@@ -240,7 +268,7 @@ class PR_Core_Prab_Meta_Reader {
if ( '' === $url || ! filter_var( $url, FILTER_VALIDATE_URL ) ) { if ( '' === $url || ! filter_var( $url, FILTER_VALIDATE_URL ) ) {
return ''; return '';
} }
$scheme = (string) parse_url( $url, PHP_URL_SCHEME ); $scheme = (string) wp_parse_url( $url, PHP_URL_SCHEME );
return in_array( $scheme, array( 'http', 'https' ), true ) ? $url : ''; return in_array( $scheme, array( 'http', 'https' ), true ) ? $url : '';
} }