1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
<?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 );
}
/**
* 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, 1 ) . ";\n}\n";
return $code;
}
/**
* Recursively turn an array into properly-indented PHP
*
* @param array $array
* @param int $indent Indentation level
* @return string PHP 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;
}
/**
* 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 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;
}
/**
* Recursively turn one list item into properly-indented PHP
*
* @param mixed $value
* @param int $indent Indentation level
* @return string PHP code
*/
private static function encodeItem( $value, $indent = 0 ) {
$tabs = str_repeat( "\t", $indent );
$line = $tabs . self::encodeValue( $value, $indent );
$line .= ",\n";
return $line;
}
/**
* Recursively turn one value into properly-indented PHP
*
* @since 1.38
* @param mixed $value
* @param int $indent Indentation level
* @return string PHP code
*/
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;
}
}
}
|
