StringHelper::substring() - Code Metrics - Inspection of "Bump friendsofphp/php-cs-fixer from 2.19.0 to 3.0...." - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 173977...fbfa54 )

by Michiel

created 2021-05-18 07:08 UTC

StringHelper::substring() B

↳ Parent: StringHelper

Complexity

Conditions	7
Paths	16

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	7

Importance

Changes

Metric	Value
eloc	10
c	0
b	0
f	0
dl	0
loc	17
ccs	11
cts	11
cp	1
rs	8.8333
cc	7
nc	16
nop	3
crap	7

<?php

/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

namespace Phing\Util;

use function filter_var;
use function is_bool;
use function is_string;
use function preg_match;
use function strlen;
use function strpos;
use function strrev;
use function trigger_error;
use function trim;

use const FILTER_NULL_ON_FAILURE;
use const FILTER_VALIDATE_BOOLEAN;

/**
 * String helper utility class.
 *
 * This class includes some Java-like functions for parsing strings,
 * as well as some functions for getting qualifiers / unqualifying phing-style
 * classpaths.  (e.g. "phing.util.StringHelper").
 *
 * @author Hans Lellelid <[email protected]>
 */
class StringHelper
{
    /**
     * Converts a string to a boolean according to Phing rules.
     *
     * This method has no type hints to avoid "type coercion".
     *
     * The following values are considered "true":
     *
     * - 'on' (string)
     * - 'true' (string)
     * - 'yes' (string)
     * - '1' (string)
     * - 1 (int)
     * - 1.0 (float)
     * - true (boolean)
     *
     * Everything else is "false". Also, string values are trimmed and case-insensitive.
     *
     * @param mixed $s Value to be converted
     *
     * @return bool
     */
    public static function booleanValue($s)
    {
        return filter_var($s, FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * tests if a string is a representative of a boolean.
     *
     * This method has no type hints to avoid "type coercion".
     *
     * Rules:
     *
     * - Valid boolean values: true, false, 'true', 'false', 'on', 'off', 'yes', 'no', '1' and '0'.
     * - Anything else must not be considered boolean.
     * - This method is case-insensitive.
     * - Strings are trimmed.
     *
     * @param mixed $s The value to convert to a bool value
     *
     * @return bool
     */
    public static function isBoolean($s)
    {
        if (is_bool($s)) {
            return true; // it already is boolean
        }

        if (!is_string($s) || '' === trim($s)) {
            return false; // not a valid string for testing
        }

        return null !== filter_var($s, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
    }

    /**
     * tests if a string starts with a given string.
     *
     * @param string $check
     * @param string $string
     *
     * @return bool
     */
    public static function startsWith($check, $string)
    {
        if ('' === $check || $check === $string) {
            return true;
        }

        return 0 === strpos((string) $string, $check);
    }

    /**
     * tests if a string ends with a given string.
     *
     * @param string $check
     * @param string $string
     *
     * @return bool
     */
    public static function endsWith($check, $string)
    {
        if ('' === $check || $check === $string) {
            return true;
        }

        return 0 === strpos(strrev($string), strrev($check));
    }

    /**
     * a natural way of getting a subtring, php's circular string buffer and strange
     * return values suck if you want to program strict as of C or friends.
     *
     * @param string $string
     * @param int    $startpos
     * @param int    $endpos
     *
     * @return string
     */
    public static function substring($string, $startpos, $endpos = -1)
    {
        $len = strlen($string);
        $endpos = (int) ((-1 === $endpos) ? $len - 1 : $endpos);
        if ($startpos > $len - 1 || $startpos < 0) {
            trigger_error("substring(), Startindex out of bounds must be 0<n<{$len}", E_USER_ERROR);
        }
        if ($endpos > $len - 1 || $endpos < $startpos) {
            trigger_error("substring(), Endindex out of bounds must be {$startpos}<n<" . ($len - 1), E_USER_ERROR);
        }
        if ($startpos === $endpos) {
            return (string) $string[$startpos];
        }

        $len = $endpos - $startpos;

        return substr((string) $string, $startpos, $len + 1);
    }

    /**
     * Does the value correspond to a slot variable?
     *
     * @param string $value
     *
     * @return bool|int
     */
    public static function isSlotVar($value)
    {
        $value = trim($value);
        if ('' === $value) {
            return false;
        }

        return preg_match('/^%\{([\w\.\-]+)\}$/', $value);
    }

    /**
     * Extracts the variable name for a slot var in the format %{task.current_file}.
     *
     * @param string $var the var from build file
     *
     * @return string extracted name part
     */
    public static function slotVar($var)
    {
        return trim($var, '%{} ');
    }
}


1		<?php
2
3		/**
4		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15		*
16		* This software consists of voluntary contributions made by many individuals
17		* and is licensed under the LGPL. For more information please see
18		* <http://phing.info>.
19		*/
20
21		namespace Phing\Util;
22
23		use function filter_var;
24		use function is_bool;
25		use function is_string;
26		use function preg_match;
27		use function strlen;
28		use function strpos;
29		use function strrev;
30		use function trigger_error;
31		use function trim;
32
33		use const FILTER_NULL_ON_FAILURE;
34		use const FILTER_VALIDATE_BOOLEAN;
35
36		/**
37		* String helper utility class.
38		*
39		* This class includes some Java-like functions for parsing strings,
40		* as well as some functions for getting qualifiers / unqualifying phing-style
41		* classpaths. (e.g. "phing.util.StringHelper").
42		*
43		* @author Hans Lellelid <[email protected]>
44		*/
45		class StringHelper
46		{
47		/**
48		* Converts a string to a boolean according to Phing rules.
49		*
50		* This method has no type hints to avoid "type coercion".
51		*
52		* The following values are considered "true":
53		*
54		* - 'on' (string)
55		* - 'true' (string)
56		* - 'yes' (string)
57		* - '1' (string)
58		* - 1 (int)
59		* - 1.0 (float)
60		* - true (boolean)
61		*
62		* Everything else is "false". Also, string values are trimmed and case-insensitive.
63		*
64		* @param mixed $s Value to be converted
65		*
66		* @return bool
67		*/
68	912	public static function booleanValue($s)
69		{
70	912	return filter_var($s, FILTER_VALIDATE_BOOLEAN);
71		}
72
73		/**
74		* tests if a string is a representative of a boolean.
75		*
76		* This method has no type hints to avoid "type coercion".
77		*
78		* Rules:
79		*
80		* - Valid boolean values: true, false, 'true', 'false', 'on', 'off', 'yes', 'no', '1' and '0'.
81		* - Anything else must not be considered boolean.
82		* - This method is case-insensitive.
83		* - Strings are trimmed.
84		*
85		* @param mixed $s The value to convert to a bool value
86		*
87		* @return bool
88		*/
89	708	public static function isBoolean($s)
90		{
91	708	if (is_bool($s)) {
92	2	return true; // it already is boolean
93		}
94
95	706	if (!is_string($s) \|\| '' === trim($s)) {
96	37	return false; // not a valid string for testing
97		}
98
99	689	return null !== filter_var($s, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
100		}
101
102		/**
103		* tests if a string starts with a given string.
104		*
105		* @param string $check
106		* @param string $string
107		*
108		* @return bool
109		*/
110	896	public static function startsWith($check, $string)
111		{
112	896	if ('' === $check \|\| $check === $string) {
113	13	return true;
114		}
115
116	889	return 0 === strpos((string) $string, $check);
117		}
118
119		/**
120		* tests if a string ends with a given string.
121		*
122		* @param string $check
123		* @param string $string
124		*
125		* @return bool
126		*/
127	139	public static function endsWith($check, $string)
128		{
129	139	if ('' === $check \|\| $check === $string) {
130	8	return true;
131		}
132
133	133	return 0 === strpos(strrev($string), strrev($check));
134		}
135
136		/**
137		* a natural way of getting a subtring, php's circular string buffer and strange
138		* return values suck if you want to program strict as of C or friends.
139		*
140		* @param string $string
141		* @param int $startpos
142		* @param int $endpos
143		*
144		* @return string
145		*/
146	50	public static function substring($string, $startpos, $endpos = -1)
147		{
148	50	$len = strlen($string);
149	50	$endpos = (int) ((-1 === $endpos) ? $len - 1 : $endpos);
150	50	if ($startpos > $len - 1 \|\| $startpos < 0) {
151	3	trigger_error("substring(), Startindex out of bounds must be 0<n<{$len}", E_USER_ERROR);
152		}
153	47	if ($endpos > $len - 1 \|\| $endpos < $startpos) {
154	2	trigger_error("substring(), Endindex out of bounds must be {$startpos}<n<" . ($len - 1), E_USER_ERROR);
155		}
156	45	if ($startpos === $endpos) {
157	5	return (string) $string[$startpos];
158		}
159
160	41	$len = $endpos - $startpos;
161
162	41	return substr((string) $string, $startpos, $len + 1);
163		}
164
165		/**
166		* Does the value correspond to a slot variable?
167		*
168		* @param string $value
169		*
170		* @return bool\|int
171		*/
172	724	public static function isSlotVar($value)
173		{
174	724	$value = trim($value);
175	724	if ('' === $value) {
176	31	return false;
177		}
178
179	721	return preg_match('/^%\{([\w\.\-]+)\}$/', $value);
180		}
181
182		/**
183		* Extracts the variable name for a slot var in the format %{task.current_file}.
184		*
185		* @param string $var the var from build file
186		*
187		* @return string extracted name part
188		*/
189	7	public static function slotVar($var)
190		{
191	7	return trim($var, '%{} ');
192		}
193		}
194

phingofficial / phing

Push — main ( 173977...fbfa54 )

StringHelper::substring() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like