core-functions.php ➔ valr() - Code Metrics - Inspection of "Merge pull request #3 from vanilla/feature/travis-..." - vanilla/garden - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 6b7717...ad9af1 )

by Alexandre
created 2017-09-13 19:21 UTC
core-functions.php ➔ valr() B

↳ Parent: Project
Complexity

Conditions	7
Paths	8
Size

Total Lines	19
Code Lines	13
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	14
CRAP Score	7
Importance

Changes
Metric	Value
cc	7
eloc	13
nc	8
nop	3
dl	0
loc	19
ccs	14
cts	14
cp	1
crap	7
rs	8.2222
c	0
b	0
f	0
<?php
/**
 * @author Todd Burry <[email protected]>
 * @copyright 2009-2014 Vanilla Forums Inc.
 * @license MIT
 */

/**
 * This file is part of the array_column library
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright Copyright (c) 2013 Ben Ramsey <http://benramsey.com>
 * @license http://opensource.org/licenses/MIT MIT
 */

/**
 * Returns the values from a single column of the input array, identified by the $columnKey.
 *
 * Optionally, you may provide an $indexKey to index the values in the returned
 * array by the values from the $indexKey column in the input array.
 *
 * @param array $array A multi-dimensional array (record set) from which to pull a column of values.
 * @param int|string|null $columnKey The column of values to return.
 * This value may be the integer key of the column you wish to retrieve, or it
 * may be the string key name for an associative array.
 * @param mixed $indexKey The column to use as the index/keys for the returned array.
 * This value may be the integer key of the column, or it may be the string key name.
 * @return array Returns an array of values representing a single column from the input array.
 * @category Array Functions
 */
function array_column_php(array $array, $columnKey = null, $indexKey = null) {
    if (!is_int($columnKey)
        && !is_float($columnKey)
        && !is_string($columnKey)
        && $columnKey !== null
        && !(is_object($columnKey) && method_exists($columnKey, '__toString'))
    ) {
        trigger_error('array_column(): The column key should be either a string or an integer', E_USER_WARNING);
    }

    if (isset($indexKey)
        && !is_int($indexKey)
        && !is_float($indexKey)
        && !is_string($indexKey)
        && !(is_object($indexKey) && method_exists($indexKey, '__toString'))
    ) {
        trigger_error('array_column(): The index key should be either a string or an integer', E_USER_WARNING);
    }

    $paramsColumnKey = ($columnKey !== null) ? (string)$columnKey : null;

    $paramsIndexKey = null;
    if (isset($indexKey)) {
        if (is_float($indexKey) || is_int($indexKey)) {
            $paramsIndexKey = (int)$indexKey;
        } else {
            $paramsIndexKey = (string)$indexKey;
        }
    }

    $resultArray = array();

    foreach ($array as $row) {

        $key = $value = null;
        $keySet = $valueSet = false;

        if ($paramsIndexKey !== null && array_key_exists($paramsIndexKey, $row)) {
            $keySet = true;
            $key = (string)$row[$paramsIndexKey];
        }

        if ($paramsColumnKey === null) {
            $valueSet = true;
            $value = $row;
        } elseif (is_array($row) && array_key_exists($paramsColumnKey, $row)) {
            $valueSet = true;
            $value = $row[$paramsColumnKey];
        }

        if ($valueSet) {
            if ($keySet) {
                $resultArray[$key] = $value;
            } else {
                $resultArray[] = $value;
            }
        }

    }

    return $resultArray;
}

if (!function_exists('array_column')) {
    /**
     * A custom implementation of array_column for older versions of php.
     *
     * @param array $array The dataset to test.
     * @param int|string $columnKey The column of values to return.
     * @param int|string|null $indexKey The column to use as the index/keys for the returned array.
     * @return array Returns the columns from the {@link $input} array.
     */
    function array_column($array, $columnKey, $indexKey = null) {
        return array_column_php($array, $columnKey, $indexKey);
    }
}

