includes/libs/StaticArrayWriter.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  *
  17  */
  18
  19 namespace Wikimedia;
  20
  21 /**
  22  * Format a static PHP array to be written to a file
  23  *
  24  * @since 1.32
  25  */
  26 class StaticArrayWriter {
  27
  28         /**
  29          * @param string[] $data Array with string keys/values to export
  30          * @param string $header
  31          *
  32          * @return string PHP code
  33          */
  34         public function create( array $data, $header = 'Automatically generated' ) {
  35                 $format = "\t%s => %s,\n";
  36                 $code = "<?php\n"
  37                         . "// " . implode( "\n// ", explode( "\n", $header ) ) . "\n"
  38                         . "return [\n";
  39                 foreach ( $data as $key => $value ) {
  40                         $code .= sprintf(
  41                                 $format,
  42                                 var_export( $key, true ),
  43                                 var_export( $value, true )
  44                         );
  45                 }
  46                 $code .= "];\n";
  47                 return $code;
  48         }
  49 }