phpgearbox / string

src/Base.php

Doc Comments +3 added lines, -3 removed lines

@@ -144,12 +144,12 @@ 
     /**
      * Factory method to create a new Gears\String\Str object.
      *
-     * @param mixed  $string             Must be a scalar string or an object
+     * @param string  $string             Must be a scalar string or an object
      *                                   that implements the __toString() method
      *                                   or a value that is castable to a scalar
      *                                   string.
      *
-     * @param string $encoding           The character encoding to use for this
+     * @param string string           The character encoding to use for this
      *                                   string. If not specified, defaults to
      *                                   the value returned from
      *                                   mb_internal_encoding().
@@ -272,7 +272,7 @@ 
      *
      * @param  mixed $offset The index from which to retrieve the char
      *
-     * @return string                 The character at the specified index
+     * @return Base                 The character at the specified index
      * @throws \OutOfBoundsException If the positive or negative offset does
      *                               not exist
      */

Spacing +4 added lines, -7 removed lines

@@ -96,15 +96,13 @@ 
         // Make sure we can use the provided string value as a string.
         if (is_array($string))
         {
-            throw new \InvalidArgumentException
-            (
+            throw new \InvalidArgumentException(
                 'Passed value cannot be an array'
             );
         }
         elseif (is_object($string) && !method_exists($string, '__toString'))
         {
-            throw new \InvalidArgumentException
-            (
+            throw new \InvalidArgumentException(
                 'Passed object must have a __toString method'
             );
         }
@@ -126,7 +124,7 @@ 
         }
 
         // Set the strings length property.
-        $this->stringLength = UTF8::strlen($this->scalarString,$this->encoding);
+        $this->stringLength = UTF8::strlen($this->scalarString, $this->encoding);
     }
 
     /**
@@ -286,8 +284,7 @@ 
             throw new \OutOfBoundsException('No character exists at the index');
         }
 
-        return $this->newSelf(UTF8::substr
-        (
+        return $this->newSelf(UTF8::substr(
             $this->scalarString,
             $offset,
             1,

Braces +7 added lines, -9 removed lines

@@ -100,8 +100,7 @@ 
             (
                 'Passed value cannot be an array'
             );
-        }
-        elseif (is_object($string) && !method_exists($string, '__toString'))
+        } elseif (is_object($string) && !method_exists($string, '__toString'))
         {
             throw new \InvalidArgumentException
             (
@@ -119,8 +118,7 @@ 
         if ($encoding !== null)
         {
             $this->encoding = $encoding;
-        }
-        else
+        } else
         {
             $this->encoding = mb_internal_encoding();
         }
@@ -199,13 +197,11 @@ 
             {
                 // Convert the scalar string to a Str Object
                 $strObjects[$key] = $this->newSelf($value);
-            }
-            elseif (is_array($value))
+            } elseif (is_array($value))
             {
                 // Recurse into the array
                 $strObjects[$key] = $this->newSelfs($value);
-            }
-            else
+            } else
             {
                 // We don't know what it is do do nothing to it
                 $strObjects[$key] = $value;
@@ -259,7 +255,9 @@ 
     {
         $index = (int)$index;
 
-        if ($index >= 0) return ($this->getLength() > $index);
+        if ($index >= 0) {
+            return ($this->getLength() > $index);
+        }
 
         return ($this->getLength() >= abs($index));
     }

src/Methods/Html.php

Spacing +6 added lines, -12 removed lines

@@ -26,10 +26,8 @@ 
      */
     public function htmlDecode($flags = ENT_COMPAT)
     {
-        return $this->newSelf
-        (
-            UTF8::html_entity_decode
-            (
+        return $this->newSelf(
+            UTF8::html_entity_decode(
                 $this->scalarString,
                 $flags,
                 $this->encoding
@@ -54,10 +52,8 @@ 
     {
         if ($flags === null) $flags = ENT_QUOTES | ENT_SUBSTITUTE;
 
-        return $this->newSelf
-        (
-            UTF8::htmlentities
-            (
+        return $this->newSelf(
+            UTF8::htmlentities(
                 $this->scalarString,
                 $flags,
                 $this->encoding,
@@ -97,8 +93,7 @@ 
             }
             else
             {
-                throw new \RuntimeException
-                (
+                throw new \RuntimeException(
                     "This method requires \voku\helper\AntiXSS. ".
                     "Install with: composer require voku/anti-xss"
                 );
@@ -122,8 +117,7 @@ 
      */
     public function htmlStripTags($allowableTags = null)
     {
-        return $this->newSelf
-        (
+        return $this->newSelf(
             UTF8::strip_tags($this->scalarString, $allowableTags)
         );
     }

Braces +4 added lines, -3 removed lines

@@ -52,7 +52,9 @@ 
      */
     public function htmlEncode($flags = null, $doubleEncode = true)
     {
-        if ($flags === null) $flags = ENT_QUOTES | ENT_SUBSTITUTE;
+        if ($flags === null) {
+            $flags = ENT_QUOTES | ENT_SUBSTITUTE;
+        }
 
         return $this->newSelf
         (
@@ -94,8 +96,7 @@ 
             if (class_exists('\\voku\\helper\\AntiXSS'))
             {
                 $antiXss = new \voku\helper\AntiXSS();
-            }
-            else
+            } else
             {
                 throw new \RuntimeException
                 (

src/Methods/IndexOf.php

Spacing +2 added lines, -4 removed lines

@@ -29,8 +29,7 @@ 
      */
     public function indexOf($needle, $offset = 0)
     {
-        return UTF8::strpos
-        (
+        return UTF8::strpos(
             $this->scalarString,
             (string)$needle,
             (int)$offset,
@@ -53,8 +52,7 @@ 
      */
     public function indexOfLast($needle, $offset = 0)
     {
-        return UTF8::strrpos
-        (
+        return UTF8::strrpos(
             $this->scalarString,
             (string)$needle,
             (int)$offset,

src/Methods/CaseManipulators.php

Spacing +4 added lines, -7 removed lines

@@ -24,8 +24,7 @@ 
     {
         $first = UTF8::substr($this->scalarString, 0, 1, $this->encoding);
 
-        $rest = UTF8::substr
-        (
+        $rest = UTF8::substr(
             $this->scalarString,
             1,
             $this->getLength() - 1,
@@ -44,8 +43,7 @@ 
     {
         $first = UTF8::substr($this->scalarString, 0, 1, $this->encoding);
 
-        $rest = UTF8::substr
-        (
+        $rest = UTF8::substr(
             $this->scalarString,
             1,
             $this->getLength() - 1,
@@ -62,10 +60,9 @@ 
      */
     public function swapCase()
     {
-        return $this->newSelf(preg_replace_callback
-        (
+        return $this->newSelf(preg_replace_callback(
             '/[\S]/u',
-            function ($match)
+            function($match)
             {
                 $marchToUpper = UTF8::strtoupper($match[0], $this->encoding);
 

src/Methods/Regx.php

Braces +32 added lines, -14 removed lines

@@ -53,7 +53,9 @@ 
     public function regexMatch($pattern, $options = '')
     {
         // Ensure the options contain the "u" modifier.
-        if (!$this->newSelf($options)->contains('u')) $options .= 'u';
+        if (!$this->newSelf($options)->contains('u')) {
+            $options .= 'u';
+        }
 
         // Build the expression
         $expression =
@@ -67,7 +69,9 @@ 
         $result = preg_match($expression, $this->scalarString);
 
         // If no errors return true or false based on number of matches found.
-        if ($result !== false) return $result === 1;
+        if ($result !== false) {
+            return $result === 1;
+        }
 
         // Otherwise throw with last known PCRE Error.
         throw new PcreException();
@@ -94,7 +98,9 @@ 
         $matches = [];
 
         // Ensure the options contain the "u" modifier.
-        if (!$this->newSelf($options)->contains('u')) $options .= 'u';
+        if (!$this->newSelf($options)->contains('u')) {
+            $options .= 'u';
+        }
 
         // Build the expression
         $expression =
@@ -108,7 +114,9 @@ 
         $result = preg_match($expression, $this->scalarString, $matches);
 
         // If no errors return the $matches array
-        if ($result !== false) return $this->newSelfs($matches);
+        if ($result !== false) {
+            return $this->newSelfs($matches);
+        }
 
         // Otherwise throw with last known PCRE Error.
         throw new PcreException();
@@ -131,10 +139,14 @@ 
     {
         // The original regexReplace method in danielstjules/Stringy used
         // mb_ereg_replace() which supports an "r" flag, PCRE does not.
-        if ($options === 'msr') $options = 'ms';
+        if ($options === 'msr') {
+            $options = 'ms';
+        }
 
         // Ensure the options contain the "u" modifier.
-        if (!$this->newSelf($options)->contains('u')) $options .= 'u';
+        if (!$this->newSelf($options)->contains('u')) {
+            $options .= 'u';
+        }
 
         // Build the expression
         $expression =
@@ -148,7 +160,9 @@ 
         $replaced = preg_replace($expression, $replacement, $this->scalarString);
 
         // If no errors return the replacement
-        if ($replaced !== null) return $this->newSelf($replaced);
+        if ($replaced !== null) {
+            return $this->newSelf($replaced);
+        }
 
         // Otherwise throw with last known PCRE Error.
         throw new PcreException();
@@ -170,19 +184,22 @@ 
     public function split($pattern, $limit = null, $quote = true)
     {
         // Not sure why you would do this but your wish is our command :)
-        if ($limit === 0) return [];
+        if ($limit === 0) {
+            return [];
+        }
 
         // UTF8::split errors when supplied an empty pattern in < PHP 5.4.13
         // and current versions of HHVM (3.8 and below)
-        if ($pattern === '') return [$this->newSelf($this->scalarString)];
+        if ($pattern === '') {
+            return [$this->newSelf($this->scalarString)];
+        }
 
         // UTF8::split returns the remaining unsplit string
         // in the last index when supplying a limit.
         if ($limit > 0)
         {
             $limit += 1;
-        }
-        else
+        } else
         {
             $limit = -1;
         }
@@ -196,8 +213,7 @@ 
         if ($quote === true)
         {
             $expression .= preg_quote($pattern, $this->regexDelimiter);
-        }
-        else
+        } else
         {
             $expression .= $pattern;
         }
@@ -208,7 +224,9 @@ 
         $array = preg_split($expression, $this->scalarString, $limit);
 
         // Remove any remaining unsplit string.
-        if ($limit > 0 && count($array) === $limit) array_pop($array);
+        if ($limit > 0 && count($array) === $limit) {
+            array_pop($array);
+        }
 
         return $this->newSelfs($array);
     }

src/Methods/To.php

Spacing +27 added lines, -46 removed lines

@@ -44,8 +44,7 @@ 
      */
     public function toLowerCase()
     {
-        return $this->newSelf
-        (
+        return $this->newSelf(
             UTF8::strtolower($this->scalarString, $this->encoding)
         );
     }
@@ -57,8 +56,7 @@ 
      */
     public function toUpperCase()
     {
-        return $this->newSelf
-        (
+        return $this->newSelf(
             UTF8::strtoupper($this->scalarString, $this->encoding)
         );
     }
@@ -74,15 +72,13 @@ 
     {
         if (!class_exists('\\ICanBoogie\\Inflector'))
         {
-            throw new \RuntimeException
-            (
+            throw new \RuntimeException(
                 "This method requires ICanBoogie\Inflector. ".
                 "Install with: composer require icanboogie/inflector"
             );
         }
 
-        return $this->newSelf
-        (
+        return $this->newSelf(
             \ICanBoogie\Inflector::get($language)
             ->singularize($this->scalarString)
         );
@@ -99,15 +95,13 @@ 
     {
         if (!class_exists('\\ICanBoogie\\Inflector'))
         {
-            throw new \RuntimeException
-            (
+            throw new \RuntimeException(
                 "This method requires ICanBoogie\Inflector. ".
                 "Install with: composer require icanboogie/inflector"
             );
         }
 
-        return $this->newSelf
-        (
+        return $this->newSelf(
             \ICanBoogie\Inflector::get($language)
             ->pluralize($this->scalarString)
         );
@@ -123,8 +117,7 @@ 
      */
     public function toAscii()
     {
-        return $this->newSelf
-        (
+        return $this->newSelf(
             UTF8::toAscii($this->scalarString)
         );
     }
@@ -184,10 +177,8 @@ 
      */
     public function toSpaces($tabLength = 4)
     {
-        return $this->newSelf
-        (
-            UTF8::str_replace
-            (
+        return $this->newSelf(
+            UTF8::str_replace(
                 "\t",
                 UTF8::str_repeat(' ', $tabLength),
                 $this->scalarString
@@ -208,10 +199,8 @@ 
      */
     public function toTabs($tabLength = 4)
     {
-        return $this->newSelf
-        (
-            UTF8::str_replace
-            (
+        return $this->newSelf(
+            UTF8::str_replace(
                 UTF8::str_repeat(' ', $tabLength),
                 "\t",
                 $this->scalarString
@@ -263,10 +252,9 @@ 
 
         $camelCase = preg_replace('/^[-_]+/', '', (string)$camelCase);
 
-        $camelCase = preg_replace_callback
-        (
+        $camelCase = preg_replace_callback(
             '/[-_\s]+(.)?/u',
-            function ($match)
+            function($match)
             {
                 if (isset($match[1]))
                 {
@@ -280,10 +268,9 @@ 
             $camelCase
         );
 
-        $camelCase = preg_replace_callback
-        (
+        $camelCase = preg_replace_callback(
             '/[\d]+(.)?/u',
-            function ($match)
+            function($match)
             {
                 return UTF8::strtoupper($match[0], $this->encoding);
             },
@@ -308,31 +295,29 @@ 
 
         $snake = str_replace('-', '_', $snake);
 
-        $snake = preg_replace_callback
-        (
+        $snake = preg_replace_callback(
             '/([\d|A-Z])/u',
-            function ($matches)
+            function($matches)
             {
                 $match = $matches[1];
                 $matchInt = (int)$match;
 
                 if ("$matchInt" == $match)
                 {
-                    return '_' . $match . '_';
+                    return '_'.$match.'_';
                 }
                 else
                 {
-                    return '_' . UTF8::strtolower($match, $this->encoding);
+                    return '_'.UTF8::strtolower($match, $this->encoding);
                 }
             },
             $snake
         );
 
-        $snake = preg_replace
-        (
+        $snake = preg_replace(
             [
-                '/\s+/',        // convert spaces to "_"
-                '/^\s+|\s+$/',  // trim leading & trailing spaces
+                '/\s+/', // convert spaces to "_"
+                '/^\s+|\s+$/', // trim leading & trailing spaces
                 '/_+/'          // remove double "_"
             ],
             [
@@ -364,10 +349,9 @@ 
      */
     public function toTitleCase($ignore = null)
     {
-        return $this->newSelf(preg_replace_callback
-        (
+        return $this->newSelf(preg_replace_callback(
             '/([\S]+)/u',
-            function ($match) use ($ignore)
+            function($match) use ($ignore)
             {
                 if ($ignore && in_array($match[0], $ignore, true))
                 {
@@ -415,17 +399,14 @@ 
     {
         if (!class_exists('\\voku\\helper\\URLify'))
         {
-            throw new \RuntimeException
-            (
+            throw new \RuntimeException(
                 "This method requires \voku\helper\URLify. ".
                 "Install with: composer require voku/urlify"
             );
         }
 
-        return $this->newSelf
-        (
-            \voku\helper\URLify::slug
-            (
+        return $this->newSelf(
+            \voku\helper\URLify::slug(
                 $this->scalarString,
                 $language,
                 $replacement,

src/Methods/Is.php

Braces +12 added lines, -4 removed lines

@@ -88,7 +88,9 @@ 
      */
     public function isJson()
     {
-        if ($this->getLength() === 0) return false;
+        if ($this->getLength() === 0) {
+            return false;
+        }
 
         json_decode($this->scalarString);
 
@@ -102,7 +104,9 @@ 
      */
     public function isSerialized()
     {
-        if ($this->getLength() === 0) return false;
+        if ($this->getLength() === 0) {
+            return false;
+        }
 
         /** @noinspection PhpUsageOfSilenceOperatorInspection */
         return
@@ -120,7 +124,9 @@ 
     public function isBase64()
     {
         // An empty string is by definition not encoded.
-        if ($this->getLength() === 0) return false;
+        if ($this->getLength() === 0) {
+            return false;
+        }
 
         // Grab the current string value.
         $possiblyEncoded = $this->scalarString;
@@ -129,7 +135,9 @@ 
         $decoded = base64_decode($possiblyEncoded, true);
 
         // If we get false it can't be base64
-        if ($decoded === false) return false;
+        if ($decoded === false) {
+            return false;
+        }
 
         // Lets double check
         return (base64_encode($decoded) === $this->scalarString);

src/Methods/LongestCommon.php

Spacing +2 added lines, -3 removed lines

@@ -60,7 +60,7 @@ 
 
             if ($char == UTF8::substr($otherStr, -$i, 1, $this->encoding))
             {
-                $longestCommonSuffix = $char . $longestCommonSuffix;
+                $longestCommonSuffix = $char.$longestCommonSuffix;
             }
             else
             {
@@ -117,8 +117,7 @@ 
             }
         }
 
-        return $this->newSelf(UTF8::substr
-        (
+        return $this->newSelf(UTF8::substr(
             $this->scalarString,
             $end - $len,
             $len,

Braces +6 added lines, -7 removed lines

@@ -33,8 +33,7 @@ 
             if ($char == UTF8::substr($otherStr, $i, 1, $this->encoding))
             {
                 $longestCommonPrefix .= $char;
-            }
-            else
+            } else
             {
                 break;
             }
@@ -61,8 +60,7 @@ 
             if ($char == UTF8::substr($otherStr, -$i, 1, $this->encoding))
             {
                 $longestCommonSuffix = $char . $longestCommonSuffix;
-            }
-            else
+            } else
             {
                 break;
             }
@@ -88,7 +86,9 @@ 
         $otherLength = UTF8::strlen($otherStr, $this->encoding);
 
         // Return if either string is empty
-        if ($strLength == 0 || $otherLength == 0) return $this->newSelf('');
+        if ($strLength == 0 || $otherLength == 0) {
+            return $this->newSelf('');
+        }
 
         $len = 0; $end = 0;
         $table = array_fill(0, $strLength + 1, array_fill(0, $otherLength + 1, 0));
@@ -109,8 +109,7 @@ 
                         $len = $table[$i][$j];
                         $end = $i;
                     }
-                }
-                else
+                } else
                 {
                     $table[$i][$j] = 0;
                 }

src/Methods/Contains.php

Braces +13 added lines, -6 removed lines

@@ -32,8 +32,7 @@ 
         if ($caseSensitive)
         {
             return (UTF8::strpos($this->scalarString, $needle, 0, $this->encoding) !== false);
-        }
-        else
+        } else
         {
             return (UTF8::stripos($this->scalarString, $needle, 0, $this->encoding) !== false);
         }
@@ -53,11 +52,15 @@ 
      */
     public function containsAll($needles, $caseSensitive = true)
     {
-        if (empty($needles)) return false;
+        if (empty($needles)) {
+            return false;
+        }
 
         foreach ($needles as $needle)
         {
-            if (!$this->contains($needle, $caseSensitive)) return false;
+            if (!$this->contains($needle, $caseSensitive)) {
+                return false;
+            }
         }
 
         return true;
@@ -77,11 +80,15 @@ 
      */
     public function containsAny($needles, $caseSensitive = true)
     {
-        if (empty($needles)) return false;
+        if (empty($needles)) {
+            return false;
+        }
 
         foreach ($needles as $needle)
         {
-            if ($this->contains($needle, $caseSensitive)) return true;
+            if ($this->contains($needle, $caseSensitive)) {
+                return true;
+            }
         }
 
         return false;