phpgearbox / string

src/Methods/Contains.php

Indentation +64 added lines, -64 removed lines

@@ -16,74 +16,74 @@
 trait Contains
 {
     /**
-	 * Returns true if the string contains $needle, false otherwise.
-	 *
-	 * By default the comparison is case-sensitive, but can be made
-	 * insensitive by setting $caseSensitive to false.
-	 *
-	 * @param  string $needle        Substring to look for.
-	 *
-	 * @param  bool   $caseSensitive Whether or not to enforce case-sensitivity.
-	 *
-	 * @return bool                  Whether or not $str contains $needle.
-	 */
-	public function contains($needle, $caseSensitive = true)
-	{
-		if ($caseSensitive)
-		{
-			return (UTF8::strpos($this->scalarString, $needle, 0, $this->encoding) !== false);
-		}
-		else
-		{
-			return (UTF8::stripos($this->scalarString, $needle, 0, $this->encoding) !== false);
-		}
-	}
+     * Returns true if the string contains $needle, false otherwise.
+     *
+     * By default the comparison is case-sensitive, but can be made
+     * insensitive by setting $caseSensitive to false.
+     *
+     * @param  string $needle        Substring to look for.
+     *
+     * @param  bool   $caseSensitive Whether or not to enforce case-sensitivity.
+     *
+     * @return bool                  Whether or not $str contains $needle.
+     */
+    public function contains($needle, $caseSensitive = true)
+    {
+        if ($caseSensitive)
+        {
+            return (UTF8::strpos($this->scalarString, $needle, 0, $this->encoding) !== false);
+        }
+        else
+        {
+            return (UTF8::stripos($this->scalarString, $needle, 0, $this->encoding) !== false);
+        }
+    }
 
-	/**
-	 * Returns true if the string contains all $needles, false otherwise.
-	 *
-	 * By default the comparison is case-sensitive, but can be made
-	 * insensitive by setting $caseSensitive to false.
-	 *
-	 * @param  array $needles       SubStrings to look for.
-	 *
-	 * @param  bool  $caseSensitive Whether or not to enforce case-sensitivity.
-	 *
-	 * @return bool                 Whether or not $str contains $needle.
-	 */
-	public function containsAll($needles, $caseSensitive = true)
-	{
-		if (empty($needles)) return false;
+    /**
+     * Returns true if the string contains all $needles, false otherwise.
+     *
+     * By default the comparison is case-sensitive, but can be made
+     * insensitive by setting $caseSensitive to false.
+     *
+     * @param  array $needles       SubStrings to look for.
+     *
+     * @param  bool  $caseSensitive Whether or not to enforce case-sensitivity.
+     *
+     * @return bool                 Whether or not $str contains $needle.
+     */
+    public function containsAll($needles, $caseSensitive = true)
+    {
+        if (empty($needles)) return false;
 
-		foreach ($needles as $needle)
-		{
-			if (!$this->contains($needle, $caseSensitive)) return false;
-		}
+        foreach ($needles as $needle)
+        {
+            if (!$this->contains($needle, $caseSensitive)) return false;
+        }
 
-		return true;
-	}
+        return true;
+    }
 
-	/**
-	 * Returns true if the string contains any $needles, false otherwise.
-	 *
-	 * By default the comparison is case-sensitive, but can be made
-	 * insensitive by setting $caseSensitive to false.
-	 *
-	 * @param  array $needles       SubStrings to look for.
-	 *
-	 * @param  bool  $caseSensitive Whether or not to enforce case-sensitivity.
-	 *
-	 * @return bool                 Whether or not $str contains $needle.
-	 */
-	public function containsAny($needles, $caseSensitive = true)
-	{
-		if (empty($needles)) return false;
+    /**
+     * Returns true if the string contains any $needles, false otherwise.
+     *
+     * By default the comparison is case-sensitive, but can be made
+     * insensitive by setting $caseSensitive to false.
+     *
+     * @param  array $needles       SubStrings to look for.
+     *
+     * @param  bool  $caseSensitive Whether or not to enforce case-sensitivity.
+     *
+     * @return bool                 Whether or not $str contains $needle.
+     */
+    public function containsAny($needles, $caseSensitive = true)
+    {
+        if (empty($needles)) return false;
 
-		foreach ($needles as $needle)
-		{
-			if ($this->contains($needle, $caseSensitive)) return true;
-		}
+        foreach ($needles as $needle)
+        {
+            if ($this->contains($needle, $caseSensitive)) return true;
+        }
 
-		return false;
-	}
+        return false;
+    }
 }

