maintenance/generateConfigSchemaArray.php

   1 <?php
   2
   3 use Wikimedia\StaticArrayWriter;
   4
   5 require_once __DIR__ . '/Maintenance.php';
   6 require_once __DIR__ . '/includes/ConfigSchemaDerivativeTrait.php';
   7
   8 /**
   9  * Maintenance script that generates the PHP representation of the config-schema.yaml file.
  10  *
  11  * @ingroup Maintenance
  12  */
  13 class GenerateConfigSchemaArray extends Maintenance {
  14         use ConfigSchemaDerivativeTrait;
  15
  16         /** @var string */
  17         private const DEFAULT_OUTPUT_PATH = __DIR__ . '/../includes/config-schema.php';
  18
  19         public function __construct() {
  20                 parent::__construct();
  21
  22                 $this->addDescription( 'Generate an optimized config-schema.php file.' );
  23
  24                 $this->addOption(
  25                         'output',
  26                         'Path to output relative to $IP. Default: ' . self::DEFAULT_OUTPUT_PATH,
  27                         false,
  28                         true
  29                 );
  30         }
  31
  32         public function execute() {
  33                 $schema = $this->loadSettingsSource();
  34
  35                 foreach ( $schema['config-schema'] as $key => &$value ) {
  36                         unset( $value['description'] );
  37                 }
  38
  39                 $content = ( new StaticArrayWriter() )->write(
  40                         $schema,
  41                         "This file is automatically generated using maintenance/generateConfigSchema.php.\n" .
  42                         "phpcs:disable Generic.Files.LineLength"
  43                 );
  44
  45                 $this->writeOutput( self::DEFAULT_OUTPUT_PATH, $content );
  46         }
  47 }
  48
  49 $maintClass = GenerateConfigSchemaArray::class;
  50 require_once RUN_MAINTENANCE_IF_MAIN;