/**
 * Converts a quick array into a key/value form.
 *
 * @param array $array The array to work on.
 * @param mixed $default The default value for unspecified keys.
 * @return array Returns the array converted to long syntax.
 */
function array_quick(array $array, $default) {

    $result = [];
    foreach ($array as $key => $value) {
        if (is_int($key)) {
            $result[$value] = $default;
        } else {
            $result[$key] = $value;
        }
    }
    return $result;
}

/**
 * Converts a quick array into a key/value form using a callback to convert the short items.
 *
 * @param array $array The array to work on.
 * @param callable $callback The callback used to generate the default values.
 * @return array Returns the array converted to long syntax.
 */
function array_uquick(array $array, callable $callback) {

    $result = [];
    foreach ($array as $key => $value) {
        if (is_int($key)) {
            $result[$value] = $callback($value);
        } else {
            $result[$key] = $value;
        }
    }
    return $result;
}

/**
 * Load configuration data from a file into an array.
 *
 * @param string $path The path to load the file from.
 * @param string $php_var The name of the php variable to load from if using the php file type.
 * @return array The configuration data.
 * @throws InvalidArgumentException Throws an exception when the file type isn't supported.
 *
 * @category Array Functions
 */
function array_load($path, $php_var = 'config') {
    if (!file_exists($path)) {
        return false;
    }

    // Get the extension of the file, but allow for .ini.php, .json.php etc.
    $ext = strstr(basename($path), '.');

    switch ($ext) {
//            case '.ini':
//            case '.ini.php':
//                $loaded = parse_ini_file($path, false, INI_SCANNER_RAW);
//                break;
        case '.json':
        case '.json.php':
            $loaded = json_decode(file_get_contents($path), true);
            break;
        case '.php':
            include $path;
            $loaded = $$php_var;
            break;
        case '.ser':
        case '.ser.php':
            $loaded = unserialize(file_get_contents($path));
            break;
        case '.yml':
        case '.yml.php':
            $loaded = yaml_parse_file($path);
            break;
        default:
            throw new InvalidArgumentException("Invalid config extension $ext on $path.", 500);
    }
    return $loaded;
}

/**
 * Save an array of data to a specified path.
 *
 * @param array $data The data to save.
 * @param string $path The path to save to.
 * @param string $php_var The name of the php variable to load from if using the php file type.
 * @return bool Returns true if the save was successful or false otherwise.
 * @throws InvalidArgumentException Throws an exception when the file type isn't supported.
 *
 * @category Array Functions
 */
function array_save($data, $path, $php_var = 'config') {
    if (!is_array($data)) {
        throw new \InvalidArgumentException('Config::saveArray(): Argument #1 is not an array.', 500);
    }

    // Get the extension of the file, but allow for .ini.php, .json.php etc.
    $ext = strstr(basename($path), '.');

    switch ($ext) {
//            case '.ini':
//            case '.ini.php':
//                $ini = static::iniEncode($config);
//                $result = file_put_contents_safe($path, $ini);
//                break;
        case '.json':
        case '.json.php':
            if (defined('JSON_PRETTY_PRINT')) {
                $json = json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
            } else {
                $json = json_encode($data);
            }
            $result = file_put_contents_safe($path, $json);
            break;
        case '.php':
            $php = "<?php\n".php_encode($data, $php_var)."\n";
            $result = file_put_contents_safe($path, $php);
            break;
        case '.ser':
        case '.ser.php':
            $ser = serialize($data);
            $result = file_put_contents_safe($path, $ser);
            break;
        case '.yml':
        case '.yml.php':
            $yml = yaml_emit($data, YAML_UTF8_ENCODING, YAML_LN_BREAK);
            $result = file_put_contents_safe($path, $yml);
            break;
        default:
            throw new \InvalidArgumentException("Invalid config extension $ext on $path.", 500);
    }
    return $result;
}

