<?php
/**
 * Global helper functions
 *
 * @copyright (c) 2018, Fairbanks Publishing
 * @license Proprietary
 */

if(!function_exists('array_combine_safe')) {
    /**
     * Same affect as array_combine but does not error if the two arrays are different lengths
     *
     * @param array $keys
     * @param array $values
     * @param null $default
     *
     * @return array
     */
    function array_combine_safe(array $keys = [], array $values = [], $default = null)
    {
        if(empty($keys)) {
            return [];
        }

        $out = [];

        foreach($keys as $index => $key) {
            $out[$key] = (isset($values[$index])) ? $values[$index] : $default;
        }

        return $out;
    }
}

if(!function_exists('array_limit_keys')) {
    /**
     * Filter input array to only have the keys provided
     *
     * Only ensures first level of supplied array
     *
     * @param array $keys
     * @param array $input
     *
     * @return array
     */
    function array_limit_keys(array $keys = [], array $input = [])
    {
        if(empty($keys)) {
            return [];
        }

        //return array_filter($input, function($item) use ($keys) {
        //    return in_array($item, $keys);
        //}, ARRAY_FILTER_USE_KEY);

        $out = [];
        foreach($keys as $key) {
            if(array_key_exists($key, $input)) {
                $out[$key] = $input[$key];
            }
        }

        return $out;
    }
}

if(!function_exists('boolean')) {
    /**
     * Convert value to boolean
     *
     * Extends boolval() to look at more words as being TRUE.
     * Strings and numbers default to FALSE.
     * Notable differences from boolval() docs:
     *  +----------+-----------+-----------+
     *  | val      | boolval() | boolean() |
     *  +----------+-----------+-----------+
     *  | 0        | false     | false     |
     *  | 42       | true      | false     |
     *  | 0        | false     | false     |
     *  | 4.2      | true      | false     |
     *  | 1        | true      | true      |
     *  | NULL     | false     | false     |
     *  | ""       | false     | false     |
     *  | "string" | true      | false     |
     *  | "0"      | false     | false     |
     *  | "1"      | true      | true      |
     *  | "yes"    | true      | true      |
     *  | "no"     | true      | false     |
     *  | "y"      | true      | true      |
     *  | "n"      | true      | false     |
     *  | "true"   | true      | true      |
     *  | "false"  | true      | false     |
     *  | [1,2]    | true      | true      |
     *  | []       | false     | false     |
     *  | stdClass | true      | true      |
     *  +----------+-----------+-----------+
     *
     * @param boolean|int|string|null $var
     *
     * @return boolean
     */
    function boolean($var)
    {
        if(is_bool($var)) {
            return ($var == true);
        }

        if(is_string($var)) {
            $var = strtolower($var);

            switch($var) {
                case 'true' :
                case 'on' :
                case 'yes' :
                case 'y' :
                case '1' :
                    return true;
                default :
                    return false;
            }
        }

        if(is_numeric($var)) {
            return ($var == 1);
        }

        return boolval($var);
    }
}

if(!function_exists('config')) {
    /**
     * @param string $key
     * @param scalar $default
     * @return scalar
     */
    function config($key, $default = null)
    {
        if(array_key_exists($key, $_ENV)) {
            return $_ENV[$key];
        } else {
            return $default;
        }
    }
}

if(!function_exists('app_echo')) {
    /**
     * @param string $message
     * @param array $context
     */
    function app_echo($message, $context = [])
    {
        if(is_array($context) && !empty($context)) {
            $message .= ' ' . json_encode($context);
        }

        echo trim($message) . "\n";
    }
}