Recommend this page to a friend! |
Classes of Lars Moelleken | Stringy | README.md | Download |
|
Download
:accept: StringyA PHP string manipulation library with multibyte support. Compatible with PHP 7+ 100% compatible with the original "Stringy" library, but this fork is optimized for performance and is using PHP 7+ features.
Why?In part due to a lack of multibyte support (including UTF-8) across many of
PHP's standard string functions. But also to offer an OO wrapper around the
AlternativeIf you like a more Functional Way to edit strings, then you can take a look at voku/portable-utf8, also "voku/Stringy" used the functions from the "Portable UTF-8"-Class but in a more Object Oriented Way.
Installation via "composer require"
Installation via composer (manually)If you're using Composer to manage dependencies, you can include the following in your composer.json file:
Then, after running
Otherwise, you can simply require the file directly:
And in either case, I'd suggest using an alias.
OO and ChainingThe library offers OO method chaining, as seen below:
Implemented Interfaces
It implements the
Furthermore, the
PHP Class Call CreationAs of PHP 5.6+,
Class methodscreate(mixed $str [, $encoding ])Creates a Stringy object and assigns both str and encoding properties the supplied values. $str is cast to a string prior to assignment, and if $encoding is not specified, it defaults to mb_internal_encoding(). It then returns the initialized object. Throws an InvalidArgumentException if the first argument is an array or object without a __toString method.
If you need a collection of Stringy objects you can use the S::collection() method.
Instance MethodsStringy objects are immutable. All examples below make use of PHP 5.6 function importing, and PHP 5.4 short array syntax. They also assume the encoding returned by mb_internal_encoding() is UTF-8. For further details, see the documentation for the create method above. <table><tr><td><a href="#afterstring-string-static">after</a> </td><td><a href="#afterfirststring-separator-static">afterFirst</a> </td><td><a href="#afterfirstignorecasestring-separator-static">afterFirstIgnoreCase</a> </td><td><a href="#afterlaststring-separator-static">afterLast</a> </td></tr><tr><td><a href="#afterlastignorecasestring-separator-static">afterLastIgnoreCase</a> </td><td><a href="#appendstring-suffix-static">append</a> </td><td><a href="#appendpasswordint-length-static">appendPassword</a> </td><td><a href="#appendrandomstringint-length-string-possiblechars-static">appendRandomString</a> </td></tr><tr><td><a href="#appendstringycollectionstringystatic-suffix-static">appendStringy</a> </td><td><a href="#appenduniqueidentifierintstring-entropyextra-bool-md5-static">appendUniqueIdentifier</a> </td><td><a href="#atint-index-static">at</a> </td><td><a href="#base64decode-self">base64Decode</a> </td></tr><tr><td><a href="#base64encode-self">base64Encode</a> </td><td><a href="#bcryptarray-options-static">bcrypt</a> </td><td><a href="#beforestring-string-static">before</a> </td><td><a href="#beforefirststring-separator-static">beforeFirst</a> </td></tr><tr><td><a href="#beforefirstignorecasestring-separator-static">beforeFirstIgnoreCase</a> </td><td><a href="#beforelaststring-separator-static">beforeLast</a> </td><td><a href="#beforelastignorecasestring-separator-static">beforeLastIgnoreCase</a> </td><td><a href="#betweenstring-start-string-end-int-offset-static">between</a> </td></tr><tr><td><a href="#calluserfunctioncallable-function-mixed-parameter-static">callUserFunction</a> </td><td><a href="#camelize-static">camelize</a> </td><td><a href="#capitalizepersonalname-static">capitalizePersonalName</a> </td><td><a href="#chars-string">chars</a> </td></tr><tr><td><a href="#chunkint-length-static">chunk</a> </td><td><a href="#chunkcollectionint-length-collectionstringystatic">chunkCollection</a> </td><td><a href="#collapsewhitespace-static">collapseWhitespace</a> </td><td><a href="#containsstring-needle-bool-casesensitive-bool">contains</a> </td></tr><tr><td><a href="#containsallstring-needles-bool-casesensitive-bool">containsAll</a> </td><td><a href="#containsanystring-needles-bool-casesensitive-bool">containsAny</a> </td><td><a href="#count-int">count</a> </td><td><a href="#countsubstrstring-substring-bool-casesensitive-int">countSubstr</a> </td></tr><tr><td><a href="#crc32-int">crc32</a> </td><td><a href="#createmixed-str-string-encoding-static">create</a> </td><td><a href="#cryptstring-salt-static">crypt</a> </td><td><a href="#dasherize-static">dasherize</a> </td></tr><tr><td><a href="#decryptstring-password-static">decrypt</a> </td><td><a href="#delimitstring-delimiter-static">delimit</a> </td><td><a href="#encodestring-new_encoding-bool-auto_detect_encoding-static">encode</a> </td><td><a href="#encryptstring-password-static">encrypt</a> </td></tr><tr><td><a href="#endswithstring-substring-bool-casesensitive-bool">endsWith</a> </td><td><a href="#endswithanystring-substrings-bool-casesensitive-bool">endsWithAny</a> </td><td><a href="#ensureleftstring-substring-static">ensureLeft</a> </td><td><a href="#ensurerightstring-substring-static">ensureRight</a> </td></tr><tr><td><a href="#escape-static">escape</a> </td><td><a href="#explodestring-delimiter-int-limit-arrayintstatic">explode</a> </td><td><a href="#explodecollectionstring-delimiter-int-limit-collectionstringystatic">explodeCollection</a> </td><td><a href="#extracttextstring-search-intnull-length-string-replacerforskippedtext-static">extractText</a> </td></tr><tr><td><a href="#firstint-n-static">first</a> </td><td><a href="#formatmixed-args-static">format</a> </td><td><a href="#getencoding-string">getEncoding</a> </td><td><a href="#getiterator-arrayiterator">getIterator</a> </td></tr><tr><td><a href="#hardwrapint-width-string-break-static">hardWrap</a> </td><td><a href="#haslowercase-bool">hasLowerCase</a> </td><td><a href="#hasuppercase-bool">hasUpperCase</a> </td><td><a href="#hashstring-algorithm-static">hash</a> </td></tr><tr><td><a href="#hexdecode-static">hexDecode</a> </td><td><a href="#hexencode-static">hexEncode</a> </td><td><a href="#htmldecodeint-flags-static">htmlDecode</a> </td><td><a href="#htmlencodeint-flags-static">htmlEncode</a> </td></tr><tr><td><a href="#humanize-static">humanize</a> </td><td><a href="#instring-str-bool-casesensitive-bool">in</a> </td><td><a href="#indexofstring-needle-int-offset-falseint">indexOf</a> </td><td><a href="#indexofignorecasestring-needle-int-offset-falseint">indexOfIgnoreCase</a> </td></tr><tr><td><a href="#indexoflaststring-needle-int-offset-falseint">indexOfLast</a> </td><td><a href="#indexoflastignorecasestring-needle-int-offset-falseint">indexOfLastIgnoreCase</a> </td><td><a href="#insertstring-substring-int-index-static">insert</a> </td><td><a href="#isstring-pattern-bool">is</a> </td></tr><tr><td><a href="#isalpha-bool">isAlpha</a> </td><td><a href="#isalphanumeric-bool">isAlphanumeric</a> </td><td><a href="#isbase64bool-emptystringisvalid-bool">isBase64</a> </td><td><a href="#isblank-bool">isBlank</a> </td></tr><tr><td><a href="#isemailbool-useexampledomaincheck-bool-usetypoindomaincheck-bool-usetemporarydomaincheck-bool-usednscheck-bool">isEmail</a> </td><td><a href="#isempty-bool">isEmpty</a> </td><td><a href="#isequalsstringstringy-str-bool">isEquals</a> </td><td><a href="#isequalscaseinsensitivefloatintstringstringy-str-bool">isEqualsCaseInsensitive</a> </td></tr><tr><td><a href="#isequalscasesensitivefloatintstringstringy-str-bool">isEqualsCaseSensitive</a> </td><td><a href="#ishexadecimal-bool">isHexadecimal</a> </td><td><a href="#ishtml-bool">isHtml</a> </td><td><a href="#isjsonbool-onlyarrayorobjectresultsarevalid-bool">isJson</a> </td></tr><tr><td><a href="#islowercase-bool">isLowerCase</a> </td><td><a href="#isnotempty-bool">isNotEmpty</a> </td><td><a href="#isnumeric-bool">isNumeric</a> </td><td><a href="#isprintable-bool">isPrintable</a> </td></tr><tr><td><a href="#ispunctuation-bool">isPunctuation</a> </td><td><a href="#isserialized-bool">isSerialized</a> </td><td><a href="#issimilarstring-str-float-minpercentforsimilarity-bool">isSimilar</a> </td><td><a href="#isuppercase-bool">isUpperCase</a> </td></tr><tr><td><a href="#iswhitespace-bool">isWhitespace</a> </td><td><a href="#jsonserialize-string">jsonSerialize</a> </td><td><a href="#kebabcase-static">kebabCase</a> </td><td><a href="#lastint-n-static">last</a> </td></tr><tr><td><a href="#lastsubstringofstring-needle-bool-beforeneedle-static">lastSubstringOf</a> </td><td><a href="#lastsubstringofignorecasestring-needle-bool-beforeneedle-static">lastSubstringOfIgnoreCase</a> </td><td><a href="#length-int">length</a> </td><td><a href="#linewrapint-limit-string-break-bool-add_final_break-stringnull-delimiter-static">lineWrap</a> </td></tr><tr><td><a href="#linewrapafterwordint-limit-string-break-bool-add_final_break-stringnull-delimiter-static">lineWrapAfterWord</a> </td><td><a href="#lines-static">lines</a> </td><td><a href="#linescollection-collectionstringystatic">linesCollection</a> </td><td><a href="#longestcommonprefixstring-otherstr-static">longestCommonPrefix</a> </td></tr><tr><td><a href="#longestcommonsubstringstring-otherstr-static">longestCommonSubstring</a> </td><td><a href="#longestcommonsuffixstring-otherstr-static">longestCommonSuffix</a> </td><td><a href="#lowercasefirst-static">lowerCaseFirst</a> </td><td><a href="#matchcaseinsensitivestringstringy-str-bool">matchCaseInsensitive</a> </td></tr><tr><td><a href="#matchcasesensitivestringstringy-str-bool">matchCaseSensitive</a> </td><td><a href="#md5-static">md5</a> </td><td><a href="#newlinetohtmlbreak-static">newLineToHtmlBreak</a> </td><td><a href="#nthint-step-int-offset-static">nth</a> </td></tr><tr><td><a href="#offsetexistsint-offset-bool">offsetExists</a> </td><td><a href="#offsetgetint-offset-string">offsetGet</a> </td><td><a href="#offsetsetint-offset-mixed-value-void">offsetSet</a> </td><td><a href="#offsetunsetint-offset-void">offsetUnset</a> </td></tr><tr><td><a href="#padint-length-string-padstr-string-padtype-static">pad</a> </td><td><a href="#padbothint-length-string-padstr-static">padBoth</a> </td><td><a href="#padleftint-length-string-padstr-static">padLeft</a> </td><td><a href="#padrightint-length-string-padstr-static">padRight</a> </td></tr><tr><td><a href="#pascalcase-static">pascalCase</a> </td><td><a href="#prependstring-prefix-static">prepend</a> </td><td><a href="#prependstringycollectionstringystatic-prefix-static">prependStringy</a> </td><td><a href="#regexreplacestring-pattern-string-replacement-string-options-string-delimiter-static">regexReplace</a> </td></tr><tr><td><a href="#removehtmlstring-allowabletags-static">removeHtml</a> </td><td><a href="#removehtmlbreakstring-replacement-static">removeHtmlBreak</a> </td><td><a href="#removeleftstring-substring-static">removeLeft</a> </td><td><a href="#removerightstring-substring-static">removeRight</a> </td></tr><tr><td><a href="#removexss-static">removeXss</a> </td><td><a href="#repeatint-multiplier-static">repeat</a> </td><td><a href="#replacestring-search-string-replacement-bool-casesensitive-static">replace</a> </td><td><a href="#replaceallstring-search-stringstring-replacement-bool-casesensitive-static">replaceAll</a> </td></tr><tr><td><a href="#replacebeginningstring-search-string-replacement-static">replaceBeginning</a> </td><td><a href="#replaceendingstring-search-string-replacement-static">replaceEnding</a> </td><td><a href="#replacefirststring-search-string-replacement-static">replaceFirst</a> </td><td><a href="#replacelaststring-search-string-replacement-static">replaceLast</a> </td></tr><tr><td><a href="#reverse-static">reverse</a> </td><td><a href="#safetruncateint-length-string-substring-bool-ignoredonotsplitwordsforoneword-static">safeTruncate</a> </td><td><a href="#setinternalencodingstring-new_encoding-static">setInternalEncoding</a> </td><td><a href="#sha1-static">sha1</a> </td></tr><tr><td><a href="#sha256-static">sha256</a> </td><td><a href="#sha512-static">sha512</a> </td><td><a href="#shortenafterwordint-length-string-straddon-static">shortenAfterWord</a> </td><td><a href="#shuffle-static">shuffle</a> </td></tr><tr><td><a href="#similaritystring-str-float">similarity</a> </td><td><a href="#sliceint-start-int-end-static">slice</a> </td><td><a href="#slugifystring-separator-string-language-string-replacements-bool-replace_extra_symbols-bool-use_str_to_lower-bool-use_transliterate-static">slugify</a> </td><td><a href="#snakecase-static">snakeCase</a> </td></tr><tr><td><a href="#snakeize-static">snakeize</a> </td><td><a href="#softwrapint-width-string-break-static">softWrap</a> </td><td><a href="#splitstring-pattern-int-limit-static">split</a> </td><td><a href="#splitcollectionstring-pattern-int-limit-collectionstringystatic">splitCollection</a> </td></tr><tr><td><a href="#startswithstring-substring-bool-casesensitive-bool">startsWith</a> </td><td><a href="#startswithanystring-substrings-bool-casesensitive-bool">startsWithAny</a> </td><td><a href="#stripstringstring-search-static">strip</a> </td><td><a href="#stripwhitespace-static">stripWhitespace</a> </td></tr><tr><td><a href="#stripecssmediaqueries-static">stripeCssMediaQueries</a> </td><td><a href="#stripeemptyhtmltags-static">stripeEmptyHtmlTags</a> </td><td><a href="#studlycase-static">studlyCase</a> </td><td><a href="#substrint-start-int-length-static">substr</a> </td></tr><tr><td><a href="#substringint-start-int-length-static">substring</a> </td><td><a href="#substringofstring-needle-bool-beforeneedle-static">substringOf</a> </td><td><a href="#substringofignorecasestring-needle-bool-beforeneedle-static">substringOfIgnoreCase</a> </td><td><a href="#surroundstring-substring-static">surround</a> </td></tr><tr><td><a href="#swapcase-static">swapCase</a> </td><td><a href="#tidy-static">tidy</a> </td><td><a href="#titleizearraystringnull-ignore-stringnull-word_define_chars-stringnull-language-static">titleize</a> </td><td><a href="#titleizeforhumansstring-ignore-static">titleizeForHumans</a> </td></tr><tr><td><a href="#toasciistring-language-bool-removeunsupported-static">toAscii</a> </td><td><a href="#toboolean-bool">toBoolean</a> </td><td><a href="#tolowercasebool-trytokeepstringlength-stringnull-lang-static">toLowerCase</a> </td><td><a href="#tospacesint-tablength-static">toSpaces</a> </td></tr><tr><td><a href="#tostring-string">toString</a> </td><td><a href="#totabsint-tablength-static">toTabs</a> </td><td><a href="#totitlecase-static">toTitleCase</a> </td><td><a href="#totransliteratebool-strict-string-unknown-static">toTransliterate</a> </td></tr><tr><td><a href="#touppercasebool-trytokeepstringlength-stringnull-lang-static">toUpperCase</a> </td><td><a href="#trimstring-chars-static">trim</a> </td><td><a href="#trimleftstring-chars-static">trimLeft</a> </td><td><a href="#trimrightstring-chars-static">trimRight</a> </td></tr><tr><td><a href="#truncateint-length-string-substring-static">truncate</a> </td><td><a href="#underscored-static">underscored</a> </td><td><a href="#uppercamelize-static">upperCamelize</a> </td><td><a href="#uppercasefirst-static">upperCaseFirst</a> </td></tr><tr><td><a href="#urldecode-static">urlDecode</a> </td><td><a href="#urldecodemulti-static">urlDecodeMulti</a> </td><td><a href="#urldecoderaw-static">urlDecodeRaw</a> </td><td><a href="#urldecoderawmulti-static">urlDecodeRawMulti</a> </td></tr><tr><td><a href="#urlencode-static">urlEncode</a> </td><td><a href="#urlencoderaw-static">urlEncodeRaw</a> </td><td><a href="#urlifystring-separator-string-language-string-replacements-bool-strtolower-static">urlify</a> </td><td><a href="#utf8ify-static">utf8ify</a> </td></tr><tr><td><a href="#wordsstring-char_list-bool-remove_empty_values-intnull-remove_short_values-static">words</a> </td><td><a href="#wordscollectionstring-char_list-bool-remove_empty_values-intnull-remove_short_values-collectionstringystatic">wordsCollection</a> </td><td><a href="#wrapstring-substring-static">wrap</a> </td></tr></table> after(string $string): static<a href="#class-methods">?</a> Return part of the string occurring after a specific string. EXAMPLE: <code> s('?? ?')->after('?'); // ' ?' </code> Parameters:
- Return:
- afterFirst(string $separator): static<a href="#class-methods">?</a> Gets the substring after the first occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</b></b>')->afterFirst('b'); // '></b>' </code> Parameters:
- Return:
- afterFirstIgnoreCase(string $separator): static<a href="#class-methods">?</a> Gets the substring after the first occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</B></B>')->afterFirstIgnoreCase('b'); // '></B>' </code> Parameters:
- Return:
- afterLast(string $separator): static<a href="#class-methods">?</a> Gets the substring after the last occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</b></b>')->afterLast('b'); // '>' </code> Parameters:
- Return:
- afterLastIgnoreCase(string $separator): static<a href="#class-methods">?</a> Gets the substring after the last occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</B></B>')->afterLastIgnoreCase('b'); // '>' </code> Parameters:
- Return:
- append(string $suffix): static<a href="#class-methods">?</a> Returns a new string with $suffix appended. EXAMPLE: <code> s('fòô')->append('bà?'); // 'fòôbà?' </code> Parameters:
- Return:
- appendPassword(int $length): static<a href="#class-methods">?</a> Append an password (limited to chars that are good readable). EXAMPLE: <code> s('')->appendPassword(8); // e.g.: '89bcdfgh' </code> Parameters:
- Return:
- appendRandomString(int $length, string $possibleChars): static<a href="#class-methods">?</a> Append an random string. EXAMPLE: <code> s('')->appendUniqueIdentifier(5, 'ABCDEFGHI'); // e.g.: 'CDEHI' </code> Parameters:
- Return:
- appendStringy(\CollectionStringy|static $suffix): static<a href="#class-methods">?</a> Returns a new string with $suffix appended. EXAMPLE: <code> </code> Parameters:
- Return:
- appendUniqueIdentifier(int|string $entropyExtra, bool $md5): static<a href="#class-methods">?</a> Append an unique identifier. EXAMPLE: <code> s('')->appendUniqueIdentifier(); // e.g.: '1f3870be274f6c49b3e31a0c6728957f' </code> Parameters:
- Return:
- at(int $index): static<a href="#class-methods">?</a> Returns the character at $index, with indexes starting at 0. EXAMPLE: <code> s('fòôbà?')->at(3); // 'b' </code> Parameters:
- Return:
- base64Decode(): self<a href="#class-methods">?</a> Decode the base64 encoded string. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- base64Encode(): self<a href="#class-methods">?</a> Encode the string to base64. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- bcrypt(array $options): static<a href="#class-methods">?</a> Creates a hash from the string using the CRYPT_BLOWFISH algorithm. WARNING: Using this algorithm, will result in the
EXAMPLE: <code> </code> Parameters:
- Return:
- before(string $string): static<a href="#class-methods">?</a> Return part of the string occurring before a specific string. EXAMPLE: <code> </code> Parameters:
- Return:
- beforeFirst(string $separator): static<a href="#class-methods">?</a> Gets the substring before the first occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</b></b>')->beforeFirst('b'); // '</' </code> Parameters:
- Return:
- beforeFirstIgnoreCase(string $separator): static<a href="#class-methods">?</a> Gets the substring before the first occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</B></B>')->beforeFirstIgnoreCase('b'); // '</' </code> Parameters:
- Return:
- beforeLast(string $separator): static<a href="#class-methods">?</a> Gets the substring before the last occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</b></b>')->beforeLast('b'); // '</b></' </code> Parameters:
- Return:
- beforeLastIgnoreCase(string $separator): static<a href="#class-methods">?</a> Gets the substring before the last occurrence of a separator. If no match is found returns new empty Stringy object. EXAMPLE: <code> s('</B></B>')->beforeLastIgnoreCase('b'); // '</B></' </code> Parameters:
- Return:
- between(string $start, string $end, int $offset): static<a href="#class-methods">?</a> Returns the substring between $start and $end, if found, or an empty string. An optional offset may be supplied from which to begin the search for the start string. EXAMPLE: <code> s('{foo} and {bar}')->between('{', '}'); // 'foo' </code> Parameters:
- Return:
- callUserFunction(callable $function, mixed $parameter): static<a href="#class-methods">?</a> Call a user function. EXAMPLE: <code> S::create('foo bar lall')->callUserFunction(static function ($str) {
})->toString(); // "foo bar?" </code> Parameters:
- Return:
- camelize(): static<a href="#class-methods">?</a> Returns a camelCase version of the string. Trims surrounding spaces, capitalizes letters following digits, spaces, dashes and underscores, and removes spaces, dashes, as well as underscores. EXAMPLE: <code> s('Camel-Case')->camelize(); // 'camelCase' </code> Parameters: __nothing__ Return:
- capitalizePersonalName(): static<a href="#class-methods">?</a> Returns the string with the first letter of each word capitalized, except for when the word is a name which shouldn't be capitalized. EXAMPLE: <code> s('jaap de hoop scheffer')->capitalizePersonName(); // 'Jaap de Hoop Scheffer' </code> Parameters: __nothing__ Return:
- chars(): string[]<a href="#class-methods">?</a> Returns an array consisting of the characters in the string. EXAMPLE: <code> s('fòôbà?')->chars(); // ['f', 'ò', 'ô', 'b', 'à', '?'] </code> Parameters: __nothing__ Return:
- chunk(int $length): static[]<a href="#class-methods">?</a> Splits the string into chunks of Stringy objects. EXAMPLE: <code> s('foobar')->chunk(3); // ['foo', 'bar'] </code> Parameters:
- Return:
- chunkCollection(int $length): \CollectionStringy|static[]<a href="#class-methods">?</a> Splits the string into chunks of Stringy objects collection. EXAMPLE: <code> </code> Parameters:
- Return:
- collapseWhitespace(): static<a href="#class-methods">?</a> Trims the string and replaces consecutive whitespace characters with a single space. This includes tabs and newline characters, as well as multibyte whitespace such as the thin space and ideographic space. EXAMPLE: <code> s(' ? ?????????? ')->collapseWhitespace(); // '? ??????????' </code> Parameters: __nothing__ Return:
- contains(string $needle, bool $caseSensitive): bool<a href="#class-methods">?</a> 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. EXAMPLE: <code> s('? ?????????? ????')->contains('??????????'); // true </code> Parameters:
- Return:
- containsAll(string[] $needles, bool $caseSensitive): bool<a href="#class-methods">?</a> 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. EXAMPLE: <code> s('foo & bar')->containsAll(['foo', 'bar']); // true </code> Parameters:
- Return:
- containsAny(string[] $needles, bool $caseSensitive): bool<a href="#class-methods">?</a> 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. EXAMPLE: <code> s('str contains foo')->containsAny(['foo', 'bar']); // true </code> Parameters:
- Return:
- count(): int<a href="#class-methods">?</a> Returns the length of the string, implementing the countable interface. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- countSubstr(string $substring, bool $caseSensitive): int<a href="#class-methods">?</a> Returns the number of occurrences of $substring in the given string. By default, the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false. EXAMPLE: <code> s('? ?????????? ????')->countSubstr('?'); // 2 </code> Parameters:
- Return:
- crc32(): int<a href="#class-methods">?</a> Calculates the crc32 polynomial of a string. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- create(mixed $str, string $encoding): static<a href="#class-methods">?</a> Creates a Stringy object and assigns both str and encoding properties the supplied values. $str is cast to a string prior to assignment, and if $encoding is not specified, it defaults to mb_internal_encoding(). It then returns the initialized object. Throws an InvalidArgumentException if the first argument is an array or object without a __toString method. Parameters:
- Return:
- crypt(string $salt): static<a href="#class-methods">?</a> One-way string encryption (hashing). Hash the string using the standard Unix DES-based algorithm or an alternative algorithm that may be available on the system. PS: if you need encrypt / decrypt, please use
EXAMPLE: <code> </code> Parameters:
- Return:
- dasherize(): static<a href="#class-methods">?</a> Returns a lowercase and trimmed string separated by dashes. Dashes are inserted before uppercase characters (with the exception of the first character of the string), and in place of spaces as well as underscores. EXAMPLE: <code> s('fooBar')->dasherize(); // 'foo-bar' </code> Parameters: __nothing__ Return:
- decrypt(string $password): static<a href="#class-methods">?</a> Decrypt the string. EXAMPLE: <code> </code> Parameters:
- Return:
- delimit(string $delimiter): static<a href="#class-methods">?</a> Returns a lowercase and trimmed string separated by the given delimiter. Delimiters are inserted before uppercase characters (with the exception of the first character of the string), and in place of spaces, dashes, and underscores. Alpha delimiters are not converted to lowercase. EXAMPLE: <code> s('fooBar')->delimit('::'); // 'foo::bar' </code> Parameters:
- Return:
- encode(string $new_encoding, bool $auto_detect_encoding): static<a href="#class-methods">?</a> Encode the given string into the given $encoding + set the internal character encoding. EXAMPLE: <code> </code> Parameters:
- Return:
- encrypt(string $password): static<a href="#class-methods">?</a> Encrypt the string. EXAMPLE: <code> </code> Parameters:
- Return:
- endsWith(string $substring, bool $caseSensitive): bool<a href="#class-methods">?</a> Returns true if the string ends with $substring, false otherwise. By default, the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false. EXAMPLE: <code> s('fòôbà?')->endsWith('bà?', true); // true </code> Parameters:
- Return:
- endsWithAny(string[] $substrings, bool $caseSensitive): bool<a href="#class-methods">?</a> Returns true if the string ends with any of $substrings, false otherwise. By default, the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false. EXAMPLE: <code> s('fòôbà?')->endsWithAny(['bà?', 'baz'], true); // true </code> Parameters:
- Return:
- ensureLeft(string $substring): static<a href="#class-methods">?</a> Ensures that the string begins with $substring. If it doesn't, it's prepended. EXAMPLE: <code> s('foobar')->ensureLeft('http://'); // 'http://foobar' </code> Parameters:
- Return:
- ensureRight(string $substring): static<a href="#class-methods">?</a> Ensures that the string ends with $substring. If it doesn't, it's appended. EXAMPLE: <code> s('foobar')->ensureRight('.com'); // 'foobar.com' </code> Parameters:
- Return:
- escape(): static<a href="#class-methods">?</a> Create a escape html version of the string via "htmlspecialchars()". EXAMPLE: <code> s('<?? onerror="alert(xss)">')->escape(); // '<?? onerror="alert(xss)">' </code> Parameters: __nothing__ Return:
- explode(string $delimiter, int $limit): array<int,static><a href="#class-methods">?</a> Split a string by a string. EXAMPLE: <code> </code> Parameters:
-
Return:
- explodeCollection(string $delimiter, int $limit): \CollectionStringy|static[]<a href="#class-methods">?</a> Split a string by a string. EXAMPLE: <code> </code> Parameters:
-
Return:
- extractText(string $search, int|null $length, string $replacerForSkippedText): static<a href="#class-methods">?</a> Create an extract from a sentence, so if the search-string was found, it try to centered in the output. EXAMPLE: <code> $sentence = 'This is only a Fork of Stringy, take a look at the new features.'; s($sentence)->extractText('Stringy'); // '...Fork of Stringy...' </code> Parameters:
- Return:
- first(int $n): static<a href="#class-methods">?</a> Returns the first $n characters of the string. EXAMPLE: <code> s('fòôbà?')->first(3); // 'fòô' </code> Parameters:
- Return:
- format(mixed $args): static<a href="#class-methods">?</a> Return a formatted string via sprintf + named parameters via array syntax. <p> <br> It will use "sprintf()" so you can use e.g.: <br> <br><pre>s('There are %d monkeys in the %s')->format(5, 'tree');</pre> <br> <br><pre>s('There are %2$d monkeys in the %1$s')->format('tree', 5);</pre> <br> <br> But you can also use named parameter via array syntax e.g.: <br> <br><pre>s('There are %:count monkeys in the %:location')->format(['count' => 5, 'location' => 'tree');</pre> </p> EXAMPLE: <code> $input = 'one: %2$d, %1$s: 2, %:text_three: %3$d'; s($input)->format(['text_three' => '%4$s'], 'two', 1, 3, 'three'); // 'One: 1, two: 2, three: 3' </code> Parameters:
- Return: - `static <p>A Stringy object produced according to the formatting string format.</p>` getEncoding(): string<a href="#class-methods">?</a> Returns the encoding used by the Stringy object. EXAMPLE: <code> s('fòôbà?', 'UTF-8')->getEncoding(); // 'UTF-8' </code> Parameters: __nothing__ Return:
- getIterator(): \ArrayIterator<a href="#class-methods">?</a> Returns a new ArrayIterator, thus implementing the IteratorAggregate interface. The ArrayIterator's constructor is passed an array of chars in the multibyte string. This enables the use of foreach with instances of Stringy\Stringy. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- hardWrap(int $width, string $break): static<a href="#class-methods">?</a> Wrap the string after an exact number of characters. EXAMPLE: <code> </code> Parameters:
- Return:
- hasLowerCase(): bool<a href="#class-methods">?</a> Returns true if the string contains a lower case char, false otherwise EXAMPLE: <code> s('fòôbà?')->hasLowerCase(); // true </code> Parameters: __nothing__ Return:
- hasUpperCase(): bool<a href="#class-methods">?</a> Returns true if the string contains an upper case char, false otherwise. EXAMPLE: <code> s('fòôbà?')->hasUpperCase(); // false </code> Parameters: __nothing__ Return:
- hash(string $algorithm): static<a href="#class-methods">?</a> Generate a hash value (message digest). EXAMPLE: <code> </code> Parameters:
- Return:
- hexDecode(): static<a href="#class-methods">?</a> Decode the string from hex. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- hexEncode(): static<a href="#class-methods">?</a> Encode string to hex. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- htmlDecode(int $flags): static<a href="#class-methods">?</a> Convert all HTML entities to their applicable characters. EXAMPLE: <code> s('&')->htmlDecode(); // '&' </code> Parameters: - `int $flags [optional] <p> A bitmask of one or more of the following flags, which specify how to handle quotes and which document type to use. The default is ENT_COMPAT. <table> Available <i>flags</i> constants <tr valign="top"> <td>Constant Name</td> <td>Description</td> </tr> <tr valign="top"> <td><b>ENT_COMPAT</b></td> <td>Will convert double-quotes and leave single-quotes alone.</td> </tr> <tr valign="top"> <td><b>ENT_QUOTES</b></td> <td>Will convert both double and single quotes.</td> </tr> <tr valign="top"> <td><b>ENT_NOQUOTES</b></td> <td>Will leave both double and single quotes unconverted.</td> </tr> <tr valign="top"> <td><b>ENT_HTML401</b></td> <td> Handle code as HTML 4.01. </td> </tr> <tr valign="top"> <td><b>ENT_XML1</b></td> <td> Handle code as XML 1. </td> </tr> <tr valign="top"> <td><b>ENT_XHTML</b></td> <td> Handle code as XHTML. </td> </tr> <tr valign="top"> <td><b>ENT_HTML5</b></td> <td> Handle code as HTML 5. </td> </tr> </table> </p>` Return:
- htmlEncode(int $flags): static<a href="#class-methods">?</a> Convert all applicable characters to HTML entities. EXAMPLE: <code> s('&')->htmlEncode(); // '&' </code> Parameters: - `int $flags [optional] <p> A bitmask of one or more of the following flags, which specify how to handle quotes and which document type to use. The default is ENT_COMPAT. <table> Available <i>flags</i> constants <tr valign="top"> <td>Constant Name</td> <td>Description</td> </tr> <tr valign="top"> <td><b>ENT_COMPAT</b></td> <td>Will convert double-quotes and leave single-quotes alone.</td> </tr> <tr valign="top"> <td><b>ENT_QUOTES</b></td> <td>Will convert both double and single quotes.</td> </tr> <tr valign="top"> <td><b>ENT_NOQUOTES</b></td> <td>Will leave both double and single quotes unconverted.</td> </tr> <tr valign="top"> <td><b>ENT_HTML401</b></td> <td> Handle code as HTML 4.01. </td> </tr> <tr valign="top"> <td><b>ENT_XML1</b></td> <td> Handle code as XML 1. </td> </tr> <tr valign="top"> <td><b>ENT_XHTML</b></td> <td> Handle code as XHTML. </td> </tr> <tr valign="top"> <td><b>ENT_HTML5</b></td> <td> Handle code as HTML 5. </td> </tr> </table> </p>` Return:
- humanize(): static<a href="#class-methods">?</a> Capitalizes the first word of the string, replaces underscores with spaces, and strips '_id'. EXAMPLE: <code> s('author_id')->humanize(); // 'Author' </code> Parameters: __nothing__ Return:
- in(string $str, bool $caseSensitive): bool<a href="#class-methods">?</a> Determine if the current string exists in another string. By default, the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false. EXAMPLE: <code> </code> Parameters:
- Return:
- indexOf(string $needle, int $offset): false|int<a href="#class-methods">?</a> Returns the index of the first occurrence of $needle in the string, and false if not found. Accepts an optional offset from which to begin the search. EXAMPLE: <code> s('string')->indexOf('ing'); // 3 </code> Parameters:
- Return:
- indexOfIgnoreCase(string $needle, int $offset): false|int<a href="#class-methods">?</a> Returns the index of the first occurrence of $needle in the string, and false if not found. Accepts an optional offset from which to begin the search. EXAMPLE: <code> s('string')->indexOfIgnoreCase('ING'); // 3 </code> Parameters:
- Return:
- indexOfLast(string $needle, int $offset): false|int<a href="#class-methods">?</a> Returns the index of the last occurrence of $needle in the string, and false if not found. Accepts an optional offset from which to begin the search. Offsets may be negative to count from the last character in the string. EXAMPLE: <code> s('foobarfoo')->indexOfLast('foo'); // 10 </code> Parameters:
- Return:
- indexOfLastIgnoreCase(string $needle, int $offset): false|int<a href="#class-methods">?</a> Returns the index of the last occurrence of $needle in the string, and false if not found. Accepts an optional offset from which to begin the search. Offsets may be negative to count from the last character in the string. EXAMPLE: <code> s('fooBarFoo')->indexOfLastIgnoreCase('foo'); // 10 </code> Parameters:
- Return:
- insert(string $substring, int $index): static<a href="#class-methods">?</a> Inserts $substring into the string at the $index provided. EXAMPLE: <code> s('fòôb?')->insert('à', 4); // 'fòôbà?' </code> Parameters:
- Return:
- is(string $pattern): bool<a href="#class-methods">?</a> Returns true if the string contains the $pattern, otherwise false. WARNING: Asterisks ("") are translated into (".") zero-or-more regular expression wildcards. EXAMPLE: <code> s('Foo\\Bar\\Lall')->is('\\Bar\\'); // true </code> Parameters:
- Return:
- isAlpha(): bool<a href="#class-methods">?</a> Returns true if the string contains only alphabetic chars, false otherwise. EXAMPLE: <code> s('???')->isAlpha(); // true </code> Parameters: __nothing__ Return:
- isAlphanumeric(): bool<a href="#class-methods">?</a> Returns true if the string contains only alphabetic and numeric chars, false otherwise. EXAMPLE: <code> s('??????1')->isAlphanumeric(); // true </code> Parameters: __nothing__ Return:
- isBase64(bool $emptyStringIsValid): bool<a href="#class-methods">?</a> Returns true if the string is base64 encoded, false otherwise. EXAMPLE: <code> s('Zm9vYmFy')->isBase64(); // true </code> Parameters:
- Return:
- isBlank(): bool<a href="#class-methods">?</a> Returns true if the string contains only whitespace chars, false otherwise. EXAMPLE: <code> s("\n\t \v\f")->isBlank(); // true </code> Parameters: __nothing__ Return:
- isEmail(bool $useExampleDomainCheck, bool $useTypoInDomainCheck, bool $useTemporaryDomainCheck, bool $useDnsCheck): bool<a href="#class-methods">?</a> Returns true if the string contains a valid E-Mail address, false otherwise. EXAMPLE: <code> s('lars@moelleken.org')->isEmail(); // true </code> Parameters:
- Return:
- isEmpty(): bool<a href="#class-methods">?</a> Determine whether the string is considered to be empty. A variable is considered empty if it does not exist or if its value equals FALSE. EXAMPLE: <code> s('')->isEmpty(); // true </code> Parameters: __nothing__ Return:
- isEquals(string|\Stringy $str): bool<a href="#class-methods">?</a> Determine whether the string is equals to $str. Alias for isEqualsCaseSensitive() EXAMPLE: <code> s('foo')->isEquals('foo'); // true </code> Parameters:
- Return:
- isEqualsCaseInsensitive(float|int|string|\Stringy $str): bool<a href="#class-methods">?</a> Determine whether the string is equals to $str. EXAMPLE: <code> </code> Parameters:
- Return:
- isEqualsCaseSensitive(float|int|string|\Stringy $str): bool<a href="#class-methods">?</a> Determine whether the string is equals to $str. EXAMPLE: <code> </code> Parameters:
- Return:
- isHexadecimal(): bool<a href="#class-methods">?</a> Returns true if the string contains only hexadecimal chars, false otherwise. EXAMPLE: <code> s('A102F')->isHexadecimal(); // true </code> Parameters: __nothing__ Return:
- isHtml(): bool<a href="#class-methods">?</a> Returns true if the string contains HTML-Tags, false otherwise. EXAMPLE: <code> s('<h1>foo</h1>')->isHtml(); // true </code> Parameters: __nothing__ Return:
- isJson(bool $onlyArrayOrObjectResultsAreValid): bool<a href="#class-methods">?</a> Returns true if the string is JSON, false otherwise. Unlike json_decode in PHP 5.x, this method is consistent with PHP 7 and other JSON parsers, in that an empty string is not considered valid JSON. EXAMPLE: <code> s('{"foo":"bar"}')->isJson(); // true </code> Parameters:
- Return:
- isLowerCase(): bool<a href="#class-methods">?</a> Returns true if the string contains only lower case chars, false otherwise. EXAMPLE: <code> s('fòôbà?')->isLowerCase(); // true </code> Parameters: __nothing__ Return:
- isNotEmpty(): bool<a href="#class-methods">?</a> Determine whether the string is considered to be NOT empty. A variable is considered NOT empty if it does exist or if its value equals TRUE. EXAMPLE: <code> s('')->isNotEmpty(); // false </code> Parameters: __nothing__ Return:
- isNumeric(): bool<a href="#class-methods">?</a> Determine if the string is composed of numeric characters. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- isPrintable(): bool<a href="#class-methods">?</a> Determine if the string is composed of printable (non-invisible) characters. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- isPunctuation(): bool<a href="#class-methods">?</a> Determine if the string is composed of punctuation characters. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- isSerialized(): bool<a href="#class-methods">?</a> Returns true if the string is serialized, false otherwise. EXAMPLE: <code> s('a:1:{s:3:"foo";s:3:"bar";}')->isSerialized(); // true </code> Parameters: __nothing__ Return:
- isSimilar(string $str, float $minPercentForSimilarity): bool<a href="#class-methods">?</a> Check if two strings are similar. EXAMPLE: <code> </code> Parameters:
- Return:
- isUpperCase(): bool<a href="#class-methods">?</a> Returns true if the string contains only lower case chars, false otherwise. EXAMPLE: <code> s('FÒÔBÀ?')->isUpperCase(); // true </code> Parameters: __nothing__ Return:
- isWhitespace(): bool<a href="#class-methods">?</a> Returns true if the string contains only whitespace chars, false otherwise. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- jsonSerialize(): string<a href="#class-methods">?</a> Returns value which can be serialized by json_encode(). EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- kebabCase(): static<a href="#class-methods">?</a> Convert the string to kebab-case. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- last(int $n): static<a href="#class-methods">?</a> Returns the last $n characters of the string. EXAMPLE: <code> s('fòôbà?')->last(3); // 'bà?' </code> Parameters:
- Return:
- lastSubstringOf(string $needle, bool $beforeNeedle): static<a href="#class-methods">?</a> Gets the substring after (or before via "$beforeNeedle") the last occurrence of the "$needle". If no match is found returns new empty Stringy object. EXAMPLE: <code> </code> Parameters:
- Return:
- lastSubstringOfIgnoreCase(string $needle, bool $beforeNeedle): static<a href="#class-methods">?</a> Gets the substring after (or before via "$beforeNeedle") the last occurrence of the "$needle". If no match is found returns new empty Stringy object. EXAMPLE: <code> </code> Parameters:
- Return:
- length(): int<a href="#class-methods">?</a> Returns the length of the string. EXAMPLE: <code> s('fòôbà?')->length(); // 6 </code> Parameters: __nothing__ Return:
- lineWrap(int $limit, string $break, bool $add_final_break, string|null $delimiter): static<a href="#class-methods">?</a> Line-Wrap the string after $limit, but also after the next word. EXAMPLE: <code> </code> Parameters:
- Return:
- lineWrapAfterWord(int $limit, string $break, bool $add_final_break, string|null $delimiter): static<a href="#class-methods">?</a> Line-Wrap the string after $limit, but also after the next word. EXAMPLE: <code> </code> Parameters:
- Return:
- lines(): static[]<a href="#class-methods">?</a> Splits on newlines and carriage returns, returning an array of Stringy objects corresponding to the lines in the string. EXAMPLE: <code> s("fòô\r\nbà?\n")->lines(); // ['fòô', 'bà?', ''] </code> Parameters: __nothing__ Return:
- linesCollection(): \CollectionStringy|static[]<a href="#class-methods">?</a> Splits on newlines and carriage returns, returning an array of Stringy objects corresponding to the lines in the string. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- longestCommonPrefix(string $otherStr): static<a href="#class-methods">?</a> Returns the longest common prefix between the string and $otherStr. EXAMPLE: <code> s('foobar')->longestCommonPrefix('foobaz'); // 'fooba' </code> Parameters:
- Return:
- longestCommonSubstring(string $otherStr): static<a href="#class-methods">?</a> Returns the longest common substring between the string and $otherStr. In the case of ties, it returns that which occurs first. EXAMPLE: <code> s('foobar')->longestCommonSubstring('boofar'); // 'oo' </code> Parameters:
- Return:
- longestCommonSuffix(string $otherStr): static<a href="#class-methods">?</a> Returns the longest common suffix between the string and $otherStr. EXAMPLE: <code> s('fòôbà?')->longestCommonSuffix('fòrbà?'); // 'bà?' </code> Parameters:
- Return:
- lowerCaseFirst(): static<a href="#class-methods">?</a> Converts the first character of the string to lower case. EXAMPLE: <code> s('? Foo')->lowerCaseFirst(); // '? Foo' </code> Parameters: __nothing__ Return:
- matchCaseInsensitive(string|\Stringy $str): bool<a href="#class-methods">?</a> Determine if the string matches another string regardless of case. Alias for isEqualsCaseInsensitive() EXAMPLE: <code> </code> Parameters:
- Return:
- matchCaseSensitive(string|\Stringy $str): bool<a href="#class-methods">?</a> Determine if the string matches another string. Alias for isEqualsCaseSensitive() EXAMPLE: <code> </code> Parameters:
- Return:
- md5(): static<a href="#class-methods">?</a> Create a md5 hash from the current string. Parameters: __nothing__ Return:
- newLineToHtmlBreak(): static<a href="#class-methods">?</a> Replace all breaks [<br> | \r\n | \r | \n | ...] into "<br>". EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- nth(int $step, int $offset): static<a href="#class-methods">?</a> Get every nth character of the string. EXAMPLE: <code> </code> Parameters:
- Return:
- offsetExists(int $offset): bool<a href="#class-methods">?</a> Returns whether or not a character exists at an index. Offsets may be negative to count from the last character in the string. Implements part of the ArrayAccess interface. EXAMPLE: <code> </code> Parameters:
- Return:
- offsetGet(int $offset): string<a href="#class-methods">?</a> Returns the character at the given index. Offsets may be negative to count from the last character in the string. Implements part of the ArrayAccess interface, and throws an OutOfBoundsException if the index does not exist. EXAMPLE: <code> </code> Parameters:
- Return:
- offsetSet(int $offset, mixed $value): void<a href="#class-methods">?</a> Implements part of the ArrayAccess interface, but throws an exception when called. This maintains the immutability of Stringy objects. EXAMPLE: <code> </code> Parameters:
- Return:
- offsetUnset(int $offset): void<a href="#class-methods">?</a> Implements part of the ArrayAccess interface, but throws an exception when called. This maintains the immutability of Stringy objects. EXAMPLE: <code> </code> Parameters:
- Return:
- pad(int $length, string $padStr, string $padType): static<a href="#class-methods">?</a> Pads the string to a given length with $padStr. If length is less than or equal to the length of the string, no padding takes places. The default string used for padding is a space, and the default type (one of 'left', 'right', 'both') is 'right'. Throws an InvalidArgumentException if $padType isn't one of those 3 values. EXAMPLE: <code> s('fòôbà?')->pad(9, '-/', 'left'); // '-/-fòôbà?' </code> Parameters:
- Return:
- padBoth(int $length, string $padStr): static<a href="#class-methods">?</a> Returns a new string of a given length such that both sides of the string are padded. Alias for pad() with a $padType of 'both'. EXAMPLE: <code> s('foo bar')->padBoth(9, ' '); // ' foo bar ' </code> Parameters:
- Return:
- padLeft(int $length, string $padStr): static<a href="#class-methods">?</a> Returns a new string of a given length such that the beginning of the string is padded. Alias for pad() with a $padType of 'left'. EXAMPLE: <code> s('foo bar')->padLeft(9, ' '); // ' foo bar' </code> Parameters:
- Return:
- padRight(int $length, string $padStr): static<a href="#class-methods">?</a> Returns a new string of a given length such that the end of the string is padded. Alias for pad() with a $padType of 'right'. EXAMPLE: <code> s('foo bar')->padRight(10, '_'); // 'foo bar__' </code> Parameters:
- Return:
- pascalCase(): static<a href="#class-methods">?</a> Convert the string to PascalCase. Alias for studlyCase() EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- prepend(string $prefix): static<a href="#class-methods">?</a> Returns a new string starting with $prefix. EXAMPLE: <code> s('bà?')->prepend('fòô'); // 'fòôbà?' </code> Parameters:
- Return:
- prependStringy(\CollectionStringy|static $prefix): static<a href="#class-methods">?</a> Returns a new string starting with $prefix. EXAMPLE: <code> </code> Parameters:
- Return:
- regexReplace(string $pattern, string $replacement, string $options, string $delimiter): static<a href="#class-methods">?</a> Replaces all occurrences of $pattern in $str by $replacement. EXAMPLE: <code> s('fòô ')->regexReplace('f[òô]+\s', 'bà?'); // 'bà?' s('fò')->regexReplace('(ò)', '\\1ô'); // 'fòô' </code> Parameters:
- Return:
- removeHtml(string $allowableTags): static<a href="#class-methods">?</a> Remove html via "strip_tags()" from the string. EXAMPLE: <code> s('?àb <ô>òf\', ô<br/>foo <a href="#">lall</a>')->removeHtml('<br><br/>'); // '?àb òf\', ô<br/>foo lall' </code> Parameters: - `string $allowableTags [optional] <p>You can use the optional second parameter to specify tags which should not be stripped. Default: null </p>` Return:
- removeHtmlBreak(string $replacement): static<a href="#class-methods">?</a> Remove all breaks [<br> | \r\n | \r | \n | ...] from the string. EXAMPLE: <code> s('?àb <ô>òf\', ô<br/>foo <a href="#">lall</a>')->removeHtmlBreak(''); // '?àb <ô>òf\', ô< foo <a href="#">lall</a>' </code> Parameters:
- Return:
- removeLeft(string $substring): static<a href="#class-methods">?</a> Returns a new string with the prefix $substring removed, if present. EXAMPLE: <code> s('fòôbà?')->removeLeft('fòô'); // 'bà?' </code> Parameters:
- Return:
- removeRight(string $substring): static<a href="#class-methods">?</a> Returns a new string with the suffix $substring removed, if present. EXAMPLE: <code> s('fòôbà?')->removeRight('bà?'); // 'fòô' </code> Parameters:
- Return:
- removeXss(): static<a href="#class-methods">?</a> Try to remove all XSS-attacks from the string. EXAMPLE: <code> s('<IMG SRC=javascript:alert('XSS')>')->removeXss(); // '<IMG >' </code> Parameters: __nothing__ Return:
- repeat(int $multiplier): static<a href="#class-methods">?</a> Returns a repeated string given a multiplier. EXAMPLE: <code> s('?')->repeat(3); // '???' </code> Parameters:
- Return:
- replace(string $search, string $replacement, bool $caseSensitive): static<a href="#class-methods">?</a> Replaces all occurrences of $search in $str by $replacement. EXAMPLE: <code> s('fòô bà? fòô bà?')->replace('fòô ', ''); // 'bà? bà?' </code> Parameters:
- Return:
- replaceAll(string[] $search, string|string[] $replacement, bool $caseSensitive): static<a href="#class-methods">?</a> Replaces all occurrences of $search in $str by $replacement. EXAMPLE: <code> s('fòô bà? lall bà?')->replaceAll(['fòÔ ', 'lall'], '', false); // 'bà? bà?' </code> Parameters:
- Return:
- replaceBeginning(string $search, string $replacement): static<a href="#class-methods">?</a> Replaces all occurrences of $search from the beginning of string with $replacement. EXAMPLE: <code> s('fòô bà? fòô bà?')->replaceBeginning('fòô', ''); // ' bà? bà?' </code> Parameters:
- Return:
- replaceEnding(string $search, string $replacement): static<a href="#class-methods">?</a> Replaces all occurrences of $search from the ending of string with $replacement. EXAMPLE: <code> s('fòô bà? fòô bà?')->replaceEnding('bà?', ''); // 'fòô bà? fòô ' </code> Parameters:
- Return:
- replaceFirst(string $search, string $replacement): static<a href="#class-methods">?</a> Replaces first occurrences of $search from the beginning of string with $replacement. EXAMPLE: <code> </code> Parameters:
- Return:
- replaceLast(string $search, string $replacement): static<a href="#class-methods">?</a> Replaces last occurrences of $search from the ending of string with $replacement. EXAMPLE: <code> </code> Parameters:
- Return:
- reverse(): static<a href="#class-methods">?</a> Returns a reversed string. A multibyte version of strrev(). EXAMPLE: <code> s('fòôbà?')->reverse(); // '?àbôòf' </code> Parameters: __nothing__ Return:
- safeTruncate(int $length, string $substring, bool $ignoreDoNotSplitWordsForOneWord): static<a href="#class-methods">?</a> Truncates the string to a given length, while ensuring that it does not split words. If $substring is provided, and truncating occurs, the string is further truncated so that the substring may be appended without exceeding the desired length. EXAMPLE: <code> s('What are your plans today?')->safeTruncate(22, '...'); // 'What are your plans...' </code> Parameters:
- Return:
- setInternalEncoding(string $new_encoding): static<a href="#class-methods">?</a> Set the internal character encoding. EXAMPLE: <code> </code> Parameters:
- Return:
- sha1(): static<a href="#class-methods">?</a> Create a sha1 hash from the current string. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- sha256(): static<a href="#class-methods">?</a> Create a sha256 hash from the current string. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- sha512(): static<a href="#class-methods">?</a> Create a sha512 hash from the current string. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- shortenAfterWord(int $length, string $strAddOn): static<a href="#class-methods">?</a> Shorten the string after $length, but also after the next word. EXAMPLE: <code> s('this is a test')->shortenAfterWord(2, '...'); // 'this...' </code> Parameters:
- Return:
- shuffle(): static<a href="#class-methods">?</a> A multibyte string shuffle function. It returns a string with its characters in random order. EXAMPLE: <code> s('fòôbà?')->shuffle(); // 'àô?bòf' </code> Parameters: __nothing__ Return:
- similarity(string $str): float<a href="#class-methods">?</a> Calculate the similarity between two strings. EXAMPLE: <code> </code> Parameters:
- Return:
- slice(int $start, int $end): static<a href="#class-methods">?</a> Returns the substring beginning at $start, and up to, but not including the index specified by $end. If $end is omitted, the function extracts the remaining string. If $end is negative, it is computed from the end of the string. EXAMPLE: <code> s('fòôbà?')->slice(3, -1); // 'bà' </code> Parameters:
- Return:
- slugify(string $separator, string $language, string[] $replacements, bool $replace_extra_symbols, bool $use_str_to_lower, bool $use_transliterate): static<a href="#class-methods">?</a> Converts the string into an URL slug. This includes replacing non-ASCII characters with their closest ASCII equivalents, removing remaining non-ASCII and non-alphanumeric characters, and replacing whitespace with $separator. The separator defaults to a single dash, and the string is also converted to lowercase. The language of the source string can also be supplied for language-specific transliteration. EXAMPLE: <code> s('Using strings like fòô bà?')->slugify(); // 'using-strings-like-foo-bar' </code> Parameters:
- Return:
- snakeCase(): static<a href="#class-methods">?</a> Convert the string to snake_case. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- snakeize(): static<a href="#class-methods">?</a> Convert a string to snake_case. EXAMPLE: <code> s('foo1 Bar')->snakeize(); // 'foo_1_bar' </code> Parameters: __nothing__ Return:
- softWrap(int $width, string $break): static<a href="#class-methods">?</a> Wrap the string after the first whitespace character after a given number of characters. EXAMPLE: <code> </code> Parameters:
- Return:
- split(string $pattern, int $limit): static[]<a href="#class-methods">?</a> Splits the string with the provided regular expression, returning an array of Stringy objects. An optional integer $limit will truncate the results. EXAMPLE: <code> s('foo,bar,baz')->split(',', 2); // ['foo', 'bar'] </code> Parameters:
- Return:
- splitCollection(string $pattern, int $limit): \CollectionStringy|static[]<a href="#class-methods">?</a> Splits the string with the provided regular expression, returning an collection of Stringy objects. An optional integer $limit will truncate the results. EXAMPLE: <code> </code> Parameters:
- Return:
- startsWith(string $substring, bool $caseSensitive): bool<a href="#class-methods">?</a> Returns true if the string begins with $substring, false otherwise. By default, the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false. EXAMPLE: <code> s('FÒÔbà?baz')->startsWith('fòôbà?', false); // true </code> Parameters:
- Return:
- startsWithAny(string[] $substrings, bool $caseSensitive): bool<a href="#class-methods">?</a> Returns true if the string begins with any of $substrings, false otherwise. By default the comparison is case-sensitive, but can be made insensitive by setting $caseSensitive to false. EXAMPLE: <code> s('FÒÔbà?baz')->startsWithAny(['fòô', 'bà?'], false); // true </code> Parameters:
- Return:
- strip(string|string[] $search): static<a href="#class-methods">?</a> Remove one or more strings from the string. EXAMPLE: <code> </code> Parameters:
- Return:
- stripWhitespace(): static<a href="#class-methods">?</a> Strip all whitespace characters. This includes tabs and newline characters, as well as multibyte whitespace such as the thin space and ideographic space. EXAMPLE: <code> s(' ? ?????????? ')->stripWhitespace(); // '???????????' </code> Parameters: __nothing__ Return:
- stripeCssMediaQueries(): static<a href="#class-methods">?</a> Remove css media-queries. EXAMPLE: <code> s('test @media (min-width:660px){ .des-cla #mv-tiles{width:480px} } test ')->stripeCssMediaQueries(); // 'test test ' </code> Parameters: __nothing__ Return:
- stripeEmptyHtmlTags(): static<a href="#class-methods">?</a> Remove empty html-tag. EXAMPLE: <code> s('foo<h1></h1>bar')->stripeEmptyHtmlTags(); // 'foobar' </code> Parameters: __nothing__ Return:
- studlyCase(): static<a href="#class-methods">?</a> Convert the string to StudlyCase. EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- substr(int $start, int $length): static<a href="#class-methods">?</a> Returns the substring beginning at $start with the specified $length. It differs from the $this->utf8::substr() function in that providing a $length of null will return the rest of the string, rather than an empty string. EXAMPLE: <code> </code> Parameters:
- Return:
- substring(int $start, int $length): static<a href="#class-methods">?</a> Return part of the string. Alias for substr() EXAMPLE: <code> s('fòôbà?')->substring(2, 3); // 'ôbà' </code> Parameters:
- Return:
- substringOf(string $needle, bool $beforeNeedle): static<a href="#class-methods">?</a> Gets the substring after (or before via "$beforeNeedle") the first occurrence of the "$needle". If no match is found returns new empty Stringy object. EXAMPLE: <code> </code> Parameters:
- Return:
- substringOfIgnoreCase(string $needle, bool $beforeNeedle): static<a href="#class-methods">?</a> Gets the substring after (or before via "$beforeNeedle") the first occurrence of the "$needle". If no match is found returns new empty Stringy object. EXAMPLE: <code> </code> Parameters:
- Return:
- surround(string $substring): static<a href="#class-methods">?</a> Surrounds $str with the given substring. EXAMPLE: <code> s(' ? ')->surround('?'); // '? ? ?' </code> Parameters:
- Return:
- swapCase(): static<a href="#class-methods">?</a> Returns a case swapped version of the string. EXAMPLE: <code> s('??????')->swapCase(); // '??????' </code> Parameters: __nothing__ Return:
- tidy(): static<a href="#class-methods">?</a> Returns a string with smart quotes, ellipsis characters, and dashes from Windows-1252 (commonly used in Word documents) replaced by their ASCII equivalents. EXAMPLE: <code> s('?I see??')->tidy(); // '"I see..."' </code> Parameters: __nothing__ Return:
- titleize(array|string[]|null $ignore, string|null $word_define_chars, string|null $language): static<a href="#class-methods">?</a> Returns a trimmed string with the first letter of each word capitalized. Also accepts an array, $ignore, allowing you to list words not to be capitalized. EXAMPLE: <code> $ignore = ['at', 'by', 'for', 'in', 'of', 'on', 'out', 'to', 'the']; s('i like to watch television')->titleize($ignore); // 'I Like to Watch Television' </code> Parameters:
- `array<array-key, mixed|string>|null $ignore [optional] <p>An array of words not to capitalize or null.
Default: null</p>`
- `null|string $word_define_chars [optional] <p>An string of chars that will be used as whitespace
separator === words.</p>`
- Return:
- titleizeForHumans(string[] $ignore): static<a href="#class-methods">?</a> Returns a trimmed string in proper title case: Also accepts an array, $ignore, allowing you to list words not to be capitalized. EXAMPLE: <code> </code> Adapted from John Gruber's script. Parameters:
- Return:
- toAscii(string $language, bool $removeUnsupported): static<a href="#class-methods">?</a> Returns an ASCII version of the string. A set of non-ASCII characters are replaced with their closest ASCII counterparts, and the rest are removed by default. The language or locale of the source string can be supplied for language-specific transliteration in any of the following formats: en, en_GB, or en-GB. For example, passing "de" results in "äöü" mapping to "aeoeue" rather than "aou" as in other languages. EXAMPLE: <code> s('fòôbà?')->toAscii(); // 'foobar' </code> Parameters:
- Return:
- toBoolean(): bool<a href="#class-methods">?</a> Returns a boolean representation of the given logical string value. For example, <strong>'true', '1', 'on' and 'yes'</strong> will return true. <strong>'false', '0', 'off', and 'no'</strong> will return false. In all instances, case is ignored. For other numeric strings, their sign will determine the return value. In addition, blank strings consisting of only whitespace will return false. For all other strings, the return value is a result of a boolean cast. EXAMPLE: <code> s('OFF')->toBoolean(); // false </code> Parameters: __nothing__ Return:
- toLowerCase(bool $tryToKeepStringLength, string|null $lang): static<a href="#class-methods">?</a> Converts all characters in the string to lowercase. EXAMPLE: <code> s('FÒÔBÀ?')->toLowerCase(); // 'fòôbà?' </code> Parameters:
- Return:
- toSpaces(int $tabLength): static<a href="#class-methods">?</a> Converts each tab in the string to some number of spaces, as defined by $tabLength. By default, each tab is converted to 4 consecutive spaces. EXAMPLE: <code> s(' String speech = "Hi"')->toSpaces(); // ' String speech = "Hi"' </code> Parameters:
- Return:
- toString(): string<a href="#class-methods">?</a> Return Stringy object as string, but you can also use (string) for automatically casting the object into a string. EXAMPLE: <code> s('fòôbà?')->toString(); // 'fòôbà?' </code> Parameters: __nothing__ Return:
- toTabs(int $tabLength): static<a href="#class-methods">?</a> Converts each occurrence of some consecutive number of spaces, as defined by $tabLength, to a tab. By default, each 4 consecutive spaces are converted to a tab. EXAMPLE: <code> s(' fòô bà?')->toTabs(); // ' fòô bà?' </code> Parameters:
- Return:
- toTitleCase(): static<a href="#class-methods">?</a> Converts the first character of each word in the string to uppercase and all other chars to lowercase. EXAMPLE: <code> s('fòô bà?')->toTitleCase(); // 'Fòô Bà?' </code> Parameters: __nothing__ Return:
- toTransliterate(bool $strict, string $unknown): static<a href="#class-methods">?</a> Returns an ASCII version of the string. A set of non-ASCII characters are replaced with their closest ASCII counterparts, and the rest are removed unless instructed otherwise. EXAMPLE: <code> </code> Parameters:
- `bool $strict [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad
performance | Default: false</p>`
- Return:
- toUpperCase(bool $tryToKeepStringLength, string|null $lang): static<a href="#class-methods">?</a> Converts all characters in the string to uppercase. EXAMPLE: <code> s('fòôbà?')->toUpperCase(); // 'FÒÔBÀ?' </code> Parameters:
- Return:
- trim(string $chars): static<a href="#class-methods">?</a> Returns a string with whitespace removed from the start and end of the string. Supports the removal of unicode whitespace. Accepts an optional string of characters to strip instead of the defaults. EXAMPLE: <code> s(' fòôbà? ')->trim(); // 'fòôbà?' </code> Parameters:
- Return:
- trimLeft(string $chars): static<a href="#class-methods">?</a> Returns a string with whitespace removed from the start of the string. Supports the removal of unicode whitespace. Accepts an optional string of characters to strip instead of the defaults. EXAMPLE: <code> s(' fòôbà? ')->trimLeft(); // 'fòôbà? ' </code> Parameters:
- Return:
- trimRight(string $chars): static<a href="#class-methods">?</a> Returns a string with whitespace removed from the end of the string. Supports the removal of unicode whitespace. Accepts an optional string of characters to strip instead of the defaults. EXAMPLE: <code> s(' fòôbà? ')->trimRight(); // ' fòôbà?' </code> Parameters:
- Return:
- truncate(int $length, string $substring): static<a href="#class-methods">?</a> Truncates the string to a given length. If $substring is provided, and truncating occurs, the string is further truncated so that the substring may be appended without exceeding the desired length. EXAMPLE: <code> s('What are your plans today?')->truncate(19, '...'); // 'What are your pl...' </code> Parameters:
- Return:
- underscored(): static<a href="#class-methods">?</a> Returns a lowercase and trimmed string separated by underscores. Underscores are inserted before uppercase characters (with the exception of the first character of the string), and in place of spaces as well as dashes. EXAMPLE: <code> s('TestUCase')->underscored(); // 'test_u_case' </code> Parameters: __nothing__ Return:
- upperCamelize(): static<a href="#class-methods">?</a> Returns an UpperCamelCase version of the supplied string. It trims surrounding spaces, capitalizes letters following digits, spaces, dashes and underscores, and removes spaces, dashes, underscores. EXAMPLE: <code> s('Upper Camel-Case')->upperCamelize(); // 'UpperCamelCase' </code> Parameters: __nothing__ Return:
- upperCaseFirst(): static<a href="#class-methods">?</a> Converts the first character of the supplied string to upper case. EXAMPLE: <code> s('? foo')->upperCaseFirst(); // '? foo' </code> Parameters: __nothing__ Return:
- urlDecode(): static<a href="#class-methods">?</a> Simple url-decoding. e.g: 'test+test' => 'test test' EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- urlDecodeMulti(): static<a href="#class-methods">?</a> Multi url-decoding + decode HTML entity + fix urlencoded-win1252-chars. e.g: 'test+test' => 'test test' 'Düsseldorf' => 'Düsseldorf' 'D%FCsseldorf' => 'Düsseldorf' 'Düsseldorf' => 'Düsseldorf' 'D%26%23xFC%3Bsseldorf' => 'Düsseldorf' 'Düsseldorf' => 'Düsseldorf' 'D%C3%BCsseldorf' => 'Düsseldorf' 'D%C3%83%C2%BCsseldorf' => 'Düsseldorf' 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf' EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- urlDecodeRaw(): static<a href="#class-methods">?</a> Simple url-decoding. e.g: 'test+test' => 'test+test EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- urlDecodeRawMulti(): static<a href="#class-methods">?</a> Multi url-decoding + decode HTML entity + fix urlencoded-win1252-chars. e.g: 'test+test' => 'test+test' 'Düsseldorf' => 'Düsseldorf' 'D%FCsseldorf' => 'Düsseldorf' 'Düsseldorf' => 'Düsseldorf' 'D%26%23xFC%3Bsseldorf' => 'Düsseldorf' 'Düsseldorf' => 'Düsseldorf' 'D%C3%BCsseldorf' => 'Düsseldorf' 'D%C3%83%C2%BCsseldorf' => 'Düsseldorf' 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf' EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- urlEncode(): static<a href="#class-methods">?</a> Simple url-encoding. e.g: 'test test' => 'test+test' EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- urlEncodeRaw(): static<a href="#class-methods">?</a> Simple url-encoding. e.g: 'test test' => 'test%20test' EXAMPLE: <code> </code> Parameters: __nothing__ Return:
- urlify(string $separator, string $language, string[] $replacements, bool $strToLower): static<a href="#class-methods">?</a> Converts the string into an URL slug. This includes replacing non-ASCII characters with their closest ASCII equivalents, removing remaining non-ASCII and non-alphanumeric characters, and replacing whitespace with $separator. The separator defaults to a single dash, and the string is also converted to lowercase. EXAMPLE: <code> s('Using strings like fòô bà? - 1$')->urlify(); // 'using-strings-like-foo-bar-1-dollar' </code> Parameters:
- Return:
- utf8ify(): static<a href="#class-methods">?</a> Converts the string into an valid UTF-8 string. EXAMPLE: <code> s('Düsseldorf')->utf8ify(); // 'Düsseldorf' </code> Parameters: __nothing__ Return:
- words(string $char_list, bool $remove_empty_values, int|null $remove_short_values): static[]<a href="#class-methods">?</a> Convert a string into an array of words. EXAMPLE: <code> </code> Parameters:
- Return:
- wordsCollection(string $char_list, bool $remove_empty_values, int|null $remove_short_values): \CollectionStringy|static[]<a href="#class-methods">?</a> Convert a string into an collection of words. EXAMPLE: <code> S::create('???? oöäü#s')->wordsCollection('#', true)->toStrings(); // ['????', 'oöäü#s'] </code> Parameters:
- Return:
- wrap(string $substring): static<a href="#class-methods">?</a> Surrounds $str with the given substring. EXAMPLE: <code> </code> Parameters:
- Return:
- TestsFrom the project directory, tests can be ran using SupportFor support and donations please visit Github | Issues | PayPal | Patreon. For status updates and release announcements please visit Releases | Twitter | Patreon. For professional support please contact me. Thanks
LicenseReleased under the MIT License - see |