StringUtility::isString1FollowedByString2() - Code Metrics - iranianpep/botonomous - Measure and Improve Code Quality continuously with Scrutinizer

StringUtility::isString1FollowedByString2() A
last analyzed 2021-06-14 01:09 UTC

↳ Parent: StringUtility

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	7
cts	7
cp	1
rs	9.7333
c	0
b	0
f	0
cc	3
nc	4
nop	4
crap	3

<?php

namespace Botonomous\utility;

use Botonomous\BotonomousException;

/**
 * Class StringUtility.
 */
class StringUtility extends AbstractUtility
{
    /**
     * @param string $json
     *
     * @throws \Exception
     *
     * @return array|mixed
     */
    public function jsonToArray(string $json)
    {
        $array = empty($json) ? [] : json_decode($json, true);
        if ($array === null || !is_array($array) || json_last_error() !== 0) {
            throw new BotonomousException('Invalid JSON content');
        }

        return $array;
    }

    /**
     * @param string $toRemove
     * @param string $subject
     *
     * @return string
     */
    public function removeStringFromString(string $toRemove, string $subject): string
    {
        // pattern: !\s+! is used to replace multiple spaces with single space
        return trim(preg_replace('!\s+!', ' ', str_replace($toRemove, '', $subject)));
    }

    /**
     * @param string $toFind
     * @param string $wordBoundary
     *
     * @return string
     */
    private function getFindPattern(string $toFind, string $wordBoundary): string
    {
        return $wordBoundary === true ? "/\b{$toFind}\b/" : "/{$toFind}/";
    }

    /**
     * @param string $toFind
     * @param string $subject
     * @param bool   $wordBoundary If true $toFind is searched with word boundaries
     *
     * @return bool
     */
    public function findInString(string $toFind, string $subject, bool $wordBoundary = true): bool
    {
        $pattern = $this->getFindPattern($toFind, $wordBoundary);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return preg_match($pattern, $subject) ? true : false;
    }

    /**
     * @param string $toFind
     * @param string $subject
     * @param bool   $wordBoundary
     *
     * @return mixed
     */
    public function findPositionInString(string $toFind, string $subject, bool $wordBoundary = true)
    {
        $pattern = $this->getFindPattern($toFind, $wordBoundary);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $positions = [];
        if (preg_match_all($pattern, $subject, $matches, PREG_OFFSET_CAPTURE) && !empty($matches[0])) {
            foreach ($matches[0] as $match) {
                $positions[] = $match[1];
            }
        }

        return $positions;
    }

    /**
     * Convert snake case to camel case e.g. admin_user becomes AdminUser.
     *
     * @param string $string
     *
     * @return string
     */
    public function snakeCaseToCamelCase(string $string)
    {
        return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
    }

    /**
     * Check subject to see whether $string1 is followed by $string2.
     *
     * @param string $subject
     * @param string $string1
     * @param string $string2
     * @param array  $exceptions
     *
     * @return bool
     */
    public function isString1FollowedByString2(
        string $subject,
        string $string1,
        string $string2,
        array $exceptions = []
    ): bool {
        $exceptionsString = '';
        if (!empty($exceptions)) {
            $exceptions = implode('|', $exceptions);
            $exceptionsString = "(?<!{$exceptions})";
        }

        $pattern = '/'.$string1.'(?:\s+\w+'.$exceptionsString.'){0,2}\s+'.$string2.'\b/';

        return preg_match($pattern, $subject) ? true : false;
    }

    /**
     * @param string $haystack
     * @param string $needle
     *
     * @return bool
     */
    public function endsWith(string $haystack, string $needle): bool
    {
        $length = strlen($needle);

        if ($length === 0) {
            return true;
        }

        return substr($haystack, -$length) === $needle;
    }

    /**
     * Apply replacements in a string
     * Replacement key in the string should be like {replacementKey}.
     *
     * @param $subject mixed
     * @param $replacements array
     *
     * @return mixed
     */
    public function applyReplacements($subject, array $replacements)
    {
        if (empty($replacements) || !is_string($subject)) {
            return $subject;
        }

        foreach ($replacements as $key => $value) {
            $subject = str_replace('{'.$key.'}', $value, $subject);
        }

        return $subject;
    }
}


