wp/wp-includes/random_compat/cast_to_int.php
changeset 7 cf61fcea0001
child 9 177826044cd9
equal deleted inserted replaced
6:490d5cc509ed 7:cf61fcea0001
       
     1 <?php
       
     2 /**
       
     3  * Random_* Compatibility Library
       
     4  * for using the new PHP 7 random_* API in PHP 5 projects
       
     5  *
       
     6  * The MIT License (MIT)
       
     7  *
       
     8  * Copyright (c) 2015 Paragon Initiative Enterprises
       
     9  *
       
    10  * Permission is hereby granted, free of charge, to any person obtaining a copy
       
    11  * of this software and associated documentation files (the "Software"), to deal
       
    12  * in the Software without restriction, including without limitation the rights
       
    13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       
    14  * copies of the Software, and to permit persons to whom the Software is
       
    15  * furnished to do so, subject to the following conditions:
       
    16  *
       
    17  * The above copyright notice and this permission notice shall be included in
       
    18  * all copies or substantial portions of the Software.
       
    19  *
       
    20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
       
    21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
       
    22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
       
    23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
       
    24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
       
    25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
       
    26  * SOFTWARE.
       
    27  */
       
    28 
       
    29 if (!function_exists('RandomCompat_intval')) {
       
    30     
       
    31     /**
       
    32      * Cast to an integer if we can, safely.
       
    33      * 
       
    34      * If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX)
       
    35      * (non-inclusive), it will sanely cast it to an int. If you it's equal to
       
    36      * ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats 
       
    37      * lose precision, so the <= and => operators might accidentally let a float
       
    38      * through.
       
    39      * 
       
    40      * @param int|float $number    The number we want to convert to an int
       
    41      * @param boolean   $fail_open Set to true to not throw an exception
       
    42      * 
       
    43      * @return int (or float if $fail_open)
       
    44      *
       
    45      * @throws TypeError
       
    46      */
       
    47     function RandomCompat_intval($number, $fail_open = false)
       
    48     {
       
    49         if (is_numeric($number)) {
       
    50             $number += 0;
       
    51         }
       
    52 
       
    53         if (
       
    54             is_float($number)
       
    55             &&
       
    56             $number > ~PHP_INT_MAX
       
    57             &&
       
    58             $number < PHP_INT_MAX
       
    59         ) {
       
    60             $number = (int) $number;
       
    61         }
       
    62 
       
    63         if (is_int($number) || $fail_open) {
       
    64             return $number;
       
    65         }
       
    66 
       
    67         throw new TypeError(
       
    68             'Expected an integer.'
       
    69         );
       
    70     }
       
    71 }