/**
 * Search an array for a value with a user-defined comparison function.
 *
 * @param mixed $needle The value to search for.
 * @param array $haystack The array to search.
 * @param callable $cmp The comparison function to use in the search.
 * @return mixed|false Returns the found value or false if the value is not found.
 */
function array_usearch($needle, array $haystack, callable $cmp) {
    $found = array_uintersect($haystack, [$needle], $cmp);

    if (empty($found)) {
        return false;
    } else {
        return array_pop($found);
    }
}

/**
 * Select the first non-empty value from an array.
 *
 * @param array $keys An array of keys to try.
 * @param array $array The array to select from.
 * @param mixed $default The default value if non of the keys exist.
 * @return mixed Returns the first non-empty value of {@link $default} if none are found.
 * @category Array Functions
 */
function array_select(array $keys, array $array, $default = null) {
    foreach ($keys as $key) {
        if (isset($array[$key]) && $array[$key]) {
            return $array[$key];
        }
    }
    return $default;
}

/**
 * Make sure that a key exists in an array.
 *
 * @param string|int $key The array key to ensure.
 * @param array &$array The array to modify.
 * @param mixed $default The default value to set if key does not exist.
 * @category Array Functions
 */
function array_touch($key, &$array, $default) {
    if (!array_key_exists($key, $array)) {
        $array[$key] = $default;
    }
}

/**
 * Take all of the items in an array and make a new array with them specified by mappings.
 *
 * @param array $array The input array to translate.
 * @param array $mappings The mappings to translate the array.
 * @return array
 *
 * @category Array Functions
 */
function array_translate($array, $mappings) {
    $array = (array)$array;
    $result = array();
    foreach ($mappings as $index => $value) {
        if (is_numeric($index)) {
            $key = $value;
            $newKey = $value;
        } else {
            $key = $index;
            $newKey = $value;
        }
        if (isset($array[$key])) {
            $result[$newKey] = $array[$key];
        } else {
            $result[$newKey] = null;
        }
    }
    return $result;
}

/**
 * Returns the average rating based in the Wilson score interval.
 *
 *
 * @param int $positive The number of positive ratings.
 * @param int $total The total number of ratings.
 * @param float $confidence Your confidence level.
 * @return int
 *
 * @see http://stackoverflow.com/questions/9478741/mysql-php-for-wilson-score-interval-with-time-gravity
 * @see http://evanmiller.org/how-not-to-sort-by-average-rating.html
 */
//function averageRating($positive, $total, $confidence = 0.95) {
//   if ($total == 0)
//      return 0;
//
//   if ($confidence == 0.95)
//      $z = 1.96;
//   else
//      $z = pnormaldist(1 - (1 - $confidence) / 2, 0, 1);
//   $p = 1.0 * $positive / $total;
//   $s = ($p + $z * $z / (2 * $total) - $z * sqrt(($p * (1 - $p) + $z * $z / (4 * $total)) / $total)) / (1 + $z * $z / $total);
//   return $s;
//}

/**
 * Base64 Encode a string, but make it suitable to be passed in a url.
 *
 * @param string $str The string to encode.
 * @return string Returns the encoded string.
 * @category String Functions
 * @see base64_urldecode()
 * @see base64_encode()
 */
function base64url_encode($str) {
    return trim(strtr(base64_encode($str), '+/', '-_'), '=');
}

/**
 * Decode a string that was encoded using {@link base64_urlencode()}.
 *
 * @param string $str The encoded string.
 * @return string The decoded string.
 * @category String Functions
 * @see base64_urldecode()
 * @see base64_decode()
 */
function base64url_decode($str) {
    return base64_decode(strtr($str, '-_', '+/'));
}

/**
 * An alias of {@link config()}.
 *
 * @param string $key The config key.
 * @param string $default The default value if the config setting isn't available.
 * @return string The config value.
 * @see config()
 */
function c($key, $default) {
    return config($key, $default);
}

