ini_get

Dmitry Vinogradov (2012-08-02 21:06:04)

Here's more comprehensive function returning number of bytes from strings like max_post_size or upload_max_filesize. It handles both 'k'/'kb', 'm'/'mb', and 'g'/'gb' at the end of the string, and is case insensitive.

<?php
function return_bytes($val) 
{
    $val = trim($val);
    
    switch (strtolower(substr($val, -1)))
    {
        case 'm': $val = (int)substr($val, 0, -1) * 1048576; break;
        case 'k': $val = (int)substr($val, 0, -1) * 1024; break;
        case 'g': $val = (int)substr($val, 0, -1) * 1073741824; break;
        case 'b':
            switch (strtolower(substr($val, -2, 1)))
            {
                case 'm': $val = (int)substr($val, 0, -2) * 1048576; break;
                case 'k': $val = (int)substr($val, 0, -2) * 1024; break;
                case 'g': $val = (int)substr($val, 0, -2) * 1073741824; break;
                default : break;
            } break;
        default: break;
    }
    return $val;
}
?>

Ivo Mandalski (2011-11-15 08:27:52)

This version of return_bytes takes care of the MB, GB, KB cases along with the M,G,K ones.
Hope this is helpful!

<?php
    public static function return_bytes ($val)
    {
        if(empty($val))return 0;

        $val = trim($val);

        preg_match('#([0-9]+)[\s]*([a-z]+)#i', $val, $matches);

        $last = '';
        if(isset($matches[2])){
            $last = $matches[2];
        }

        if(isset($matches[1])){
            $val = (int) $matches[1];
        }

        switch (strtolower($last))
        {
            case 'g':
            case 'gb':
                $val *= 1024;
            case 'm':
            case 'mb':
                $val *= 1024;
            case 'k':
            case 'kb':
                $val *= 1024;
        }

        return (int) $val;
    }
?>

Stas Trefilov, OpteamIS (2010-03-26 10:08:06)

another version of return_bytes which returns faster and does not use multiple multiplications (sorry:). even if it is resolved at compile time it is not a good practice;
no local variables are allocated;
the trim() is omitted (php already trimmed values when reading php.ini file);
strtolower() is replaced by second case which wins us one more function call for the price of doubling the number of cases to process (may slower the worst-case scenario when ariving to default: takes six comparisons instead of three comparisons and a function call);
cases are ordered by most frequent goes first (uppercase M-values being the default sizes);
specs say we must handle integer sizes so float values are converted to integers and 0.8G becomes 0;
'Gb', 'Mb', 'Kb' shorthand byte options are not implemented since are not in specs, see
http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes

<?php
function return_bytes ($size_str)
{
    switch (substr ($size_str, -1))
    {
        case 'M': case 'm': return (int)$size_str * 1048576;
        case 'K': case 'k': return (int)$size_str * 1024;
        case 'G': case 'g': return (int)$size_str * 1073741824;
        default: return $size_str;
    }
}
?>

nicolas dot grekas+php at gmail dot com (2009-08-19 10:51:14)

Here is how to accurately test for boolean php.ini values:

<?php

function ini_get_bool($a)
{
    $b = ini_get($a);

    switch (strtolower($b))
    {
    case 'on':
    case 'yes':
    case 'true':
        return 'assert.active' !== $a;

    case 'stdout':
    case 'stderr':
        return 'display_errors' === $a;

    default:
        return (bool) (int) $b;
    }
}

?>

Nathaniel Sabanski (2009-03-15 02:20:34)

Here's a simplified version of return_bytes() that does not rely on non-breaking cases and variable variables.

<?php

function return_bytes($val) 
{
    $val = trim($val);
    $last = strtolower(substr($val, -1));
    
    if($last == 'g')
        $val = $val*1024*1024*1024;
    if($last == 'm')
        $val = $val*1024*1024;
    if($last == 'k')
        $val = $val*1024;
        
    return $val;
}

?>

peter (2008-07-29 14:25:11)

The above example function called return_bytes() assumes that ini_get('upload_max_filesize') delivers only one letter at the end. As I've seen 'Mb' and things like that, I'd suggest to change the $last = ... part into $last = strtolower(substr($val,strlen($val/1),1)).
I'd call it $unit then.

filh at filh dot org (2005-11-21 06:24:55)

Concerning the value retourned, it depends on how you set it.
I had the problem with horde-3 which test the safe_mode value.
THan :
- if you set the value with php_admin_value safe_mode Off (or On) ini_get returns the string
- if you set the value with php_admin_flag safe_mode Off (or On) ini_get returns the boolean.

(2005-10-31 23:16:05)

Important: The manual says that ini_get will return 0 or an empty string for boolean config values that are set to off in php.ini.
This is technically correct, however when you use
php_value register_globals off
in an .htaccess file, ini_get will return the string, which will "evaluate" to 1. So if you are using mod_php you have to check boolean config values against the strings (upper/lowercase etc.) anyhow or you will get wrong results.

david dot tulloh at infaze dot com dot au (2005-06-21 19:01:37)

You can set custom entries in the ini file to provide globals such as database details.
However these must be retrieved with get_cfg_var, ini_get won't work.

Der Graph (2004-08-16 11:59:05)

It might be useful for included scripts that include other files to extend the 'include_path' variable:

<?php ini_set('include_path',ini_get('include_path').':../includes:');  ?>

Sometimes, it may also be useful to store the current 'include_path' in a variable, overwrite it, include, and then restore the old 'include_path'.

fbeyer at <nospam>clickhand dot de (2002-08-13 07:29:50)

If you want to test ini flags (eg. On/Off), I recommend to explicitly cast the value returned by ini_get() to boolean - it is cleaner as you only get true or false, not 0 or 1 or "" as described above.

<?php
    $register_globals = (bool) ini_get('register_gobals');
?>

C fans may of course also cast it to (int) to play with 0 and 1 - that's also cleaner to print().