1		<?php
2
3		namespace Botonomous\utility;
4
5		use Botonomous\BotonomousException;
6
7		/**
8		* Class StringUtility.
9		*/
10		class StringUtility extends AbstractUtility
11		{
12		/**
13		* @param string $json
14		*
15		* @throws \Exception
16		*
17		* @return array\|mixed
18		*/
19	22	public function jsonToArray(string $json)
20		{
21	22	$array = empty($json) ? [] : json_decode($json, true);
22	22	if ($array === null \|\| !is_array($array) \|\| json_last_error() !== 0) {
23	1	throw new BotonomousException('Invalid JSON content');
24		}
25
26	22	return $array;
27		}
28
29		/**
30		* @param string $toRemove
31		* @param string $subject
32		*
33		* @return string
34		*/
35	1	public function removeStringFromString(string $toRemove, string $subject): string
36		{
37		// pattern: !\s+! is used to replace multiple spaces with single space
38	1	return trim(preg_replace('!\s+!', ' ', str_replace($toRemove, '', $subject)));
39		}
40
41		/**
42		* @param string $toFind
43		* @param string $wordBoundary
44		*
45		* @return string
46		*/
47	11	private function getFindPattern(string $toFind, string $wordBoundary): string
48		{
49	11	return $wordBoundary === true ? "/\b{$toFind}\b/" : "/{$toFind}/";
50		}
51
52		/**
53		* @param string $toFind
54		* @param string $subject
55		* @param bool $wordBoundary If true $toFind is searched with word boundaries
56		*
57		* @return bool
58		*/
59	5	public function findInString(string $toFind, string $subject, bool $wordBoundary = true): bool
60		{
61	5	$pattern = $this->getFindPattern($toFind, $wordBoundary);
		0 ignored issues – show Documentation introduced 2017-11-13 05:16 UTC by Report Bug Copy Issue Report `$wordBoundary` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
62
63	5	return preg_match($pattern, $subject) ? true : false;
64		}
65
66		/**
67		* @param string $toFind
68		* @param string $subject
69		* @param bool $wordBoundary
70		*
71		* @return mixed
72		*/
73	6	public function findPositionInString(string $toFind, string $subject, bool $wordBoundary = true)
74		{
75	6	$pattern = $this->getFindPattern($toFind, $wordBoundary);
		0 ignored issues – show Documentation introduced 2017-11-13 05:16 UTC by Report Bug Copy Issue Report `$wordBoundary` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
76	6	$positions = [];
77	6	if (preg_match_all($pattern, $subject, $matches, PREG_OFFSET_CAPTURE) && !empty($matches[0])) {
78	4	foreach ($matches[0] as $match) {
79	4	$positions[] = $match[1];
80		}
81		}
82
83	6	return $positions;
84		}
85
86		/**
87		* Convert snake case to camel case e.g. admin_user becomes AdminUser.
88		*
89		* @param string $string
90		*
91		* @return string
92		*/
93	20	public function snakeCaseToCamelCase(string $string)
94		{
95	20	return str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
96		}
97
98		/**
99		* Check subject to see whether $string1 is followed by $string2.
100		*
101		* @param string $subject
102		* @param string $string1
103		* @param string $string2
104		* @param array $exceptions
105		*
106		* @return bool
107		*/
108	1	public function isString1FollowedByString2(
109		string $subject,
110		string $string1,
111		string $string2,
112		array $exceptions = []
113		): bool {
114	1	$exceptionsString = '';
115	1	if (!empty($exceptions)) {
116	1	$exceptions = implode('\|', $exceptions);
117	1	$exceptionsString = "(?<!{$exceptions})";
118		}
119
120	1	$pattern = '/'.$string1.'(?:\s+\w+'.$exceptionsString.'){0,2}\s+'.$string2.'\b/';
121
122	1	return preg_match($pattern, $subject) ? true : false;
123		}
124
125		/**
126		* @param string $haystack
127		* @param string $needle
128		*
129		* @return bool
130		*/
131	13	public function endsWith(string $haystack, string $needle): bool
132		{
133	13	$length = strlen($needle);
134
135	13	if ($length === 0) {
136	1	return true;
137		}
138
139	13	return substr($haystack, -$length) === $needle;
140		}
141
142		/**
143		* Apply replacements in a string
144		* Replacement key in the string should be like {replacementKey}.
145		*
146		* @param $subject mixed
147		* @param $replacements array
148		*
149		* @return mixed
150		*/
151	109	public function applyReplacements($subject, array $replacements)
152		{
153	109	if (empty($replacements) \|\| !is_string($subject)) {
154	107	return $subject;
155		}
156
157	5	foreach ($replacements as $key => $value) {
158	5	$subject = str_replace('{'.$key.'}', $value, $subject);
159		}
160
161	5	return $subject;
162		}
163		}
164

iranianpep / botonomous

StringUtility::isString1FollowedByString2() A last analyzed 2021-06-14 01:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

StringUtility::isString1FollowedByString2() A
last analyzed 2021-06-14 01:09 UTC