//function checkRoute($className, $methodName, &$routed) {
//   if ($routed)
//      return false;
//   if (class_exists($className) && method_exists($className, $methodName))
//      return $routed = true;
//   return $routed = false;
//}

/**
 * Get a value from the config.
 *
 * @param string $key The config key.
 * @param mixed $default The default value if the config setting isn't available.
 * @return mixed The config value.
 */
function config($key, $default = null) {
    return Garden\Config::get($key, $default);
}

/**
 * Compare two dates formatted as either timestamps or strings.
 *
 * @param mixed $date1 The first date to compare expressed as an integer timestamp or a string date.
 * @param mixed $date2 The second date to compare expressed as an integer timestamp or a string date.
 * @return int Returns `1` if {@link $date1} > {@link $date2}, `-1` if {@link $date1} > {@link $date2},
 * or `0` if the two dates are equal.
 * @category Date/Time Functions
 */
function datecmp($date1, $date2) {
    if (is_numeric($date1)) {
        $timestamp1 = $date1;
    } else {
        $timestamp1 = strtotime($date1);
    }

    if (is_numeric($date2)) {
        $timestamp2 = $date2;
    } else {
        $timestamp2 = strtotime($date2);
    }

    if ($timestamp1 == $timestamp2) {
        return 0;
    } elseif ($timestamp1 > $timestamp2) {
        return 1;
    } else {
        return -1;
    }
}

/**
 * Mark something as deprecated.
 *
 * When passing the {@link $name} argument, try using the following naming convention for names.
 *
 * - Functions: function_name()
 * - Classes: ClassName
 * - Static methods: ClassName::methodName()
 * - Instance methods: ClassName->methodName()
 *
 * @param string $name The name of the deprecated function.
 * @param string $newname The name of the new function that should be used instead.
 */
function deprecated($name, $newname = '') {
    $msg = $name.' is deprecated.';
    if ($newname) {
        $msg .= " Use $newname instead.";
    }

    trigger_error($msg, E_USER_DEPRECATED);
}

/**
 * A version of file_put_contents() that is multi-thread safe.
 *
 * @param string $filename Path to the file where to write the data.
 * @param mixed $data The data to write. Can be either a string, an array or a stream resource.
 * @param int $mode The permissions to set on a new file.
 * @return boolean
 * @category Filesystem Functions
 * @see http://php.net/file_put_contents
 */
function file_put_contents_safe($filename, $data, $mode = 0644) {
    $temp = tempnam(dirname($filename), 'atomic');

    if (!($fp = @fopen($temp, 'wb'))) {
        $temp = dirname($filename).DIRECTORY_SEPARATOR.uniqid('atomic');
        if (!($fp = @fopen($temp, 'wb'))) {
            trigger_error("file_put_contents_safe() : error writing temporary file '$temp'", E_USER_WARNING);
            return false;
        }
    }

    fwrite($fp, $data);
    fclose($fp);

    if (!@rename($temp, $filename)) {
        @unlink($filename);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        @rename($temp, $filename);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
    }

    @chmod($filename, $mode);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
    return true;
}

/**
 * Force a value into a boolean.
 *
 * @param mixed $value The value to force.
 * @return boolean Returns the boolean value of {@link $value}.
 * @category Type Functions
 */
function force_bool($value) {
    if (is_string($value)) {
        switch (strtolower($value)) {
            case 'disabled':
            case 'false':
            case 'no':
            case 'off':
            case '':
                return false;
        }
        return true;
    }
    return (bool)$value;
}

/**
 * Force a string to look like an ip address (v4).
 *
 * @param string $ip The ip string to look at.
 * @return string|null The ipv4 address or null if {@link $ip} is empty.
 */