src/Methods/Regx.php

Indentation +149 added lines, -149 removed lines

@@ -16,145 +16,145 @@ 
 
 trait Regx
 {
-	/**
-	 * The delimiter we will use for all regular expressions.
-	 *
-	 * @see http://php.net/manual/en/regexp.reference.delimiters.php
-	 *
-	 * @var string
-	 */
-	protected $regexDelimiter = '/';
-
-	/**
-	 * Allows you to change the the default regular expression delimiter.
-	 *
-	 * @param string $value The delimiter to use for all future expressions.
-	 *
-	 * @return static
-	 */
-	public function setRegexDelimiter($value)
-	{
-		$this->regexDelimiter = $value;
-
-		return $this;
-	}
+    /**
+     * The delimiter we will use for all regular expressions.
+     *
+     * @see http://php.net/manual/en/regexp.reference.delimiters.php
+     *
+     * @var string
+     */
+    protected $regexDelimiter = '/';
 
     /**
-	 * Returns true if the string matches the supplied pattern, false otherwise.
-	 *
-	 * @param  string $pattern Regex pattern to match against.
-	 *
-	 * @param  string $options Matching conditions to be used.
-	 *
-	 * @return bool
-	 *
-	 * @throws PcreException   When PCRE Error occurs.
-	 */
-	public function regexMatch($pattern, $options = '')
-	{
-		// Ensure the options contain the "u" modifier.
-		if (!$this->newSelf($options)->contains('u')) $options .= 'u';
-
-		// Build the expression
-		$expression =
-			$this->regexDelimiter.
-			$pattern.
-			$this->regexDelimiter.
-			$options
-		;
-
-		// Run the expression
-		$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;
-
-		// Otherwise throw with last known PCRE Error.
+     * Allows you to change the the default regular expression delimiter.
+     *
+     * @param string $value The delimiter to use for all future expressions.
+     *
+     * @return static
+     */
+    public function setRegexDelimiter($value)
+    {
+        $this->regexDelimiter = $value;
+
+        return $this;
+    }
+
+    /**
+     * Returns true if the string matches the supplied pattern, false otherwise.
+     *
+     * @param  string $pattern Regex pattern to match against.
+     *
+     * @param  string $options Matching conditions to be used.
+     *
+     * @return bool
+     *
+     * @throws PcreException   When PCRE Error occurs.
+     */
+    public function regexMatch($pattern, $options = '')
+    {
+        // Ensure the options contain the "u" modifier.
+        if (!$this->newSelf($options)->contains('u')) $options .= 'u';
+
+        // Build the expression
+        $expression =
+            $this->regexDelimiter.
+            $pattern.
+            $this->regexDelimiter.
+            $options
+        ;
+
+        // Run the expression
+        $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;
+
+        // Otherwise throw with last known PCRE Error.
         throw new PcreException();
-	}
-
-	/**
-	 * Given an expression with capture groups, this will return those captures.
-	 *
-	 * Basically this is the same as `regexMatch()` but returns the array
-	 * of matches from `preg_match()` where as `regexMatch()` just returns
-	 * a boolean result.
-	 *
-	 * @param  string $pattern Regex pattern to match against.
-	 *
-	 * @param  string $options Matching conditions to be used.
-	 *
-	 * @return array           The matches discovered by `preg_match()`.
-	 *
-	 * @throws PcreException   When PCRE Error occurs.
-	 */
-	public function regexExtract($pattern, $options = '')
-	{
-		// Define the array that will be filled by preg_match().
-		$matches = [];
-
-		// Ensure the options contain the "u" modifier.
-		if (!$this->newSelf($options)->contains('u')) $options .= 'u';
-
-		// Build the expression
-		$expression =
-			$this->regexDelimiter.
-			$pattern.
-			$this->regexDelimiter.
-			$options
-		;
-
-		// Run the expression
-		$result = preg_match($expression, $this->scalarString, $matches);
-
-		// If no errors return the $matches array
-		if ($result !== false) return $this->newSelfs($matches);
-
-		// Otherwise throw with last known PCRE Error.
+    }
+
+    /**
+     * Given an expression with capture groups, this will return those captures.
+     *
+     * Basically this is the same as `regexMatch()` but returns the array
+     * of matches from `preg_match()` where as `regexMatch()` just returns
+     * a boolean result.
+     *
+     * @param  string $pattern Regex pattern to match against.
+     *
+     * @param  string $options Matching conditions to be used.
+     *
+     * @return array           The matches discovered by `preg_match()`.
+     *
+     * @throws PcreException   When PCRE Error occurs.
+     */
+    public function regexExtract($pattern, $options = '')
+    {
+        // Define the array that will be filled by preg_match().
+        $matches = [];
+
+        // Ensure the options contain the "u" modifier.
+        if (!$this->newSelf($options)->contains('u')) $options .= 'u';
+
+        // Build the expression
+        $expression =
+            $this->regexDelimiter.
+            $pattern.
+            $this->regexDelimiter.
+            $options
+        ;
+
+        // Run the expression
+        $result = preg_match($expression, $this->scalarString, $matches);
+
+        // If no errors return the $matches array
+        if ($result !== false) return $this->newSelfs($matches);
+
+        // Otherwise throw with last known PCRE Error.
         throw new PcreException();
-	}
-
-	/**
-	 * Replaces all occurrences of $pattern in $str by $replacement.
-	 *
-	 * @param  string $pattern     The regular expression pattern.
-	 *
-	 * @param  string $replacement The string to replace with.
-	 *
-	 * @param  string $options     Matching conditions to be used.
-	 *
-	 * @return static              Resulting string after the replacements
-	 *
-	 * @throws PcreException       When PCRE Error occurs.
-	 */
-	public function regexReplace($pattern, $replacement, $options = '')
-	{
-		// The original regexReplace method in danielstjules/Stringy used
-		// mb_ereg_replace() which supports an "r" flag, PCRE does not.
-		if ($options === 'msr') $options = 'ms';
-
-		// Ensure the options contain the "u" modifier.
-		if (!$this->newSelf($options)->contains('u')) $options .= 'u';
-
-		// Build the expression
-		$expression =
-			$this->regexDelimiter.
-			$pattern.
-			$this->regexDelimiter.
-			$options
-		;
-
-		// Run the regular expression replacement
-		$replaced = preg_replace($expression, $replacement, $this->scalarString);
-
-		// If no errors return the replacement
-		if ($replaced !== null) return $this->newSelf($replaced);
-
-		// Otherwise throw with last known PCRE Error.
+    }
+
+    /**
+     * Replaces all occurrences of $pattern in $str by $replacement.
+     *
+     * @param  string $pattern     The regular expression pattern.
+     *
+     * @param  string $replacement The string to replace with.
+     *
+     * @param  string $options     Matching conditions to be used.
+     *
+     * @return static              Resulting string after the replacements
+     *
+     * @throws PcreException       When PCRE Error occurs.
+     */
+    public function regexReplace($pattern, $replacement, $options = '')
+    {
+        // The original regexReplace method in danielstjules/Stringy used
+        // mb_ereg_replace() which supports an "r" flag, PCRE does not.
+        if ($options === 'msr') $options = 'ms';
+
+        // Ensure the options contain the "u" modifier.
+        if (!$this->newSelf($options)->contains('u')) $options .= 'u';
+
+        // Build the expression
+        $expression =
+            $this->regexDelimiter.
+            $pattern.
+            $this->regexDelimiter.
+            $options
+        ;
+
+        // Run the regular expression replacement
+        $replaced = preg_replace($expression, $replacement, $this->scalarString);
+
+        // If no errors return the replacement
+        if ($replaced !== null) return $this->newSelf($replaced);
+
+        // Otherwise throw with last known PCRE Error.
         throw new PcreException();
-	}
+    }
 
-	/**
+    /**
      * Splits the string with the provided regular expression.
      *
      * @param  string   $pattern The regex with which to split the string.
@@ -169,7 +169,7 @@ 
      */
     public function split($pattern, $limit = null, $quote = true)
     {
-		// Not sure why you would do this but your wish is our command :)
+        // Not sure why you would do this but your wish is our command :)
         if ($limit === 0) return [];
 
         // UTF8::split errors when supplied an empty pattern in < PHP 5.4.13
@@ -187,27 +187,27 @@ 
             $limit = -1;
         }
 
-		// TODO: As per the above comments, all well and good but we are not
-		// using UTF8::split here, we are using preg_split???
+        // TODO: As per the above comments, all well and good but we are not
+        // using UTF8::split here, we are using preg_split???
 
-		// Build the expression
-		$expression = $this->regexDelimiter;
+        // Build the expression
+        $expression = $this->regexDelimiter;
 
-		if ($quote === true)
-		{
-			$expression .= preg_quote($pattern, $this->regexDelimiter);
-		}
-		else
-		{
-			$expression .= $pattern;
-		}
+        if ($quote === true)
+        {
+            $expression .= preg_quote($pattern, $this->regexDelimiter);
+        }
+        else
+        {
+            $expression .= $pattern;
+        }
 
-		$expression .= $this->regexDelimiter.'u';
+        $expression .= $this->regexDelimiter.'u';
 
-		// Split the string
+        // Split the string
         $array = preg_split($expression, $this->scalarString, $limit);
 
-		// Remove any remaining unsplit string.
+        // Remove any remaining unsplit string.
         if ($limit > 0 && count($array) === $limit) array_pop($array);
 
         return $this->newSelfs($array);

src/Methods/CaseManipulators.php

Indentation +34 added lines, -34 removed lines

@@ -16,46 +16,46 @@
 trait CaseManipulators
 {
     /**
-	 * Converts the first character of the string to lower case.
-	 *
-	 * @return static String with the first character of $str being lower case
-	 */
-	public function lowerCaseFirst()
-	{
-		$first = UTF8::substr($this->scalarString, 0, 1, $this->encoding);
+     * Converts the first character of the string to lower case.
+     *
+     * @return static String with the first character of $str being lower case
+     */
+    public function lowerCaseFirst()
+    {
+        $first = UTF8::substr($this->scalarString, 0, 1, $this->encoding);
 
-		$rest = UTF8::substr
-		(
-			$this->scalarString,
-			1,
-			$this->getLength() - 1,
-			$this->encoding
-		);
+        $rest = UTF8::substr
+        (
+            $this->scalarString,
+            1,
+            $this->getLength() - 1,
+            $this->encoding
+        );
 
-		return $this->newSelf(UTF8::strtolower($first, $this->encoding).$rest);
-	}
+        return $this->newSelf(UTF8::strtolower($first, $this->encoding).$rest);
+    }
 
-	/**
-	 * Converts the first character of the supplied string to upper case.
-	 *
-	 * @return static String with the first character of $str being upper case
-	 */
-	public function upperCaseFirst()
-	{
-		$first = UTF8::substr($this->scalarString, 0, 1, $this->encoding);
+    /**
+     * Converts the first character of the supplied string to upper case.
+     *
+     * @return static String with the first character of $str being upper case
+     */
+    public function upperCaseFirst()
+    {
+        $first = UTF8::substr($this->scalarString, 0, 1, $this->encoding);
 
-		$rest = UTF8::substr
-		(
-			$this->scalarString,
-			1,
-			$this->getLength() - 1,
-			$this->encoding
-		);
+        $rest = UTF8::substr
+        (
+            $this->scalarString,
+            1,
+            $this->getLength() - 1,
+            $this->encoding
+        );
 
-		return $this->newSelf(UTF8::strtoupper($first, $this->encoding).$rest);
-	}
+        return $this->newSelf(UTF8::strtoupper($first, $this->encoding).$rest);
+    }
 
-	/**
+    /**
      * Returns a case swapped version of the string.
      *
      * @return Stringy Object whose $str has each character's case swapped

src/Methods/Html.php

Indentation +68 added lines, -68 removed lines

@@ -16,55 +16,55 @@ 
 trait Html
 {
     /**
-	 * Convert all HTML entities to their applicable characters.
-	 *
-	 * @see http://php.net/manual/en/function.html-entity-decode.php
-	 *
-	 * @param  int|null $flags Optional flags
-	 *
-	 * @return static          String after being html decoded.
-	 */
-	public function htmlDecode($flags = ENT_COMPAT)
-	{
-		return $this->newSelf
-		(
-			UTF8::html_entity_decode
-			(
-				$this->scalarString,
-				$flags,
-				$this->encoding
-			)
-		);
-	}
+     * Convert all HTML entities to their applicable characters.
+     *
+     * @see http://php.net/manual/en/function.html-entity-decode.php
+     *
+     * @param  int|null $flags Optional flags
+     *
+     * @return static          String after being html decoded.
+     */
+    public function htmlDecode($flags = ENT_COMPAT)
+    {
+        return $this->newSelf
+        (
+            UTF8::html_entity_decode
+            (
+                $this->scalarString,
+                $flags,
+                $this->encoding
+            )
+        );
+    }
 
-	/**
-	 * Convert all applicable characters to HTML entities.
-	 *
-	 * @see http://php.net/manual/en/function.htmlentities.php
-	 *
-	 * @param  int|null $flags        Optional flags.
-	 *
-	 * @param  bool     $doubleEncode When double_encode is turned off PHP
-	 *                                will not encode existing html entities.
-	 *                                The default is to convert everything.
-	 *
-	 * @return static                 String after being html encoded.
-	 */
-	public function htmlEncode($flags = null, $doubleEncode = true)
-	{
-		if ($flags === null) $flags = ENT_QUOTES | ENT_SUBSTITUTE;
+    /**
+     * Convert all applicable characters to HTML entities.
+     *
+     * @see http://php.net/manual/en/function.htmlentities.php
+     *
+     * @param  int|null $flags        Optional flags.
+     *
+     * @param  bool     $doubleEncode When double_encode is turned off PHP
+     *                                will not encode existing html entities.
+     *                                The default is to convert everything.
+     *
+     * @return static                 String after being html encoded.
+     */
+    public function htmlEncode($flags = null, $doubleEncode = true)
+    {
+        if ($flags === null) $flags = ENT_QUOTES | ENT_SUBSTITUTE;
 
-		return $this->newSelf
-		(
-			UTF8::htmlentities
-			(
-				$this->scalarString,
-				$flags,
-				$this->encoding,
-				$doubleEncode
-			)
-		);
-	}
+        return $this->newSelf
+        (
+            UTF8::htmlentities
+            (
+                $this->scalarString,
+                $flags,
+                $this->encoding,
+                $doubleEncode
+            )
+        );
+    }
 
     /**
      * Sanitizes data so that Cross Site Scripting Hacks can be prevented.
@@ -87,25 +87,25 @@ 
      */
     public function htmlXssClean()
     {
-		static $antiXss = null;
+        static $antiXss = null;
 
-		if ($antiXss === null)
-		{
-			if (class_exists('\\voku\\helper\\AntiXSS'))
-			{
-				$antiXss = new \voku\helper\AntiXSS();
-			}
-			else
-			{
-				throw new \RuntimeException
-				(
-					"This method requires \voku\helper\AntiXSS. ".
-					"Install with: composer require voku/anti-xss"
-				);
-			}
-		}
+        if ($antiXss === null)
+        {
+            if (class_exists('\\voku\\helper\\AntiXSS'))
+            {
+                $antiXss = new \voku\helper\AntiXSS();
+            }
+            else
+            {
+                throw new \RuntimeException
+                (
+                    "This method requires \voku\helper\AntiXSS. ".
+                    "Install with: composer require voku/anti-xss"
+                );
+            }
+        }
 
-		return $this->newSelf($antiXss->xss_clean($this->scalarString));
+        return $this->newSelf($antiXss->xss_clean($this->scalarString));
     }
 
     /**
@@ -122,9 +122,9 @@ 
      */
     public function htmlStripTags($allowableTags = null)
     {
-		return $this->newSelf
-		(
-			UTF8::strip_tags($this->scalarString, $allowableTags)
-		);
+        return $this->newSelf
+        (
+            UTF8::strip_tags($this->scalarString, $allowableTags)
+        );
     }
 }