StaticArrayWriter.php

Go to the documentation of this file.

<?php
namespace Wikimedia;
 
class StaticArrayWriter {
    public function create( array $data, $header = 'Automatically generated' ) {
        return self::write( $data, $header );
    }
 
    public static function write( array $data, $header ) {
        $code = "<?php\n"
            . "// " . implode( "\n// ", explode( "\n", $header ) ) . "\n"
            . "return " . self::encodeArray( $data ) . ";\n";
        return $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, 1 ) . ";\n}\n";
        return $code;
    }
 
    private static function encodeArray( array $array, $indent = 0 ) {
        $code = "[\n";
        $tabs = str_repeat( "\t", $indent );
        if ( array_is_list( $array ) ) {
            foreach ( $array as $item ) {
                $code .= self::encodeItem( $item, $indent + 1 );
            }
        } else {
            foreach ( $array as $key => $value ) {
                $code .= self::encodePair( $key, $value, $indent + 1 );
            }
        }
        $code .= "$tabs]";
        return $code;
    }
 
    private static function encodePair( $key, $value, $indent = 0 ) {
        $tabs = str_repeat( "\t", $indent );
        $line = $tabs . var_export( $key, true ) . ' => ';
        $line .= self::encodeValue( $value, $indent );
 
        $line .= ",\n";
        return $line;
    }
 
    private static function encodeItem( $value, $indent = 0 ) {
        $tabs = str_repeat( "\t", $indent );
        $line = $tabs . self::encodeValue( $value, $indent );
 
        $line .= ",\n";
        return $line;
    }
 
    public static function encodeValue( $value, $indent = 0 ) {
        if ( is_array( $value ) ) {
            return self::encodeArray( $value, $indent );
        } else {
            $exportedValue = var_export( $value, true );
            if ( $exportedValue === 'NULL' ) {
                // var_export() exports nulls as uppercase NULL which
                // violates our own coding standards.
                $exportedValue = 'null';
            }
            return $exportedValue;
        }
    }
}