StringUtils::englishOrd() - Code Metrics - Inspection of "fix error and clean up code using PhpStorm inspect..." - ondrej-bouda/ivory - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0c19f1...8279ff )

by Ondřej

created 2017-12-29 14:26 UTC

StringUtils::englishOrd() A

↳ Parent: StringUtils

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	10
nc	4
nop	1
dl	0
loc	13
rs	9.2
c	0
b	0
f	0

<?php
declare(strict_types=1);
namespace Ivory\Utils;

class StringUtils
{
    /**
     * Like {@link preg_replace_callback()}, it performs a string search and replace. The callback does not receive
     * plain array of matches, but an extended array: each item is a pair of the matching portion of the needle and the
     * byte offset to the subject, like {@link preg_match_all()} does with the `PREG_OFFSET_CAPTURE` flag.
     *
     * @param string $pattern
     * @param callable $callback
     * @param string|string[] $subject
     * @param int $limit
     * @param int|null $count
     * @return string|string[] depending on whether <tt>$subject</tt> is <tt>string</tt> or <tt>array</tt>,

     *                           a <tt>string</tt> or <tt>array</tt> is returned
     */
    public static function pregReplaceCallbackWithOffset(
        string $pattern,
        callable $callback,
        $subject,
        int $limit = -1,
        int &$count = null
    )
    {
        if (is_array($subject)) {
            $result = [];
            foreach ($subject as $item) {
                $result[] = self::pregReplaceCallbackWithOffsetImpl($pattern, $callback, $item, $limit, $count);
            }
            return $result;
        } else {
            return self::pregReplaceCallbackWithOffsetImpl($pattern, $callback, $subject, $limit, $count);
        }
    }

    private static function pregReplaceCallbackWithOffsetImpl(
        string $pattern,
        callable $callback,
        string $subject,
        int $limit = -1,
        int &$count = null
    ): string
    {
        $count = 0;

        $curOffset = 0;
        $result = '';
        preg_match_all($pattern, $subject, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE);
        foreach ($matches as $i => $match) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($limit >= 0 && $i >= $limit) {
                break;
            }

            $result .= substr($subject, $curOffset, $match[0][1] - $curOffset) . $callback($match);
            $curOffset = $match[0][1] + strlen($match[0][0]);
            $count++;
        }
        $result .= substr($subject, $curOffset);

        return $result;
    }

    /**
     * @param int $num
     * @return string "1st", "2nd", "3rd", "4th", etc. according to <tt>$num</tt>
     */
    public static function englishOrd(int $num): string
    {
        switch ($num) {
            case 1:
                return '1st';
            case 2:
                return '2nd';
            case 3:
                return '3rd';
            default:
                return $num . 'th';
        }
    }

    /**
     * @param int $len
     * @return string a pseudo-random string of hexadecimal digits
     */
    public static function randomHexString(int $len): string
    {
        if ($len < 0) {
            throw new \DomainException('$len is negative');
        }

        $result = '';
        for ($i = 0; $i < $len; $i += strlen($s)) {
            $s = dechex(mt_rand());
            $result .= substr($s, 0, $len - $i);
        }
        return $result;
    }
}


1			<?php
2			declare(strict_types=1);
3			namespace Ivory\Utils;
4
5			class StringUtils
6			{
7			/**
8			* Like {@link preg_replace_callback()}, it performs a string search and replace. The callback does not receive
9			* plain array of matches, but an extended array: each item is a pair of the matching portion of the needle and the
10			* byte offset to the subject, like {@link preg_match_all()} does with the `PREG_OFFSET_CAPTURE` flag.
11			*
12			* @param string $pattern
13			* @param callable $callback
14			* @param string\|string[] $subject
15			* @param int $limit
16			* @param int\|null $count
17			* @return string\|string[] depending on whether <tt>$subject</tt> is <tt>string</tt> or <tt>array</tt>,
			0 ignored issues – show Documentation introduced 2017-02-14 22:32 UTC by Report Bug Copy Issue Report Should the return type not be `array\|string`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
18			* a <tt>string</tt> or <tt>array</tt> is returned
19			*/
20			public static function pregReplaceCallbackWithOffset(
21			string $pattern,
22			callable $callback,
23			$subject,
24			int $limit = -1,
25			int &$count = null
26			)
27			{
28			if (is_array($subject)) {
29			$result = [];
30			foreach ($subject as $item) {
31			$result[] = self::pregReplaceCallbackWithOffsetImpl($pattern, $callback, $item, $limit, $count);
32			}
33			return $result;
34			} else {
35			return self::pregReplaceCallbackWithOffsetImpl($pattern, $callback, $subject, $limit, $count);
36			}
37			}
38
39			private static function pregReplaceCallbackWithOffsetImpl(
40			string $pattern,
41			callable $callback,
42			string $subject,
43			int $limit = -1,
44			int &$count = null
45			): string
46			{
47			$count = 0;
48
49			$curOffset = 0;
50			$result = '';
51			preg_match_all($pattern, $subject, $matches, PREG_SET_ORDER \| PREG_OFFSET_CAPTURE);
52			foreach ($matches as $i => $match) {
			0 ignored issues – show Bug introduced 2017-02-07 21:33 UTC by Report Bug Copy Issue Report The expression `$matches` of type `null\|array<integer,array<integer,string>>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
53			if ($limit >= 0 && $i >= $limit) {
54			break;
55			}
56
57			$result .= substr($subject, $curOffset, $match[0][1] - $curOffset) . $callback($match);
58			$curOffset = $match[0][1] + strlen($match[0][0]);
59			$count++;
60			}
61			$result .= substr($subject, $curOffset);
62
63			return $result;
64			}
65
66			/**
67			* @param int $num
68			* @return string "1st", "2nd", "3rd", "4th", etc. according to <tt>$num</tt>
69			*/
70			public static function englishOrd(int $num): string
71			{
72			switch ($num) {
73			case 1:
74			return '1st';
75			case 2:
76			return '2nd';
77			case 3:
78			return '3rd';
79			default:
80			return $num . 'th';
81			}
82			}
83
84			/**
85			* @param int $len
86			* @return string a pseudo-random string of hexadecimal digits
87			*/
88			public static function randomHexString(int $len): string
89			{
90			if ($len < 0) {
91			throw new \DomainException('$len is negative');
92			}
93
94			$result = '';
95			for ($i = 0; $i < $len; $i += strlen($s)) {
96			$s = dechex(mt_rand());
97			$result .= substr($s, 0, $len - $i);
98			}
99			return $result;
100			}
101			}
102

ondrej-bouda / ivory

Push — master ( 0c19f1...8279ff )

StringUtils::englishOrd() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like