Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

parse_ini_string(3) [php man page]

PARSE_INI_STRING(3)							 1						       PARSE_INI_STRING(3)

parse_ini_string - Parse a configuration string

SYNOPSIS
array parse_ini_string (string $ini, [bool $process_sections = false], [int $scanner_mode = INI_SCANNER_NORMAL]) DESCRIPTION
parse_ini_string(3) returns the settings in string $ini in an associative array. The structure of the ini string is the same as the php.ini's. PARAMETERS
o $ini - The contents of the ini file being parsed. o $process_sections - By setting the $process_sections parameter to TRUE, you get a multidimensional array, with the section names and settings included. The default for $process_sections is FALSE o $scanner_mode - Can either be INI_SCANNER_NORMAL (default) or INI_SCANNER_RAW. If INI_SCANNER_RAW is supplied, then option values will not be parsed. As of PHP 5.6.1 can also be specified as INI_SCANNER_TYPED. In this mode boolean, null and integer types are preserved when possible. String values "true", "on" and "yes" are converted to TRUE. "false", "off", "no" and "none" are considered FALSE. "null" is converted to NULL in typed mode. Also, all numeric strings are converted to integer type if it is possible. RETURN VALUES
The settings are returned as an associative array on success, and FALSE on failure. NOTES
Note There are reserved words which must not be used as keys for ini files. These include: null, yes, no, true, false, on, off, none. Values null, off, no and false result in "", and values on, yes and true result in "1", unless INI_SCANNER_TYPED mode is used. Char- acters ?{}|&~![()^" must not be used anywhere in the key and have a special meaning in the value. SEE ALSO
parse_ini_file(3). PHP Documentation Group PARSE_INI_STRING(3)

Check Out this Related Man Page

INI_GET(3)								 1								INI_GET(3)

ini_get - Gets the value of a configuration option

SYNOPSIS
string ini_get (string $varname) DESCRIPTION
Returns the value of the configuration option on success. PARAMETERS
o $varname - The configuration option name. RETURN VALUES
Returns the value of the configuration option as a string on success, or an empty string for null values. Returns FALSE if the configura- tion option doesn't exist. EXAMPLES
Example #1 A few ini_get(3) examples <?php /* Our php.ini contains the following settings: display_errors = On register_globals = Off post_max_size = 8M */ echo 'display_errors = ' . ini_get('display_errors') . " "; echo 'register_globals = ' . ini_get('register_globals') . " "; echo 'post_max_size = ' . ini_get('post_max_size') . " "; echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . " "; echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size')); function return_bytes($val) { $val = trim($val); $last = strtolower($val[strlen($val)-1]); switch($last) { // The 'G' modifier is available since PHP 5.1.0 case 'g': $val *= 1024; case 'm': $val *= 1024; case 'k': $val *= 1024; } return $val; } ?> The above example will output something similar to: display_errors = 1 register_globals = 0 post_max_size = 8M post_max_size+1 = 9 post_max_size in bytes = 8388608 NOTES
Note When querying boolean values A boolean ini value of off will be returned as an empty string or "0" while a boolean ini value of on will be returned as "1". The function can also return the literal string of INI value. Note When querying memory size values Many ini memory size values, such as upload_max_filesize, are stored in the php.ini file in shorthand notation. ini_get(3) will return the exact string stored in the php.ini file and NOT its integer equivalent. Attempting normal arithmetic functions on these values will not have otherwise expected results. The example above shows one way to convert shorthand notation into bytes, much like how the PHP source does it. CHANGELOG
+--------+---------------------------------------------------+ |Version | | | | | | | Description | | | | +--------+---------------------------------------------------+ | 5.3.0 | | | | | | | Previously, the empty string was returned if the | | | configuration option didn't exist. now, FALSE is | | | returned instead. | | | | +--------+---------------------------------------------------+ SEE ALSO
get_cfg_var(3), ini_get_all(3), ini_restore(3), ini_set(3). PHP Documentation Group INI_GET(3)
Man Page