0) { $percent = $startingPercent + (($endingPercent - $startingPercent) * ($currentTaskCount / (float) $totalTaskCount)); } else { $percent = $startingPercent; } return min(max($startingPercent, $percent), $endingPercent); } /** * Compare two versions like version_compare but the ability to enter the number of levels to compare. * For example, if the level is 2 between 4.1.1 and 4.1.2.1, 4.1 is compared with 4.1 and so they are equal. * * @param string $version1 version one * @param string $version2 version two * @param string $operator operetor type * @param int $vLevel version level 0 is all levels * * @return int|bool */ public static function versionCompare($version1, $version2, $operator = null, $vLevel = 0) { if ($vLevel > 0) { $tV1 = array_slice(preg_split("/[.-]/", $version1), 0, $vLevel); $version1 = implode('.', $tV1); $tV2 = array_slice(preg_split("/[.-]/", $version2), 0, $vLevel); $version2 = implode('.', $tV2); } return version_compare($version1, $version2, $operator); } /** * Return version with level * * @param string $version version * @param int $vLevel version level 0 is all levels * * @return string */ public static function getVersion($version, $vLevel = 0) { if ($vLevel > 0) { $tV1 = array_slice(preg_split("/[.-]/", $version), 0, $vLevel); $version = implode('.', $tV1); } return $version; } /** * Return true if is PHP7+ * * @return bool */ public static function isPHP7Plus() { static $isPHP7Plus = null; if (is_null($isPHP7Plus)) { $isPHP7Plus = version_compare(PHP_VERSION, '7.0.0', '>='); } return $isPHP7Plus; } /** * Groups an array into arrays by a given key, or set of keys, shared between all array members. * * Based on {@author Jake Zatecky}'s {@link https://github.com/jakezatecky/array_group_by array_group_by()} function. * This variant allows $key to be closures. * * @param mixed[] $array The array to have grouping performed on. * @param mixed $key The key to group or split by. Can be a _string_, an _integer_, a _float_, or a _callable_. * - If the key is a callback, it must return a valid key from the array. - If the key is * _NULL_, the iterated element is skipped. - string|int callback ( mixed $item ) * * @return mixed[]|null Returns a multidimensional array or `null` if `$key` is invalid. */ public static function arrayGroupBy(array $array, $key) { if (!is_string($key) && !is_int($key) && !is_float($key) && !is_callable($key)) { trigger_error('array_group_by(): The key should be a string, an integer, or a callback', E_USER_ERROR); } $func = (!is_string($key) && is_callable($key) ? $key : null); $_key = $key; // Load the new array, splitting by the target key $grouped = array(); foreach ($array as $value) { $key = null; if (is_callable($func)) { $key = call_user_func($func, $value); } elseif (is_object($value) && isset($value->{$_key})) { $key = $value->{$_key}; } elseif (isset($value[$_key])) { $key = $value[$_key]; } if ($key === null) { continue; } $grouped[$key][] = $value; } // Recursively build a nested grouping if more parameters are supplied // Each grouped array value is grouped according to the next sequential key if (func_num_args() > 2) { $args = func_get_args(); foreach ($grouped as $key => $value) { $params = array_merge(array($value), array_slice($args, 2, func_num_args())); $grouped[$key] = call_user_func_array(array(__CLASS__, 'arrayGroupBy'), $params); } } return $grouped; } /** * Converts human readable types (10GB) to bytes * * @param string $from A human readable byte size such as 100MB * * @return int<-1, max> Returns and integer of the byte size, -1 if isn't well formatted */ public static function convertToBytes($from) { if (is_numeric($from)) { return (int) $from; } $number = (int) substr($from, 0, -2); switch (strtoupper(substr($from, -2))) { case "KB": return $number * 1024; case "MB": return $number * pow(1024, 2); case "GB": return $number * pow(1024, 3); case "TB": return $number * pow(1024, 4); case "PB": return $number * pow(1024, 5); } $number = (int) substr($from, 0, -1); switch (strtoupper(substr($from, -1))) { case "K": return $number * 1024; case "M": return $number * pow(1024, 2); case "G": return $number * pow(1024, 3); case "T": return $number * pow(1024, 4); case "P": return $number * pow(1024, 5); } return -1; } /** * Sanitize input for XSS code * * @param string $input The value to sanitize * * @return string Returns the input value cleaned up. */ public static function sanitize($input) { return htmlspecialchars(self::sanitizeNSChars($input)); } /** * Remove all non stamp chars from string * * @param string $string input string * * @return string */ public static function sanitizeNSChars($string) { return preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F]/u', '', (string) $string); } /** * remove all non stamp chars from string and newline * trim string * * @param string $string input string * * @return string */ public static function sanitizeNSCharsNewline($string) { return preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\r\n]/u', '', (string) $string); } /** * Remove all non stamp chars, newline, spaces and tabulation from string * * @param string $string input string * * @return string */ public static function sanitizeNSCharsNewlineTabs($string) { return preg_replace('/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F\r\n\s]/u', '', (string) $string); } /** * remove all non stamp chars from string and newline * trim string * * @param string $string input string * * @return string */ public static function sanitizeNSCharsNewlineTrim($string) { return trim(self::sanitizeNSCharsNewline($string)); } /** * Determines whether a PHP ini value is changeable at runtime. * * @since 4.6.0 * * @staticvar array $ini_all * * @link https://secure.php.net/manual/en/function.ini-get-all.php * * @param string $setting The name of the ini setting to check. * * @return bool True if the value is changeable at runtime. False otherwise. */ public static function isIniValChangeable($setting) { // if ini_set is disabled can change the values if (!function_exists('ini_set')) { return false; } static $ini_all; if (!isset($ini_all)) { $ini_all = false; // Sometimes `ini_get_all()` is disabled via the `disable_functions` option for "security purposes". if (function_exists('ini_get_all')) { $ini_all = ini_get_all(); } } // Bit operator to workaround https://bugs.php.net/bug.php?id=44936 which changes access level to 63 in PHP 5.2.6 - 5.2.17. if (isset($ini_all[$setting]['access']) && ( INI_ALL === ( $ini_all[$setting]['access'] & 7 ) || INI_USER === ( $ini_all[$setting]['access'] & 7 ) )) { return true; } // If we were unable to retrieve the details, fail gracefully to assume it's changeable. if (!is_array($ini_all)) { return true; } return false; } /** * get php.ini value * * @param string $key php ini value * @param mixed $default default valu if init_get is disabled or key don't exists * @param string $returnType the return type, accept only scalar values (bool, int, float, string) * * @return mixed */ public static function phpIniGet($key, $default, $returnType = 'string') { if (!function_exists('ini_get')) { return $default; } if (($result = ini_get($key)) === false) { return $default; } switch ($returnType) { case "bool": return filter_var($result, FILTER_VALIDATE_BOOLEAN); case "int": return (int) $result; case "float": return (float) $result; case "string": return (string) $result; default: throw new Exception('Invalid return type ' . $returnType); } } /** * The val value returns if it is between min and max otherwise it returns min or max * * @param int|float $val input value * @param int|float $min min value * @param int|float $max max value * * @return int */ public static function getIntBetween($val, $min, $max) { return min((int) $max, max((int) $min, (int) $val)); } /** * Gets a specific external variable by name and optionally filters it by request * * @param string $variable_name
Name of a variable to get.
* @param int $filterThe ID of the filter to apply. The Types of filters manual page lists the available filters.
*If omitted, FILTER_DEFAULT
will be used, which is equivalent to
* FILTER_UNSAFE_RAW
. This will result in no filtering taking place by
* default.
Associative array of options or bitwise disjunction of flags. * If filter accepts options, flags can be provided in "flags" field of array.
* * @return mixed Value of the requested variable on success * * @link http://php.net/manual/en/function.filter-input.php * @see filter_var(), filter_input_array(), filter_var_array() */ public static function filterInputRequest($variable_name, $filter = FILTER_DEFAULT, $options = 0) { if (isset($_GET[$variable_name]) && !isset($_POST[$variable_name])) { return filter_input(INPUT_GET, $variable_name, $filter, $options); } return filter_input(INPUT_POST, $variable_name, $filter, $options); } /** * Return input from type * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV, self::INPUT_REQUEST * * @return mixed[] */ public static function getInputFromType($type) { switch ($type) { case INPUT_GET: return $_GET; case INPUT_POST: return $_POST; case INPUT_COOKIE: return $_COOKIE; case INPUT_SERVER: return $_SERVER; case INPUT_ENV: return $_ENV; case self::INPUT_REQUEST: return array_merge($_GET, $_POST); default: throw new Exception('Invalid type ' . $type); } } /** * Default filter sanitize string, apply sanitizeNSChars function. * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV. * @param string $var_name Name of a variable to get. * @param mixed $default default value if dont exists * * @return string */ public static function filterInputDefaultSanitizeString($type, $var_name, $default = '') { $filter = FILTER_UNSAFE_RAW; $options = array( 'options' => array( 'default' => null) ); if ($type == self::INPUT_REQUEST) { $result = self::filterInputRequest($var_name, $filter, $options); } else { $result = filter_input($type, $var_name, $filter, $options); } if (is_null($result)) { return $default; } return self::sanitizeNSChars($result); } /** * All characters that are not explicitly accepted are removed. * By default, only alphanumeric characters are accepted. * * @param mixed $input input value * @param string $extraAcceptChars extra accepted chars * * @return string|string[] */ public static function sanitizeStrict($input, $extraAcceptChars = '') { $regex = '/[^a-zA-Z0-9' . preg_quote($extraAcceptChars, '/') . ' ]/m'; if (is_scalar($input) || is_null($input)) { $input = (string) $input; } elseif (is_array($input)) { } elseif (is_object($input)) { $input = (array) $input; } else { $input = ''; } if (is_array($input)) { foreach ($input as $key => $val) { $input[$key] = self::sanitizeStrict($val, $extraAcceptChars); } return $input; } $result = preg_replace($regex, '', $input); return (is_null($result) ? '' : $result); } /** * Sanitize value to int * * @param mixed $input Input value * @param int $default Default value if input isnt valid * * @return int */ public static function sanitizeInt($input, $default = 0) { if (!is_scalar($input)) { return $default; } elseif (is_bool($input)) { return (int) $input; } else { return filter_var($input, FILTER_VALIDATE_INT, array('options' => array( 'default' => $default))); } } /** * Sanitize value to bool * * @param mixed $input Input value * * @return bool */ public static function sanitizeBool($input) { if (!is_scalar($input)) { return false; } elseif (is_bool($input)) { return $input; } else { return filter_var($input, FILTER_VALIDATE_BOOLEAN); } } /** * Sanitize value from input $_GET, $_POST, $_REQUEST ... * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, INPUT_ENV or SnapUtil::INPUT_REQUEST * @param string $varName Name of a variable to get. * @param mixed $default default value if var $varName don't exists * @param string $extraAcceptChars extra accepted chars * * @return string|string[]|mixed return default value if varName isn't defined */ public static function sanitizeStrictInput($type, $varName, $default = false, $extraAcceptChars = '') { if (($value = self::getValueByType($type, $varName)) === null) { return $default; } return self::sanitizeStrict($value, $extraAcceptChars); } /** * Sanitize value from input $_GET, $_POST, $_REQUEST ... * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, INPUT_ENV or SnapUtil::INPUT_REQUEST * @param string $varName Name of a variable to get. * @param int $default default value if var $varName don't exists * * @return int return default value if varName isn't defined */ public static function sanitizeIntInput($type, $varName, $default = 0) { if (($value = self::getValueByType($type, $varName)) === null) { return $default; } return self::sanitizeInt($value); } /** * Sanitize value from input $_GET, $_POST, $_REQUEST ... * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, INPUT_ENV or SnapUtil::INPUT_REQUEST * @param string $varName Name of a variable to get. * @param null|bool $default default value if var $varName don't exists * * @return bool return default value if varName isn't defined */ public static function sanitizeBoolInput($type, $varName, $default = false) { if (($value = self::getValueByType($type, $varName)) === null) { return $default; } return self::sanitizeBool($value); } /** * Sanitize value from input $_GET, $_POST, $_REQUEST ... * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, INPUT_ENV or SnapUtil::INPUT_REQUEST * @param string $varName Name of a variable to get. * @param mixed $default default value if var $varName don't exists * * @return string|string[]|mixed return default value if varName isn't defined */ public static function sanitizeInput($type, $varName, $default = false) { if (($value = self::getValueByType($type, $varName)) === null) { return $default; } return self::sanitize($value); } /** * Return value input by type null if don't exists * * @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, INPUT_ENV or SnapUtil::INPUT_REQUEST * @param string $varName Name of a variable to get. * * @return string|string[]|null */ protected static function getValueByType($type, $varName) { $doNothingCallback = function ($v) { return $v; }; if ($type === self::INPUT_REQUEST) { $type = ((isset($_GET[$varName]) && !isset($_POST[$varName])) ? INPUT_GET : INPUT_POST); } $value = filter_input($type, $varName, FILTER_CALLBACK, array('options' => $doNothingCallback)); /** @var string|string[]|null $value */ return $value; } /** * Gets external variables and optionally filters them *This function is useful for retrieving many values without repetitively calling filter_input()
.
An array defining the arguments.
* A valid key is a string
containing a variable name and a valid value is either a filter type,
* or an array
optionally specifying the filter, flags and options.
* If the value is an array, valid keys are filter which specifies the filter type,
* flags which specifies any flags that apply to the filter, and options
* which specifies any options that apply to the filter. See the example below for a better understanding.
This parameter can be also an integer holding a filter constant. * Then all values in the input array are filtered by this filter.
* @param bool $add_emptyAdd missing keys as NULL
to the return value.