Download the PHP package statamic/stringy without Composer

Stringy

This is a maintained fork of danielstjules/Stringy in order to support PHP 7.3 compatibility.

A PHP string manipulation library with multibyte support. Compatible with PHP 5.4+, PHP 7+ (including PHP 7.3), and HHVM.

Refer to the 1.x branch or 2.x branch for older documentation.

• Why?
• Installation
• OO and Chaining
• Implemented Interfaces
• PHP 5.6 Creation
• StaticStringy
• Class methods
  • create

• Instance methods

  append	at	between	camelize
  chars	collapseWhitespace	contains	containsAll
  containsAny	countSubstr	dasherize	delimit
  endsWith	endsWithAny	ensureLeft	ensureRight
  first	getEncoding	hasLowerCase	hasUpperCase
  htmlDecode	htmlEncode	humanize	indexOf
  indexOfLast	insert	isAlpha	isAlphanumeric
  isBase64	isBlank	isHexadecimal	isJson
  isLowerCase	isSerialized	isUpperCase	last
  length	lines	longestCommonPrefix	longestCommonSuffix
  longestCommonSubstring	lowerCaseFirst	pad	padBoth
  padLeft	padRight	prepend	regexReplace
  removeLeft	removeRight	repeat	replace
  reverse	safeTruncate	shuffle	slugify
  slice	split	startsWith	startsWithAny
  stripWhitespace	substr	surround	swapCase
  tidy	titleize	toAscii	toBoolean
  toLowerCase	toSpaces	toTabs	toTitleCase
  toUpperCase	trim	trimLeft	trimRight
  truncate	underscored	upperCamelize	upperCaseFirst

• Extensions
• Tests
• License

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 mbstring module's multibyte-compatible functions. Stringy handles some quirks, provides additional functionality, and hopefully makes strings a little easier to work with!

Installation

If you're using Composer to manage dependencies, you can include the following in your composer.json file:

Then, after running composer update or php composer.phar update, you can load the class using Composer's autoloading:

Otherwise, you can simply require the file directly:

And in either case, I'd suggest using an alias.

Please note that Stringy relies on the mbstring module for its underlying multibyte support. If the module is not found, Stringy will use symfony/polyfill-mbstring. ex-mbstring is a non-default, but very common module. For example, with debian and ubuntu, it's included in libapache2-mod-php5, php5-cli, and php5-fpm. For OSX users, it's a default for any version of PHP installed with homebrew. If compiling PHP from scratch, it can be included with the --enable-mbstring flag.

OO and Chaining

The library offers OO method chaining, as seen below:

Stringy\Stringy has a __toString() method, which returns the current string when the object is used in a string context, ie: (string) S::create('foo') // 'foo'

Implemented Interfaces

Stringy\Stringy implements the IteratorAggregate interface, meaning that foreach can be used with an instance of the class:

It implements the Countable interface, enabling the use of count() to retrieve the number of characters in the string:

Furthermore, the ArrayAccess interface has been implemented. As a result, isset() can be used to check if a character at a specific index exists. And since Stringy\Stringy is immutable, any call to offsetSet or offsetUnset will throw an exception. offsetGet has been implemented, however, and accepts both positive and negative indexes. Invalid indexes result in an OutOfBoundsException.

PHP 5.6 Creation

As of PHP 5.6, use function is available for importing functions. Stringy exposes a namespaced function, Stringy\create, which emits the same behaviour as Stringy\Stringy::create(). If running PHP 5.6, or another runtime that supports the use function syntax, you can take advantage of an even simpler API as seen below:

StaticStringy

All methods listed under "Instance methods" are available as part of a static wrapper. For StaticStringy methods, the optional encoding is expected to be the last argument. The return value is not cast, and may thus be of type Stringy, integer, boolean, etc.

Class methods

