wiki.techinc.nl/includes/libs/StaticArrayWriter.php
daniel bd5c3d06a2 Annotate newable classes
This annotates classes that can safely be instantiated by
extensions, per the Stable Interface Policy.

Bug: T247862
Change-Id: Ia280f559874fc0750265ddeb7f831e65fd7d7d6a
2020-07-07 15:38:57 +02:00

78 lines
2.1 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
namespace Wikimedia;
/**
* Format a static PHP array to be written to a file
*
* @newable
* @since 1.32
*/
class StaticArrayWriter {
/**
* @param array $data Array with keys/values to export
* @param string $header
* @return string PHP code
*/
public function create( array $data, $header = 'Automatically generated' ) {
return self::write( $data, $header );
}
/**
* @since 1.35
* @param array $data Array with keys/values to export
* @param string $header
* @return string PHP code
*/
public static function write( array $data, $header ) {
$code = "<?php\n"
. "// " . implode( "\n// ", explode( "\n", $header ) ) . "\n"
. "return [\n";
foreach ( $data as $key => $value ) {
$code .= self::encode( $key, $value, 1 );
}
$code .= "];\n";
return $code;
}
/**
* Recursively turn one k/v pair into properly-indented PHP
*
* @param string|int $key
* @param mixed $value
* @param int $indent Indentation level
* @return string PHP code
*/
private static function encode( $key, $value, $indent ) {
$tabs = str_repeat( "\t", $indent );
$line = $tabs . var_export( $key, true ) . ' => ';
if ( is_array( $value ) ) {
$line .= "[\n";
foreach ( $value as $subkey => $subvalue ) {
$line .= self::encode( $subkey, $subvalue, $indent + 1 );
}
$line .= "$tabs]";
} else {
$line .= var_export( $value, true );
}
$line .= ",\n";
return $line;
}
}