|
1 | 1 | <?php |
| 2 | +declare(strict_types = 1); |
2 | 3 | /** |
3 | | - * A more readable implementation of PHP function var_dump(); |
| 4 | + * A more readable implementation of PHP function `var_dump()`. Provides syntax-highlighted insight even into nested objects,arrays, etc. |
4 | 5 | * |
5 | | - * Provides syntax-highlighted insight even into nested objects,arrays, etc. |
| 6 | + * @param mixed $value The variable to print out |
| 7 | + * @param bool $dontDie If set to `TRUE` the script will not be aborted after execution of this function. |
| 8 | + * @param bool $initCall Dont specifiy this parameter. xout will use it cause it call itself. |
| 9 | + * @return void |
6 | 10 | * |
7 | 11 | * ``` |
8 | 12 | * //Example usage: |
9 | 13 | * $var = ['cars' => ['audi','bmw'], 'nothing' => (object)['name' => 'Mario', 'age' => 34]]; |
10 | 14 | * xout($var); |
11 | 15 | * ``` |
12 | | - * |
13 | | - * @param mixed $value The variable to print out |
14 | | - * @param bool $dontDie Default = false. If set to true the script will not be aborted after execution of this function. |
15 | 16 | */ |
16 | | -public static function xout($value, bool $dontDie = false) |
| 17 | +function xout($value, bool $dontDie = false, bool $initCall = true) |
17 | 18 | { |
18 | | - function xout_($value, bool $dontDie, bool $initCall) |
| 19 | + //You can define your own syntax coloring here. |
| 20 | + $baseColor = 'black'; |
| 21 | + $objectClassColor = 'gray'; |
| 22 | + $arrayTypeColor = 'blue'; |
| 23 | + $objectTypeColor = 'blue'; |
| 24 | + $stringTypeColor = 'red'; |
| 25 | + $integerTypeColor = 'orange'; |
| 26 | + $doubleTypeColor = 'teal'; |
| 27 | + $resourceTypeColor = 'purple'; |
| 28 | + $resourceClosedTypeColor = 'plum'; |
| 29 | + $booleanTypeColor = 'green'; |
| 30 | + $nullTypeColor = 'gray'; |
| 31 | + |
| 32 | + $result = $initCall ? '<div id="xout-container" style="font-family: Courier New; font-weight: bold; font-size: 15px; color:'.$baseColor.';">' : ''; |
| 33 | + |
| 34 | + $isSimpleVar = false; |
| 35 | + $valueType = gettype($value); |
| 36 | + switch($valueType) |
19 | 37 | { |
20 | | - //You can define you colors here (CSS value): |
21 | | - $baseColor = 'black'; |
22 | | - $objectClassColor = 'gray'; |
23 | | - $arrayTypeColor = 'blue'; |
24 | | - $objectTypeColor = 'blue'; |
25 | | - $stringTypeColor = 'red'; |
26 | | - $integerTypeColor = 'orange'; |
27 | | - $doubleTypeColor = 'teal'; |
28 | | - $resourceTypeColor = 'black'; |
29 | | - $booleanTypeColor = 'green'; |
30 | | - $nullTypeColor = 'gray'; |
| 38 | + case 'array' : $result .= '<span>ARRAY</span><br />'.htmlspecialchars('['); break; |
| 39 | + case 'object' : $result .= '<span>OBJECT</span> <span style="color:'.$objectClassColor.';">' . get_class($value) . '</span><br />'.htmlspecialchars('('); break; |
| 40 | + default : $value = [$value]; $isSimpleVar = true; break; |
| 41 | + } |
31 | 42 |
|
32 | | - $result = $initCall ? '<div id="xout-container" style="font-family: Courier New; font-weight: bold; font-size: 15px; color:'.$baseColor.';">' : ''; |
| 43 | + $result .= '<ul style="list-style-type: none; margin: 0;">'; |
33 | 44 |
|
34 | | - $isSimpleVar = false; |
35 | | - $valueType = gettype($value); |
36 | | - switch($valueType) |
| 45 | + foreach ($value as $key => $val) |
| 46 | + { |
| 47 | + $valType = gettype($val); |
| 48 | + if ($valType === 'array' || $valType === 'object') |
37 | 49 | { |
38 | | - case 'array' : $result .= '<span>ARRAY</span><br />'.htmlspecialchars('['); break; |
39 | | - case 'object' : $result .= '<span>OBJECT</span> <span style="color:'.$objectClassColor.';">' . get_class($value) . '</span><br />'.htmlspecialchars('('); break; |
40 | | - default : $value = [$value]; $isSimpleVar = true; break; |
| 50 | + if ($valueType === 'array') |
| 51 | + { |
| 52 | + $result .= '<li><span style="color:'.$arrayTypeColor.';">[' . htmlspecialchars(strval($key)) . ']</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('=>').' </b><span>' . xout($val, $dontDie, false) . '</span></li>'; |
| 53 | + } |
| 54 | + if ($valueType === 'object') |
| 55 | + { |
| 56 | + $result .= '<li><span style="color:'.$objectTypeColor.';">' . htmlspecialchars(strval($key)) . '</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('->').' </b><span>' . xout($val, $dontDie, false) . '</span></li>'; |
| 57 | + } |
41 | 58 | } |
42 | | - |
43 | | - $result .= '<ul style="list-style-type: none; margin: 0;">'; |
44 | | - |
45 | | - foreach ($value as $key => $val) |
| 59 | + else |
46 | 60 | { |
47 | | - $valType = gettype($val); |
48 | | - if ($valType === 'array' || $valType === 'object') |
| 61 | + $color = 'black'; |
| 62 | + switch($valType) |
49 | 63 | { |
50 | | - if ($valueType === 'array') |
51 | | - { |
52 | | - $result .= '<li><span style="color:'.$arrayTypeColor.';">[' . htmlspecialchars($key) . ']</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('=>').' </b><span>' . xout_($val, $dontDie, false) . '</span></li>'; |
53 | | - } |
54 | | - if ($valueType === 'object') |
55 | | - { |
56 | | - $result .= '<li><span style="color:'.$objectTypeColor.';">' . htmlspecialchars($key) . '</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('->').' </b><span>' . xout_($val, $dontDie, false) . '</span></li>'; |
57 | | - } |
| 64 | + case 'string' : $color = $stringTypeColor; $val = htmlspecialchars('\'').$val.htmlspecialchars('\''); break; |
| 65 | + case 'integer' : $color = $integerTypeColor; $val = strval($val); break; |
| 66 | + case 'double' : $color = $doubleTypeColor; $val = strval($val); break; |
| 67 | + case 'resource' : $color = $resourceTypeColor; $val = 'resource ('.get_resource_type($val).')'; break; |
| 68 | + case 'resource (closed)' : $color = $resourceClosedTypeColor; $val = 'resource (closed)'; break; |
| 69 | + case 'boolean' : $color = $booleanTypeColor; $val = ($val === true) ? 'TRUE' : 'FALSE'; break; |
| 70 | + case 'NULL' : $color = $nullTypeColor; $val = 'NULL'; break; |
58 | 71 | } |
59 | | - else |
| 72 | + |
| 73 | + $result .= '<li>'; |
| 74 | + if(!$isSimpleVar) |
60 | 75 | { |
61 | | - $color = 'black'; |
62 | | - switch($valType) |
| 76 | + if($valueType === 'array') |
63 | 77 | { |
64 | | - case 'string' : $color = $stringTypeColor; $val = htmlspecialchars('\'').$val.htmlspecialchars('\''); break; |
65 | | - case 'integer' : $color = $integerTypeColor; break; |
66 | | - case 'double' : $color = $doubleTypeColor; break; |
67 | | - case 'resource' : $color = $resourceTypeColor; break; |
68 | | - case 'resource (closed)' : $color = $resourceTypeColor; break; |
69 | | - case 'boolean' : $color = $booleanTypeColor; $val = ($val === true) ? 'TRUE' : 'FALSE'; break; |
70 | | - case 'NULL' : $color = $nullTypeColor; $val = 'NULL'; break; |
| 78 | + $result .= '<span style="color:'.$arrayTypeColor.';">[' . htmlspecialchars(strval($key)) . ']</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('=>').' </b>'; |
71 | 79 | } |
72 | | - |
73 | | - $result .= '<li>'; |
74 | | - if(!$isSimpleVar) |
| 80 | + if($valueType === 'object') |
75 | 81 | { |
76 | | - if($valueType === 'array') |
77 | | - { |
78 | | - $result .= '<span style="color:'.$arrayTypeColor.';">[' . htmlspecialchars($key) . ']</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('=>').' </b>'; |
79 | | - } |
80 | | - if($valueType === 'object') |
81 | | - { |
82 | | - $result .= '<span style="color:'.$objectTypeColor.';">' . htmlspecialchars($key) . '</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('->').' </b>'; |
83 | | - } |
| 82 | + $result .= '<span style="color:'.$objectTypeColor.';">' . htmlspecialchars(strval($key)) . '</span><b style="color:'.$baseColor.';"> '.htmlspecialchars('->').' </b>'; |
84 | 83 | } |
85 | | - $result .= '<span style="color:'.$color.';">' . htmlspecialchars($val) . '</span></li>'; |
86 | 84 | } |
| 85 | + $result .= '<span style="color:'.$color.';">' . htmlspecialchars($val) . '</span></li>'; |
87 | 86 | } |
| 87 | + } |
88 | 88 |
|
89 | | - $result .= '</ul>'; |
| 89 | + $result .= '</ul>'; |
90 | 90 |
|
91 | | - if(!$isSimpleVar) |
| 91 | + if(!$isSimpleVar) |
| 92 | + { |
| 93 | + switch($valueType) |
92 | 94 | { |
93 | | - switch($valueType) |
94 | | - { |
95 | | - case 'array' : $result .= htmlspecialchars(']'); break; |
96 | | - case 'object' : $result .= htmlspecialchars(')'); break; |
97 | | - } |
| 95 | + case 'array' : $result .= htmlspecialchars(']'); break; |
| 96 | + case 'object' : $result .= htmlspecialchars(')'); break; |
98 | 97 | } |
| 98 | + } |
99 | 99 |
|
100 | | - $result .= $initCall ? '</div>' : ''; |
| 100 | + $result .= $initCall ? '</div>' : ''; |
101 | 101 |
|
102 | | - if($initCall) //Finished |
103 | | - { |
104 | | - echo($result); |
105 | | - if(!$dontDie) |
106 | | - { |
107 | | - die(); |
108 | | - } |
109 | | - } |
110 | | - else //End of recursive call |
| 102 | + if($initCall) //Finished |
| 103 | + { |
| 104 | + echo($result); |
| 105 | + if(!$dontDie) |
111 | 106 | { |
112 | | - return $result; |
| 107 | + die(); |
113 | 108 | } |
114 | 109 | } |
115 | | - //Lets go: |
116 | | - xout_($value, $dontDie, true); |
| 110 | + else //End of recursive call |
| 111 | + { |
| 112 | + return $result; |
| 113 | + } |
117 | 114 | } |
0 commit comments