StringHelpers::truncate() - Code Metrics - Inspection of "BUMP CHANGELOG.md" - sfneal/string-helpers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 305567...9aabe5 )

by Stephen

created 2020-08-28 15:47 UTC

StringHelpers::truncate() A

↳ Parent: StringHelpers

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	1
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	3
rs	10

<?php


namespace Sfneal\Helpers\Strings;


class StringHelpers
{
    /**
     * @var string
     */
    private $string;

    /**
     * StringHelpers constructor.
     *
     * @param string $string
     */
    public function __construct(string $string)
    {
        $this->string = $string;
    }

    /**
     * Sanitize a file name to remove illegal chars.
     *
     * @return string
     */
    public function sanitizeFileName(): string
    {
        return preg_replace('/[^A-Za-z0-9_\-]/', '_', $this->string);
    }

    /**
     * Truncate a string to be no longer than $chars.
     *
     * @param int $chars
     * @param string $suffix
     * @return string
     */
    public function truncate(int $chars = 100, string $suffix = '...'): string
    {
        return (strlen($this->string) <= $chars) ? $this->string : substr($this->string, 0, $chars) . $suffix;
    }

    /**
     * Covert a camel cased string into a $char separated string.
     *
     * @param string $char
     * @return string
     */
    public function camelCaseConvert(string $char = '-'): string
    {
        return strtolower(preg_replace('/(?<!^)[A-Z]/', $char.'$0', $this->string));
    }

    /**
     * Remove illegal characters from a string to create an ID.
     *
     * @return string
     */
    public function id(): string
    {
        return strtolower(
            str_replace(' ', '-', str_replace('&', '-', $this->string))
        );
    }

    /**
     * Remove ' ', '-', '&' characters.
     *
     * @return string
     */
    public function strip()
    {
        return strtolower(
            str_replace(
                ',', '', str_replace(
                    ' ', '-', str_replace(
                        '&',
                        '',
                        $this->string
                    )
                )
            )
        );
    }

    /**
     * Check if a needle string is in a haystack string.
     *
     * @param string $needle
     * @return bool
     */
    public function inString(string $needle): bool
    {
        return strpos($this->string, $needle) !== false;
    }

    /**
     * Determine if the $string is a plain text list of values.
     *
     *  - if $string is a list, an array of values is returned
     *  - if $sting is a string, false is returned
     *
     * @param array|string[] $separators
     * @return bool|false|string[]
     */
    public function isListString(array $separators = [', ', ' '])
    {
        foreach ($separators as $needle) {
            // If the $needle is found in the $string
            // we know the string is a plain text list
            // so an array of values is returned
            if ($this->inString($needle)) {
                return explode($needle, $this->string);
            }
        }

        // If none of the separators are found
        // we know the string is not a list
        return false;
    }

    /**
     * Explode a string using an array of delimiters instead of a single string.
     *
     * @param array|string[] $delimiters
     * @param string $replacer
     * @return array
     */
    public function explodeMany(array $delimiters = [',', '&', '/', '-'], string $replacer = '***'): array
    {
        // Replace all of $delimiters chars with the
        // $replacer so that a single delimiter can
        // be used to explode the string
        $cleaned = str_replace($delimiters, $replacer, $this->string);

        // Use the replacer as the $delimiter
        // since it has replaced each of the
        // passed $delimiters
        $split = explode($replacer, $cleaned);

        // Utilize collection's if laravel/framework is installed
        if (function_exists('collect')) {
            // Collect the array of strings
            return collect($split)

                // Remove empty strings from the collection
                ->filter(function (string $item) {
                    return strlen($item) > 0;
                })

                // Trim the remaining strings in the collection
                ->map(function (string $item) {
                    return trim($item);
                })

                // Encode as array
                ->toArray();
        }

        // Use built in array functions
        else {
            // Remove empty strings from the collection
            $filtered = array_filter($split, function (string $item) {
                return strlen($item) > 0;
            });

            // Trim the remaining strings in the collection
            return  array_map(function (string $item) {
                return trim($item);
            }, $filtered);
        }
    }

    /**
     * Add whitespace padding to a string.
     *
     * @param int $amount
     * @param string $pad
     * @param bool $front add whitespace to 'front' of the string
     * @param bool $back add whitespace to the 'back' of the string
     * @return string
     */
    public function whitespacePad(int $amount = 1,
                                  string $pad = ' ',
                                  bool $front = true,
                                  bool $back = true)
    {
        // Multiple $pad chars by $amount
        $whitespace = str_repeat($pad, $amount);

        // Return string with padding
        return ($front ? $whitespace : '') . $this->string . ($back ? $whitespace : '');
    }

    /**
     * Add whitespace padding to only the 'back' of the string.
     *
     * @param int $amount
     * @param string $pad
     * @return string
     */
    public function whitespacePadBack(int $amount = 1, string $pad = ' ')
    {
        return $this->whitespacePad($amount, $pad, false, true);
    }

    /**
     * Add whitespace padding to only the 'back' of the string.
     *
     * @param int $amount
     * @param string $pad
     * @return string
     */
    function whitespacePadFront(int $amount = 1, string $pad = ' ')

    {
        return $this->whitespacePad($amount, $pad, true, false);
    }
}


