From 04b12c95007f0e22f8a2af30d21a38815d64c304 Mon Sep 17 00:00:00 2001 From: "Daniel St. Jules" Date: Mon, 9 Feb 2015 22:10:46 -0800 Subject: [PATCH] Document hasLowerCase and hasUpperCase --- README.md | 28 ++++++++++++++++++++++++ src/StaticStringy.php | 50 ++++++++++++++++++++++--------------------- src/Stringy.php | 44 ++++++++++++++++++------------------- 3 files changed, 76 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 2ae80f3..c66284e 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ PHP 5.3+ and HHVM. Inspired by underscore.string.js. * [ensureRight](#ensureright) * [first](#first) * [getEncoding](#getencoding) + * [hasLowerCase](#haslowercase) + * [hasUpperCase](#hasuppercase) * [humanize](#humanize) * [insert](#insert) * [isAlpha](#isalpha) @@ -405,6 +407,32 @@ Returns the encoding used by the Stringy object. S::create('fòô bàř', 'UTF-8')->getEncoding(); // 'UTF-8' ``` +#### hasLowerCase + +$stringy->hasLowerCase() + +S::hasLowerCase(string $str [, string $encoding ]) + +Returns true if the string contains a lower case char, false otherwise. + +```php +S::create('fòô bàř', 'UTF-8')->hasLowerCase(); +S::hasLowerCase('fòô bàř', 'UTF-8'); // true +``` + +#### hasUpperCase + +$stringy->hasUpperCase() + +S::hasUpperCase(string $str [, string $encoding ]) + +Returns true if the string contains an upper case char, false otherwise. + +```php +S::create('fòô bàř', 'UTF-8')->hasUpperCase(); +S::hasUpperCase('fòô bàř', 'UTF-8'); // false +``` + #### humanize $stringy->humanize() diff --git a/src/StaticStringy.php b/src/StaticStringy.php index 6e7be4d..78734db 100644 --- a/src/StaticStringy.php +++ b/src/StaticStringy.php @@ -686,6 +686,32 @@ class StaticStringy return (string) Stringy::create($str, $encoding)->removeRight($substring); } + /** + * Returns true if the string contains a lower case char, false + * otherwise. + * + * @param string $str String to check + * @param string $encoding The character encoding + * @return bool Whether or not $str contains a lower case character. + */ + public static function hasLowerCase($str, $encoding = null) + { + return Stringy::create($str, $encoding)->hasLowerCase(); + } + + /** + * Returns true if the string contains an upper case char, false + * otherwise. + * + * @param string $str String to check + * @param string $encoding The character encoding + * @return bool Whether or not $str contains an upper case character. + */ + public static function hasUpperCase($str, $encoding = null) + { + return Stringy::create($str, $encoding)->hasUpperCase(); + } + /** * Returns true if the string contains only alphabetic chars, false * otherwise. @@ -750,18 +776,6 @@ class StaticStringy return Stringy::create($str, $encoding)->isLowerCase(); } - /** - * Returns whether the given string has any lower case characters in it. - * - * @param string $str String to check - * @param string $encoding The character encoding - * @return bool Whether or not $str contains a lower case character. - */ - public static function hasLowerCase($str, $encoding = null) - { - return Stringy::create($str, $encoding)->hasLowerCase(); - } - /** * Returns true if the string is serialized, false otherwise. * @@ -787,18 +801,6 @@ class StaticStringy return Stringy::create($str, $encoding)->isUpperCase(); } - /** - * Returns whether the given string has any upper case characters in it. - * - * @param string $str String to check - * @param string $encoding The character encoding - * @return bool Whether or not $str contains an upper case character. - */ - public static function hasUpperCase($str, $encoding = null) - { - return Stringy::create($str, $encoding)->hasUpperCase(); - } - /** * Returns true if the string contains only hexadecimal chars, false * otherwise. diff --git a/src/Stringy.php b/src/Stringy.php index 22d9c5a..785145a 100644 --- a/src/Stringy.php +++ b/src/Stringy.php @@ -1297,6 +1297,28 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess return $match; } + /** + * Returns true if the string contains a lower case char, false + * otherwise. + * + * @return bool Whether or not the string contains a lower case character. + */ + public function hasLowerCase() + { + return $this->matchesPattern('.*[[:lower:]]'); + } + + /** + * Returns true if the string contains an upper case char, false + * otherwise. + * + * @return bool Whether or not the string contains an upper case character. + */ + public function hasUpperCase() + { + return $this->matchesPattern('.*[[:upper:]]'); + } + /** * Returns true if the string contains only alphabetic chars, false * otherwise. @@ -1364,17 +1386,6 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess return $this->matchesPattern('^[[:lower:]]*$'); } - /** - * Returns true if the string contains a lower case char, false - * otherwise. - * - * @return bool Whether or not the string contains a lower case character. - */ - public function hasLowerCase() - { - return $this->matchesPattern('.*[[:lower:]]'); - } - /** * Returns true if the string contains only lower case chars, false * otherwise. @@ -1386,17 +1397,6 @@ class Stringy implements \Countable, \IteratorAggregate, \ArrayAccess return $this->matchesPattern('^[[:upper:]]*$'); } - /** - * Returns true if the string contains an upper case char, false - * otherwise. - * - * @return bool Whether or not the string contains an upper case character. - */ - public function hasUpperCase() - { - return $this->matchesPattern('.*[[:upper:]]'); - } - /** * Returns true if the string is serialized, false otherwise. *