Is it possible and safe to use inline comments for .ini files with PHP?
I prefer a system where the comments are inline with the variables, coming after them.
Are the some gotchas concerning the syntax to be used?
Is it possible and safe to use inline comments for .ini files with PHP?
I prefer a system where the comments are inline with the variables, coming after them.
Are the some gotchas concerning the syntax to be used?
what ini files are you talking about and what inline comments? are you talking about php.ini file or your custom .ini file? if custom, why not to have custom format as well counting inline comments in?
If you're talking about the built-in INI file parsing function, semicolon is the comment character it expects, and I believe it accepts them inline.
INI format uses semicolon as a comment character. It accepts them anywhere in the file.
key1=value
; this is a comment
key2=value ; this is a comment too
<?php
$ini = <<<INI
; this is comment
[section]
x = y
z = "1"
foo = "bar" ; comment here!
quux = xyzzy ; comment here also!
a = b # comment too
INI;
$inifile = tempnam(dirname(__FILE__), 'ini-temp__');
file_put_contents($inifile, $ini);
$a = parse_ini_file($inifile, true);
if ($a !== false)
{
print_r($a);
}
else
{
echo "Couldn't read '$inifile'";
}
unlink($inifile);
Outputs:
Array
(
[section] => Array
(
[x] => y
[z] => 1
[foo] => bar
[quux] => xyzzy
[a] => b # comment too
)
)