3 * Random_* Compatibility Library
4 * for using the new PHP 7 random_* API in PHP 5 projects
6 * The MIT License (MIT)
8 * Copyright (c) 2015 - 2017 Paragon Initiative Enterprises
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 if (!is_callable('RandomCompat_strlen')) {
31 defined('MB_OVERLOAD_STRING') &&
32 ini_get('mbstring.func_overload') & MB_OVERLOAD_STRING
35 * strlen() implementation that isn't brittle to mbstring.func_overload
37 * This version uses mb_strlen() in '8bit' mode to treat strings as raw
38 * binary rather than UTF-8, ISO-8859-1, etc
40 * @param string $binary_string
46 function RandomCompat_strlen($binary_string)
48 if (!is_string($binary_string)) {
50 'RandomCompat_strlen() expects a string'
54 return (int) mb_strlen($binary_string, '8bit');
59 * strlen() implementation that isn't brittle to mbstring.func_overload
61 * This version just used the default strlen()
63 * @param string $binary_string
69 function RandomCompat_strlen($binary_string)
71 if (!is_string($binary_string)) {
73 'RandomCompat_strlen() expects a string'
76 return (int) strlen($binary_string);
81 if (!is_callable('RandomCompat_substr')) {
84 defined('MB_OVERLOAD_STRING')
86 ini_get('mbstring.func_overload') & MB_OVERLOAD_STRING
89 * substr() implementation that isn't brittle to mbstring.func_overload
91 * This version uses mb_substr() in '8bit' mode to treat strings as raw
92 * binary rather than UTF-8, ISO-8859-1, etc
94 * @param string $binary_string
96 * @param int $length (optional)
102 function RandomCompat_substr($binary_string, $start, $length = null)
104 if (!is_string($binary_string)) {
106 'RandomCompat_substr(): First argument should be a string'
110 if (!is_int($start)) {
112 'RandomCompat_substr(): Second argument should be an integer'
116 if ($length === null) {
118 * mb_substr($str, 0, NULL, '8bit') returns an empty string on
119 * PHP 5.3, so we have to find the length ourselves.
121 $length = RandomCompat_strlen($binary_string) - $start;
122 } elseif (!is_int($length)) {
124 'RandomCompat_substr(): Third argument should be an integer, or omitted'
128 // Consistency with PHP's behavior
129 if ($start === RandomCompat_strlen($binary_string) && $length === 0) {
132 if ($start > RandomCompat_strlen($binary_string)) {
136 return (string) mb_substr($binary_string, $start, $length, '8bit');
142 * substr() implementation that isn't brittle to mbstring.func_overload
144 * This version just uses the default substr()
146 * @param string $binary_string
148 * @param int $length (optional)
154 function RandomCompat_substr($binary_string, $start, $length = null)
156 if (!is_string($binary_string)) {
158 'RandomCompat_substr(): First argument should be a string'
162 if (!is_int($start)) {
164 'RandomCompat_substr(): Second argument should be an integer'
168 if ($length !== null) {
169 if (!is_int($length)) {
171 'RandomCompat_substr(): Third argument should be an integer, or omitted'
175 return (string) substr($binary_string, $start, $length);
178 return (string) substr($binary_string, $start);