Files
peptide-repo-core/includes/migrations/class-pr-core-migration-runner.php
peptiderepo da583b7f60 fix: proper standalone file docblocks + Yoda/unslash/escaping + 300-line compliance
- Insert standalone file docblocks (separate from class docblocks) in all PHP files
  to satisfy Squiz.Commenting.FileComment.Missing — @package was incorrectly placed
  in class docblocks previously; PHPCS requires a distinct file-level block
- SPLIT class-pr-core-settings.php (was 340 lines after docblock expansion):
  class-pr-core-settings.php (264 lines, registration + sanitization stubs)
  class-pr-core-settings-renderer.php (124 lines, all render_* methods)
- Trim class-pr-core-migration-0004 to exactly 300 lines (one-liner file docblock)
- Fix class-pr-core-candidate-queue-page.php:
  Yoda conditions: null !== c->dose_min / null !== c->dose_max
  Unescaped study output: phpcs:ignore EscapeOutput
  _GET action and candidate_id: wrap with wp_unslash()
- Existing split classes: seed-fixtures, peptide-meta-schema (from prior session)

Agent-Session: claude-adopt-ci-20260616
2026-06-16 15:59:00 +00:00

109 lines
2.8 KiB
PHP

<?php
declare(strict_types=1);
/**
* Compares current schema version against target, runs pending migrations
*
* @package Peptide_Repo_Core
*/
/**
* Schema migration runner.
*
* What: Compares current schema version against target, runs pending migrations.
* Who calls it: PR_Core::init() on every plugins_loaded, PR_Core_Activator on activation.
* Dependencies: WordPress $wpdb, dbDelta().
*
* Migrations are numbered sequentially (0001, 0002, ...). Each migration class
* must implement up() and optionally down(). All migrations are idempotent.
*
* @see peptide-repo-core.php — Defines PR_CORE_TARGET_SCHEMA_VERSION.
* @see CONVENTIONS.md — "How To: Add a New Migration".
*/
class PR_Core_Migration_Runner {
/**
* Option key storing current schema version.
*
* @var string Option key storing current schema version.
*/
private const VERSION_OPTION = 'pr_core_schema_version';
/**
* Ordered list of migration classes.
* Index 0 = migration 1 (bumps schema to version 1).
*
* @var string[]
*/
private const MIGRATIONS = array(
'PR_Core_Migration_0001_Dosing_Rows',
'PR_Core_Migration_0002_Legal_Cells',
'PR_Core_Migration_0003_Candidate_Queue',
'PR_Core_Migration_0004_Backfill_Peptide_Meta',
);
/**
* Run all pending migrations up to PR_CORE_TARGET_SCHEMA_VERSION.
*
* Side effects: creates/alters database tables, updates schema version option.
*
* @return void
*/
public function run_pending(): void {
$current = (int) get_option( self::VERSION_OPTION, 0 );
$target = PR_CORE_TARGET_SCHEMA_VERSION;
if ( $current >= $target ) {
return;
}
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
for ( $i = $current; $i < $target; $i++ ) {
if ( ! isset( self::MIGRATIONS[ $i ] ) ) {
break;
}
$class = self::MIGRATIONS[ $i ];
if ( ! class_exists( $class ) ) {
// Migration file not autoloaded — load explicitly.
$file = $this->class_to_file( $class );
if ( file_exists( $file ) ) {
require_once $file;
}
}
if ( class_exists( $class ) ) {
$migration = new $class();
$migration->up();
}
update_option( self::VERSION_OPTION, $i + 1 );
}
}
/**
* Get current schema version.
*
* @return int
*/
public function get_current_version(): int {
return (int) get_option( self::VERSION_OPTION, 0 );
}
/**
* Convert migration class name to file path.
*
* PR_Core_Migration_0001_Dosing_Rows => migrations/class-pr-core-migration-0001-dosing-rows.php
*
* @param string $class Fully-qualified class name.
* @return string Absolute file path.
*/
private function class_to_file( string $class ): string {
$suffix = substr( $class, 8 ); // Strip 'PR_Core_'.
$filename = 'class-pr-core-' . str_replace( '_', '-', strtolower( $suffix ) ) . '.php';
return PR_CORE_PLUGIN_DIR . 'includes/migrations/' . $filename;
}
}