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 array $data Array with 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                 $code = "<?php\n"
  36                         . "// " . implode( "\n// ", explode( "\n", $header ) ) . "\n"
  37                         . "return [\n";
  38                 foreach ( $data as $key => $value ) {
  39                         $code .= $this->encode( $key, $value, 1 );
  40                 }
  41                 $code .= "];\n";
  42                 return $code;
  43         }
  44
  45         /**
  46          * Recursively turn one k/v pair into properly-indented PHP
  47          *
  48          * @param string|int $key
  49          * @param array|mixed $value
  50          * @param int $indent Indentation level
  51          *
  52          * @return string
  53          */
  54         private function encode( $key, $value, $indent ) {
  55                 $tabs = str_repeat( "\t", $indent );
  56                 $line = $tabs .
  57                         var_export( $key, true ) .
  58                         ' => ';
  59                 if ( is_array( $value ) ) {
  60                         $line .= "[\n";
  61                         foreach ( $value as $key2 => $value2 ) {
  62                                 $line .= $this->encode( $key2, $value2, $indent + 1 );
  63                         }
  64                         $line .= "$tabs]";
  65                 } else {
  66                         $line .= var_export( $value, true );
  67                 }
  68
  69                 $line .= ",\n";
  70                 return $line;
  71         }
  72 }