1			<?php
2
3
4			namespace Sfneal\Helpers\Strings;
5
6
7			class StringHelpers
8			{
9			/**
10			* @var string
11			*/
12			private $string;
13
14			/**
15			* StringHelpers constructor.
16			*
17			* @param string $string
18			*/
19			public function __construct(string $string)
20			{
21			$this->string = $string;
22			}
23
24			/**
25			* Sanitize a file name to remove illegal chars.
26			*
27			* @return string
28			*/
29			public function sanitizeFileName(): string
30			{
31			return preg_replace('/[^A-Za-z0-9_\-]/', '_', $this->string);
32			}
33
34			/**
35			* Truncate a string to be no longer than $chars.
36			*
37			* @param int $chars
38			* @param string $suffix
39			* @return string
40			*/
41			public function truncate(int $chars = 100, string $suffix = '...'): string
42			{
43			return (strlen($this->string) <= $chars) ? $this->string : substr($this->string, 0, $chars) . $suffix;
44			}
45
46			/**
47			* Covert a camel cased string into a $char separated string.
48			*
49			* @param string $char
50			* @return string
51			*/
52			public function camelCaseConvert(string $char = '-'): string
53			{
54			return strtolower(preg_replace('/(?<!^)[A-Z]/', $char.'$0', $this->string));
55			}
56
57			/**
58			* Remove illegal characters from a string to create an ID.
59			*
60			* @return string
61			*/
62			public function id(): string
63			{
64			return strtolower(
65			str_replace(' ', '-', str_replace('&', '-', $this->string))
66			);
67			}
68
69			/**
70			* Remove ' ', '-', '&' characters.
71			*
72			* @return string
73			*/
74			public function strip()
75			{
76			return strtolower(
77			str_replace(
78			',', '', str_replace(
79			' ', '-', str_replace(
80			'&',
81			'',
82			$this->string
83			)
84			)
85			)
86			);
87			}
88
89			/**
90			* Check if a needle string is in a haystack string.
91			*
92			* @param string $needle
93			* @return bool
94			*/
95			public function inString(string $needle): bool
96			{
97			return strpos($this->string, $needle) !== false;
98			}
99
100			/**
101			* Determine if the $string is a plain text list of values.
102			*
103			* - if $string is a list, an array of values is returned
104			* - if $sting is a string, false is returned
105			*
106			* @param array\|string[] $separators
107			* @return bool\|false\|string[]
108			*/
109			public function isListString(array $separators = [', ', ' '])
110			{
111			foreach ($separators as $needle) {
112			// If the $needle is found in the $string
113			// we know the string is a plain text list
114			// so an array of values is returned
115			if ($this->inString($needle)) {
116			return explode($needle, $this->string);
117			}
118			}
119
120			// If none of the separators are found
121			// we know the string is not a list
122			return false;
123			}
124
125			/**
126			* Explode a string using an array of delimiters instead of a single string.
127			*
128			* @param array\|string[] $delimiters
129			* @param string $replacer
130			* @return array
131			*/
132			public function explodeMany(array $delimiters = [',', '&', '/', '-'], string $replacer = '***'): array
133			{
134			// Replace all of $delimiters chars with the
135			// $replacer so that a single delimiter can
136			// be used to explode the string
137			$cleaned = str_replace($delimiters, $replacer, $this->string);
138
139			// Use the replacer as the $delimiter
140			// since it has replaced each of the
141			// passed $delimiters
142			$split = explode($replacer, $cleaned);
143
144			// Utilize collection's if laravel/framework is installed
145			if (function_exists('collect')) {
146			// Collect the array of strings
147			return collect($split)
148
149			// Remove empty strings from the collection
150			->filter(function (string $item) {
151			return strlen($item) > 0;
152			})
153
154			// Trim the remaining strings in the collection
155			->map(function (string $item) {
156			return trim($item);
157			})
158
159			// Encode as array
160			->toArray();
161			}
162
163			// Use built in array functions
164			else {
165			// Remove empty strings from the collection
166			$filtered = array_filter($split, function (string $item) {
167			return strlen($item) > 0;
168			});
169
170			// Trim the remaining strings in the collection
171			return array_map(function (string $item) {
172			return trim($item);
173			}, $filtered);
174			}
175			}
176
177			/**
178			* Add whitespace padding to a string.
179			*
180			* @param int $amount
181			* @param string $pad
182			* @param bool $front add whitespace to 'front' of the string
183			* @param bool $back add whitespace to the 'back' of the string
184			* @return string
185			*/
186			public function whitespacePad(int $amount = 1,
187			string $pad = ' ',
188			bool $front = true,
189			bool $back = true)
190			{
191			// Multiple $pad chars by $amount
192			$whitespace = str_repeat($pad, $amount);
193
194			// Return string with padding
195			return ($front ? $whitespace : '') . $this->string . ($back ? $whitespace : '');
196			}
197
198			/**
199			* Add whitespace padding to only the 'back' of the string.
200			*
201			* @param int $amount
202			* @param string $pad
203			* @return string
204			*/
205			public function whitespacePadBack(int $amount = 1, string $pad = ' ')
206			{
207			return $this->whitespacePad($amount, $pad, false, true);
208			}
209
210			/**
211			* Add whitespace padding to only the 'back' of the string.
212			*
213			* @param int $amount
214			* @param string $pad
215			* @return string
216			*/
217			function whitespacePadFront(int $amount = 1, string $pad = ' ')
			0 ignored issues – show Best Practice introduced 2020-08-28 15:48 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
218			{
219			return $this->whitespacePad($amount, $pad, true, false);
220			}
221			}
222

sfneal / string-helpers

Push — master ( 305567...9aabe5 )

StringHelpers::truncate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like