function force_ipv4($ip) {
    if (!$ip) {
        return null;
    }

    if (strpos($ip, ',') !== false) {
        $ip = substr($ip, 0, strpos($ip, ','));
    }

    // Make sure we have a valid ip.
    if (preg_match('`(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})`', $ip, $m)) {
        $ip = $m[1];
    } elseif ($ip === '::1') {
        $ip = '127.0.0.1';
    } else {
        $ip = '0.0.0.0'; // unknown ip
    }
    return $ip;
}

/**
 * Force a value to be an integer.
 *
 * @param mixed $value The value to force.
 * @return int Returns the integer value of {@link $value}.
 * @category Type Functions
 */
function force_int($value) {
    if (is_string($value)) {
        switch (strtolower($value)) {
            case 'disabled':
            case 'false':
            case 'no':
            case 'off':
            case '':
                return 0;
            case 'enabled':
            case 'true':
            case 'yes':
            case 'on':
                return 1;
        }
    }
    return intval($value);
}

function garden_error_handler($number, $message, $file, $line, $args) {
    $error_reporting = error_reporting();
    // Ignore errors that are below the current error reporting level.
    if (($error_reporting & $number) != $number) {
        return false;
    }

    $backtrace = debug_backtrace();

    throw new Garden\Exception\ErrorException($message, $number, $file, $line, $args, $backtrace);
}

/**
 * Like {@link implode()}, but joins array keys and values.
 *
 * @param string $elemglue The string that separates each element of the array.
 * @param string $keyglue The string that separates keys and values.
 * @param array $pieces The array of strings to implode.
 * @return string Returns the imploded array as a string.
 *
 * @category Array Functions
 * @category String Functions
 */
function implode_assoc($elemglue, $keyglue, $pieces) {
    $result = '';

    foreach ($pieces as $key => $value) {
        if ($result) {
            $result .= $elemglue;
        }

        $result .= $key.$keyglue.$value;
    }
    return $result;
}

/**
 * Whether or not a string is a url in the form http://, https://, or //.
 *
 * @param string $str The string to check.
 * @return bool
 *
 * @category String Functions
 * @category Internet Functions
 */
function is_url($str) {
    if (!$str) {
        return false;
    }
    if (substr($str, 0, 2) == '//') {
        return true;
    }
    if (strpos($str, '://', 1) !== false) {
        return true;
    }
    return false;
}

/**
 * Strip a substring from the beginning of a string.
 *
 * @param string $mainstr The main string to look at (the haystack).
 * @param string $substr The substring to search trim (the needle).
 * @return string
 *
 * @category String Functions
 */
function ltrim_substr($mainstr, $substr) {
    if (strncasecmp($mainstr, $substr, strlen($substr)) === 0) {
        return substr($mainstr, strlen($substr));
    }
    return $mainstr;
}

/**
 * Get the file extension from a mime-type.
 *
 * @param string $mime The mime type.
 * @param string $ext If this argument is specified then this extension will be added to the list of known types.
 * @return string The file extension without the dot.
 * @category Internet Functions
 * @category String Functions
 */
function mime2ext($mime, $ext = null) {
    static $known = array('text/plain' => '.txt', 'image/jpeg' => '.jpg', 'application/rss+xml' => '.rss');
    $mime = strtolower($mime);

    if ($ext !== null) {
        $known[$mime] = '.'.ltrim($ext, '.');
    }

    if (array_key_exists($mime, $known)) {
        return $known[$mime];
    }

    // We don't know the mime type so we need to just return the second part as the extension.
    $result = trim(strrchr($mime, '/'), '/');

    if (substr($result, 0, 2) === 'x-') {
        $result = substr($result, 2);
    }

    return '.'.$result;
}

/**
 * Encode a php array nicely.
 *
 * @param array $data The data to encode.
 * @param string $php_var The name of the php variable.
 * @return string Returns a string of the encoded data.
 *
 * @category Array Functions
 */