create(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.

Instance Methods

Stringy 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, as well as the notes on PHP 5.6 creation.

append(string $string)

Returns a new string with $string appended.

at(int $index)

Returns the character at $index, with indexes starting at 0.

between(string $start, string $end [, int $offset])

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.

camelize()

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.

chars()

Returns an array consisting of the characters in the string.

collapseWhitespace()

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.

contains(string $needle [, boolean $caseSensitive = true ])

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.

containsAll(array $needles [, boolean $caseSensitive = true ])

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.

containsAny(array $needles [, boolean $caseSensitive = 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.

countSubstr(string $substring [, boolean $caseSensitive = true ])

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.

dasherize()

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.

delimit(int $delimiter)

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.

endsWith(string $substring [, boolean $caseSensitive = true ])

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.

endsWithAny(string[] $substrings [, boolean $caseSensitive = true ])

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.

ensureLeft(string $substring)

Ensures that the string begins with $substring. If it doesn't, it's prepended.

ensureRight(string $substring)

Ensures that the string ends with $substring. If it doesn't, it's appended.

first(int $n)

Returns the first $n characters of the string.

getEncoding()

Returns the encoding used by the Stringy object.

hasLowerCase()

Returns true if the string contains a lower case char, false otherwise.

hasUpperCase()

Returns true if the string contains an upper case char, false otherwise.

htmlDecode()

Convert all HTML entities to their applicable characters. An alias of html_entity_decode. For a list of flags, refer to http://php.net/manual/en/function.html-entity-decode.php

htmlEncode()

Convert all applicable characters to HTML entities. An alias of htmlentities. Refer to http://php.net/manual/en/function.htmlentities.php for a list of flags.

humanize()

Capitalizes the first word of the string, replaces underscores with spaces, and strips '_id'.

indexOf(string $needle [, $offset = 0 ]);

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. A negative index searches from the end

indexOfLast(string $needle [, $offset = 0 ]);

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.

insert(int $index, string $substring)

Inserts $substring into the string at the $index provided.

isAlpha()

Returns true if the string contains only alphabetic chars, false otherwise.

isAlphanumeric()

Returns true if the string contains only alphabetic and numeric chars, false otherwise.

isBase64()

Returns true if the string is base64 encoded, false otherwise.

isBlank()

Returns true if the string contains only whitespace chars, false otherwise.

isHexadecimal()

Returns true if the string contains only hexadecimal chars, false otherwise.

isJson()

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.

isLowerCase()

Returns true if the string contains only lower case chars, false otherwise.

isSerialized()

Returns true if the string is serialized, false otherwise.

isUpperCase()

Returns true if the string contains only upper case chars, false otherwise.

last(int $n)

Returns the last $n characters of the string.

length()

Returns the length of the string. An alias for PHP's mb_strlen() function.

lines()

Splits on newlines and carriage returns, returning an array of Stringy objects corresponding to the lines in the string.

longestCommonPrefix(string $otherStr)

Returns the longest common prefix between the string and $otherStr.

longestCommonSuffix(string $otherStr)

Returns the longest common suffix between the string and $otherStr.

longestCommonSubstring(string $otherStr)

Returns the longest common substring between the string and $otherStr. In the case of ties, it returns that which occurs first.

lowerCaseFirst()

Converts the first character of the supplied string to lower case.

pad(int $length [, string $padStr = ' ' [, string $padType = 'right' ]])

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.

padBoth(int $length [, string $padStr = ' ' ])

Returns a new string of a given length such that both sides of the string string are padded. Alias for pad() with a $padType of 'both'.

padLeft(int $length [, string $padStr = ' ' ])

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'.

padRight(int $length [, string $padStr = ' ' ])

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'.

prepend(string $string)

Returns a new string starting with $string.

regexReplace(string $pattern, string $replacement [, string $options = 'msr'])

Replaces all occurrences of $pattern in $str by $replacement. An alias for mb_ereg_replace(). Note that the 'i' option with multibyte patterns in mb_ereg_replace() requires PHP 5.6+ for correct results. This is due to a lack of support in the bundled version of Oniguruma in PHP < 5.6, and current versions of HHVM (3.8 and below).

removeLeft(string $substring)

Returns a new string with the prefix $substring removed, if present.

removeRight(string $substring)

Returns a new string with the suffix $substring removed, if present.

repeat(int $multiplier)

Returns a repeated string given a multiplier. An alias for str_repeat.

replace(string $search, string $replacement)

Replaces all occurrences of $search in $str by $replacement.

reverse()

Returns a reversed string. A multibyte version of strrev().

safeTruncate(int $length [, string $substring = '' ])

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.

shuffle()

A multibyte str_shuffle() function. It returns a string with its characters in random order.

slugify([, string $replacement = '-' [, string $language = 'en']])

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 $replacement. The replacement 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.

slice(int $start [, int $end ])

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.

split(string $pattern [, int $limit ])

Splits the string with the provided regular expression, returning an array of Stringy objects. An optional integer $limit will truncate the results.

startsWith(string $substring [, boolean $caseSensitive = true ])

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.

startsWithAny(string[] $substrings [, boolean $caseSensitive = true ])

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.

stripWhitespace()

Strip all whitespace characters. This includes tabs and newline characters, as well as multibyte whitespace such as the thin space and ideographic space.

substr(int $start [, int $length ])

Returns the substring beginning at $start with the specified $length. It differs from the mb_substr() function in that providing a $length of null will return the rest of the string, rather than an empty string.

surround(string $substring)

Surrounds a string with the given substring.

swapCase()

Returns a case swapped version of the string.

tidy()

Returns a string with smart quotes, ellipsis characters, and dashes from Windows-1252 (commonly used in Word documents) replaced by their ASCII equivalents.

titleize([, array $ignore])

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.

toAscii([, string $language = 'en' [, bool $removeUnsupported = true ]])

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.

toBoolean()

Returns a boolean representation of the given logical string value. For example, 'true', '1', 'on' and 'yes' will return true. 'false', '0', 'off', and 'no' 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.

toLowerCase()

Converts all characters in the string to lowercase. An alias for PHP's mb_strtolower().

toSpaces([, tabLength = 4 ])

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.

toTabs([, tabLength = 4 ])

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.

toTitleCase()

Converts the first character of each word in the string to uppercase.

toUpperCase()

Converts all characters in the string to uppercase. An alias for PHP's mb_strtoupper().

trim([, string $chars])

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.

trimLeft([, string $chars])

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.

trimRight([, string $chars])

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.

truncate(int $length [, string $substring = '' ])

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.

underscored()

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.

upperCamelize()

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.

upperCaseFirst()

Converts the first character of the supplied string to upper case.

Extensions

The following is a list of libraries that extend Stringy:

• SliceableStringy: Python-like string slices in PHP
• SubStringy: Advanced substring methods

Tests

From the project directory, tests can be ran using phpunit

License

Released under the MIT License - see LICENSE.txt for details.