wp_tinycolor_bound01 - Documentation

WordPress Version: 6.3

/**
 * Takes input from [0, n] and returns it as [0, 1].
 *
 * Direct port of TinyColor's function, lightly simplified to maintain
 * consistency with TinyColor.
 *
 * @link https://github.com/bgrins/TinyColor
 *
 * @since 5.8.0
 * @deprecated 6.3.0
 *
 * @access private
 *
 * @param mixed $n   Number of unknown type.
 * @param int   $max Upper value of the range to bound to.
 * @return float Value in the range [0, 1].
 */
function wp_tinycolor_bound01($n, $max)
{
    _deprecated_function(__FUNCTION__, '6.3.0');
    if ('string' === gettype($n) && str_contains($n, '.') && 1 === (float) $n) {
        $n = '100%';
    }
    $n = min($max, max(0, (float) $n));
    // Automatically convert percentage into number.
    if ('string' === gettype($n) && str_contains($n, '%')) {
        $n = (int) ($n * $max) / 100;
    }
    // Handle floating point rounding errors.
    if (abs($n - $max) < 1.0E-6) {
        return 1.0;
    }
    // Convert into [0, 1] range if it isn't already.
    return $n % $max / (float) $max;
}

WordPress Version: 5.9

/**
 * Duotone block support flag.
 *
 * Parts of this source were derived and modified from TinyColor,
 * released under the MIT license.
 *
 * https://github.com/bgrins/TinyColor
 *
 * Copyright (c), Brian Grinstead, http://briangrinstead.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * @package WordPress
 * @since 5.8.0
 */
/**
 * Takes input from [0, n] and returns it as [0, 1].
 *
 * Direct port of TinyColor's function, lightly simplified to maintain
 * consistency with TinyColor.
 *
 * @see https://github.com/bgrins/TinyColor
 *
 * @since 5.8.0
 * @access private
 *
 * @param mixed $n   Number of unknown type.
 * @param int   $max Upper value of the range to bound to.
 * @return float Value in the range [0, 1].
 */
function wp_tinycolor_bound01($n, $max)
{
    if ('string' === gettype($n) && false !== strpos($n, '.') && 1 === (float) $n) {
        $n = '100%';
    }
    $n = min($max, max(0, (float) $n));
    // Automatically convert percentage into number.
    if ('string' === gettype($n) && false !== strpos($n, '%')) {
        $n = (int) ($n * $max) / 100;
    }
    // Handle floating point rounding errors.
    if (abs($n - $max) < 1.0E-6) {
        return 1.0;
    }
    // Convert into [0, 1] range if it isn't already.
    return $n % $max / (float) $max;
}

WordPress Version: 5.8

/**
 * Duotone block support flag.
 *
 * Parts of this source were derived and modified from TinyColor,
 * released under the MIT license.
 *
 * https://github.com/bgrins/TinyColor
 *
 * Copyright (c), Brian Grinstead, http://briangrinstead.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * @package WordPress
 * @since 5.8.0
 */
/**
 * Takes input from [0, n] and returns it as [0, 1].
 *
 * Direct port of TinyColor's function, lightly simplified to maintain
 * consistency with TinyColor.
 *
 * @see https://github.com/bgrins/TinyColor
 *
 * @since 5.8.0
 * @access private
 *
 * @param mixed $n   Number of unknown type.
 * @param int   $max Upper value of the range to bound to.
 *
 * @return float Value in the range [0, 1].
 */
function wp_tinycolor_bound01($n, $max)
{
    if ('string' === gettype($n) && false !== strpos($n, '.') && 1 === (float) $n) {
        $n = '100%';
    }
    $n = min($max, max(0, (float) $n));
    // Automatically convert percentage into number.
    if ('string' === gettype($n) && false !== strpos($n, '%')) {
        $n = (int) ($n * $max) / 100;
    }
    // Handle floating point rounding errors.
    if (abs($n - $max) < 1.0E-6) {
        return 1.0;
    }
    // Convert into [0, 1] range if it isn't already.
    return $n % $max / (float) $max;
}