function php_encode($data, $php_var = 'config') {
    if (is_array($data)) {
        $result = '';
        $lastHeading = '';
        foreach ($data as $key => $value) {
            // Figure out the heading.
            if (($pos = strpos($key, '.')) !== false) {
                $heading = str_replace(array("\n", "\r"), ' ', substr($key, 0, $pos));
            } else {
                $heading = substr($key, 0, 1);
            }

            if ($heading !== $lastHeading) {
                if (strlen($heading) === 1) {
                    // Don't emit single letter headings, but space them out.
                    $result .= "\n";
                } else {
                    $result .= "\n// ".$heading."\n";
                }
                $lastHeading = $heading;
            }

            $result .= '$'.$php_var.'['.var_export($key, true).'] = '.var_export($value, true).";\n";
        }
    } else {
        $result = "\$$php_var = ".var_export($data, true).";\n";
    }
    return $result;
}

/**
 * Reflect the arguments on a callback and returns them as an associative array.
 *
 * @param callable $callback A callback to the function.
 * @param array $args An array of arguments.
 * @param array $get An optional other array of arguments.
 * @return array The arguments in an associative array, in order ready to be passed to call_user_func_array().
 * @throws Exception Throws an exception when {@link callback} isn't a valid callback.
 * @category Type Functions
 */
function reflect_args(callable $callback, $args, $get = null) {
    if (is_array($get)) {
        $args = array_merge($get, $args);
    }
    $args = array_change_key_case($args);

    if (is_string($callback) || (is_object($callback) && $callback instanceof Closure)) {
        $meth = new ReflectionFunction($callback);
        $meth_name = $meth;
    } else {
        $meth = new ReflectionMethod($callback[0], $callback[1]);
        if (is_string($callback[0])) {
            $meth_name = $callback[0].'::'.$meth->getName();
        } else {
            $meth_name = get_class($callback[0]).'->'.$meth->getName();
        }
    }

    $meth_params = $meth->getParameters();

    $call_args = array();
    $missing_args = array();

    // Set all of the parameters.
    foreach ($meth_params as $index => $meth_param) {
        $param_name = $meth_param->getName();
        $param_namel = strtolower($param_name);

        if (isset($args[$param_namel])) {
            $param_value = $args[$param_namel];
        } elseif (isset($args[$index])) {
            $param_value = $args[$index];
        } elseif ($meth_param->isDefaultValueAvailable()) {
            $param_value = $meth_param->getDefaultValue();
        } else {
            $param_value = null;
            $missing_args[] = '$'.$param_name;
        }

        $call_args[$param_name] = $param_value;
    }

    // Add optional parameters so that methods that use get_func_args() will still work.
    for ($index = count($call_args); array_key_exists($index, $args); $index++) {
        $call_args[$index] = $args[$index];
    }

    if (count($missing_args) > 0) {
        trigger_error("$meth_name() expects the following parameters: ".implode(', ', $missing_args).'.', E_USER_NOTICE);
    }

    return $call_args;
}

/**
 * Strip a substring rom the end of a string.
 *
 * @param string $mainstr The main string to search (the haystack).
 * @param string $substr The substring to trim (the needle).
 * @return string Returns the trimmed string or {@link $mainstr} if {@link $substr} was not found.
 * @category String Functions
 */
function rtrim_substr($mainstr, $substr) {
    if (strcasecmp(substr($mainstr, -strlen($substr)), $substr) === 0) {
        return substr($mainstr, 0, -strlen($substr));
    }
    return $mainstr;
}

/**
 * Returns whether or not a string begins with another string.
 *
 * This function is not case-sensitive.
 *
 * @param string $haystack The string to test.
 * @param string $needle The substring to test against.
 * @return bool Whether or not `$string` begins with `$with`.
 * @category String Functions
 */
function str_begins($haystack, $needle) {
    return strncasecmp($haystack, $needle, strlen($needle)) === 0;
}

