Page MenuHomeWickedGov Phorge
Files F5976706

StaticArrayWriter.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

StaticArrayWriter.php
View Options

<?php
/**
* @license GPL-2.0-or-later
*/
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 );
}
/**
* Create a PHP file that returns the array.
*
* @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 " . self::encodeArray( $data ) . ";\n";
return $code;
}
/**
* Create an PHP class file with the array as a class constant.
*
* PHP classes can be autoloaded by name, which allows usage to be decoupled
* from the file path.
*
* @since 1.37
* @param array $data
* @param array{header:string,namespace:string,class:string,const:string} $layout
* @return string PHP code
*/
public static function writeClass( array $data, array $layout ) {
$code = "<?php\n"
. "// " . implode( "\n// ", explode( "\n", $layout['header'] ) ) . "\n"
. "\n"
. "namespace {$layout['namespace']};\n"
. "\n"
. "class {$layout['class']} {\n"
. "\tpublic const {$layout['const']} = " . self::encodeArray( $data, "\t\t" ) . ";\n}\n";
return $code;
}
/**
* Recursively turn an array into properly-indented PHP
*
* @param array $array
* @param string $tabs Indentation level
* @return string PHP code
*/
private static function encodeArray( array $array, string $tabs = "\t" ): string {
$code = "[\n";
if ( array_is_list( $array ) ) {
foreach ( $array as $value ) {
$code .= $tabs . self::encodeValue( $value, $tabs ) . ",\n";
}
} else {
foreach ( $array as $key => $value ) {
$code .= $tabs . var_export( $key, true ) . ' => ' .
self::encodeValue( $value, $tabs ) . ",\n";
}
}
return $code . substr( $tabs, 0, -1 ) . ']';
}
/**
* Recursively turn one value into properly-indented PHP
*
* @param mixed $value
* @param string $tabs Indentation level
* @return string PHP code
*/
private static function encodeValue( $value, string $tabs ): string {
if ( is_array( $value ) ) {
return self::encodeArray( $value, $tabs . "\t" );
}
// var_export() exports nulls as uppercase NULL which
// violates our own coding standards.
return $value === null ? 'null' : var_export( $value, true );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 19:21 (1 d, 23 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b7/4c/f905d4e2dcdf669122496fe44e47
Default Alt Text
StaticArrayWriter.php (2 KB)

Event Timeline