/**
 * Returns whether or not a string ends with another string.
 *
 * This function is not case-sensitive.
 *
 * @param string $haystack The string to test.
 * @param string $needle The substring to test against.
 * @return bool Whether or not `$string` ends with `$with`.
 * @category String Functions
 */
function str_ends($haystack, $needle) {
    return strcasecmp(substr($haystack, -strlen($needle)), $needle) === 0;
}

$translations = [];

/**
 * Translate a string.
 *
 * @param string $code The translation code.
 * @param string $default The default if the translation is not found.
 * @return string The translated string.
 *
 * @category String Functions
 * @category Localization Functions
 */
function t($code, $default = null) {
    global $translations;

    if (substr($code, 0, 1) === '@') {
        return substr($code, 1);
    } elseif (isset($translations[$code])) {
        return $translations[$code];
    } elseif ($default !== null) {
        return $default;
    } else {
        return $code;
    }
}

/**
 * A version of {@link sprintf()} That translates the string format.
 *
 * @param string $formatCode The format translation code.
 * @param mixed $arg1 The arguments to pass to {@link sprintf()}.
 * @return string The translated string.
 */
function sprintft($formatCode, $arg1 = null) {
    $args = func_get_args();
    $args[0] = t($formatCode);
    return call_user_func_array('sprintf', $args);
}

/**
 * Make sure that a directory exists.
 *
 * @param string $dir The name of the directory.
 * @param int $mode The file permissions on the folder if it's created.
 * @throws Exception Throws an exception when {@link $dir} is a file.
 * @category Filesystem Functions
 */
function touchdir($dir, $mode = 0777) {
    if (!file_exists($dir)) {
        mkdir($dir, $mode, true);
    } elseif (!is_dir($dir)) {
        throw new Exception("The specified directory already exists as a file. ($dir)", 400);
    }
}

/**
 * Safely get a value out of an array.
 *
 * This function will always return a value even if the array key doesn't exist.
 * The val() function is one of the biggest workhorses of Vanilla and shows up a lot throughout other code.
 * It's much preferable to use this function if your not sure whether or not an array key exists rather than
 * using @ error suppression.
 *
 * This function uses optimizations found in the [facebook libphputil library](https://github.com/facebook/libphutil).
 *
 * @param string|int $key The array key.
 * @param array|object $array The array to get the value from.
 * @param mixed $default The default value to return if the key doesn't exist.
 * @return mixed The item from the array or `$default` if the array key doesn't exist.
 * @category Array Functions
 */
function val($key, $array, $default = null) {
    if (is_array($array)) {
        // isset() is a micro-optimization - it is fast but fails for null values.
        if (isset($array[$key])) {
            return $array[$key];
        }

        // Comparing $default is also a micro-optimization.
        if ($default === null || array_key_exists($key, $array)) {
            return null;
        }
    } elseif (is_object($array)) {
        if (isset($array->$key)) {
            return $array->$key;
        }

        if ($default === null || property_exists($array, $key)) {
            return null;
        }
    }

    return $default;
}

/**
 * Return the value from an associative array.
 *
 * This function differs from val() in that $key can be an array that will be used to walk a nested array.
 *
 * @param array|string $keys The keys or property names of the value. This can be an array or dot-seperated string.
 * @param array|object $array The array or object to search.
 * @param mixed $default The value to return if the key does not exist.
 * @return mixed The value from the array or object.
 * @category Array Functions
 */
function valr($keys, $array, $default = null) {
    if (is_string($keys)) {
        $keys = explode('.', $keys);
    }

    $value = $array;
    for ($i = 0; $i < count($keys); ++$i) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
        $SubKey = $keys[$i];

        if (is_array($value) && isset($value[$SubKey])) {
            $value = $value[$SubKey];
        } elseif (is_object($value) && isset($value->$SubKey)) {
            $value = $value->$SubKey;
        } else {
            return $default;
        }
    }
    return $value;
}

vanilla / garden

Push — master ( 6b7717...ad9af1 )

core-functions.php ➔ valr() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
