Properties

$methodArgs

$methodArgs : array<mixed,string>

A mapping of method names to the numbers of arguments it accepts. Each should be two more than the equivalent Stringy method. Necessary as static methods place the optional $encoding as the last parameter.

Type

array<mixed,string>

Methods

__callStatic()

__callStatic(string  $name, array<mixed,mixed>  $arguments) : \Stringy\Stringy

Creates an instance of Stringy and invokes the given method with the rest of the passed arguments. The optional encoding is expected to be the last argument. For example, the following: StaticStringy::slice('fòôbàř', 0, 3, 'UTF-8'); translates to Stringy::create('fòôbàř', 'UTF-8')->slice(0, 3); The result is not cast, so the return value may be of type Stringy, integer, boolean, etc.

Parameters

string $name
array<mixed,mixed> $arguments

Throws

\BadMethodCallException

Returns

\Stringy\Stringy

append()

append(string  $str, string  $stringAppend, string  $encoding = null) : string

Parameters

string $str
string $stringAppend
string $encoding

Returns

string

at()

at(string  $str, integer  $index, string  $encoding = null) : string

Parameters

string $str
integer $index
string $encoding

Returns

string

between()

between(string  $str, string  $start, string  $end, integer  $offset, string  $encoding = null) : string

Parameters

string $str
string $start
string $end
integer $offset
string $encoding

Returns

string

camelize()

camelize(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

chars()

chars(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

collapseWhitespace()

collapseWhitespace(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

contains()

contains(string  $str, string  $needle, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
string $needle
boolean $caseSensitive
string $encoding

Returns

boolean

containsAll()

containsAll(string  $str, array<mixed,string>  $needle, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
array<mixed,string> $needle
boolean $caseSensitive
string $encoding

Returns

boolean

containsAny()

containsAny(string  $str, array<mixed,string>  $needle, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
array<mixed,string> $needle
boolean $caseSensitive
string $encoding

Returns

boolean

count()

count(string  $str, string  $encoding = null) : integer

Parameters

string $str
string $encoding

Returns

integer

countSubstr()

countSubstr(string  $str, string  $substring, boolean  $caseSensitive = true, string  $encoding = null) : integer

Parameters

string $str
string $substring
boolean $caseSensitive
string $encoding

Returns

integer

dasherize()

dasherize(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

delimit()

delimit(string  $str, string  $delimiter, string  $encoding = null) : string

Parameters

string $str
string $delimiter
string $encoding

Returns

string

endsWith()

endsWith(string  $str, string  $substring, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
string $substring
boolean $caseSensitive
string $encoding

Returns

boolean

endsWithAny()

endsWithAny(string  $str, array<mixed,string>  $substrings, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
array<mixed,string> $substrings
boolean $caseSensitive
string $encoding

Returns

boolean

ensureLeft()

ensureLeft(string  $str, string  $substring, string  $encoding = null) : string

Parameters

string $str
string $substring
string $encoding

Returns

string

ensureRight()

ensureRight(string  $str, string  $substring, string  $encoding = null) : string

Parameters

string $str
string $substring
string $encoding

Returns

string

first()

first(string  $str, integer  $n, string  $encoding = null) : string

Parameters

string $str
integer $n
string $encoding

Returns

string

hasLowerCase()

hasLowerCase(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

hasUpperCase()

hasUpperCase(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

htmlDecode()

htmlDecode(string  $str, integer  $flags = ENT_COMPAT, string  $encoding = null) : string

Parameters

string $str
integer $flags
string $encoding

Returns

string

htmlEncode()

htmlEncode(string  $str, integer  $flags = ENT_COMPAT, string  $encoding = null) : string

Parameters

string $str
integer $flags
string $encoding

Returns

string

humanize()

humanize(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

indexOf()

indexOf(string  $str, string  $needle, integer  $offset, string  $encoding = null) : integer

Parameters

string $str
string $needle
integer $offset
string $encoding

Returns

integer

indexOfLast()

indexOfLast(string  $str, string  $needle, integer  $offset, string  $encoding = null) : integer

Parameters

string $str
string $needle
integer $offset
string $encoding

Returns

integer

insert()

insert(string  $str, string  $substring, integer  $index, string  $encoding = null) : string

Parameters

string $str
string $substring
integer $index
string $encoding

Returns

string

isAlpha()

isAlpha(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isAlphanumeric()

isAlphanumeric(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isBase64()

isBase64(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isBlank()

isBlank(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isHexadecimal()

isHexadecimal(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isJson()

isJson(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isLowerCase()

isLowerCase(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isSerialized()

isSerialized(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

isUpperCase()

isUpperCase(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

last()

last(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

length()

length(string  $str, string  $encoding = null) : integer

Parameters

string $str
string $encoding

Returns

integer

()

() : 

static string[] lines(string $str, string $encoding = null)

Returns

longestCommonPrefix()

longestCommonPrefix(string  $str, string  $otherStr, string  $encoding = null) : string

Parameters

string $str
string $otherStr
string $encoding

Returns

string

longestCommonSuffix()

longestCommonSuffix(string  $str, string  $otherStr, string  $encoding = null) : string

Parameters

string $str
string $otherStr
string $encoding

Returns

string

longestCommonSubstring()

longestCommonSubstring(string  $str, string  $otherStr, string  $encoding = null) : string

Parameters

string $str
string $otherStr
string $encoding

Returns

string

lowerCaseFirst()

lowerCaseFirst(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

pad()

pad(string  $str, integer  $length, string  $padStr = ', string  $padType = 'right', string  $encoding = null) : string

Parameters

string $str
integer $length
string $padStr
string $padType
string $encoding

Returns

string

padBoth()

padBoth(string  $str, integer  $length, string  $padStr = ', string  $encoding = null) : string

Parameters

string $str
integer $length
string $padStr
string $encoding

Returns

string

padLeft()

padLeft(string  $str, integer  $length, string  $padStr = ', string  $encoding = null) : string

Parameters

string $str
integer $length
string $padStr
string $encoding

Returns

string

padRight()

padRight(string  $str, integer  $length, string  $padStr = ', string  $encoding = null) : string

Parameters

string $str
integer $length
string $padStr
string $encoding

Returns

string

prepend()

prepend(string  $str, string  $string, string  $encoding = null) : string

Parameters

string $str
string $string
string $encoding

Returns

string

regexReplace()

regexReplace(string  $str, string  $pattern, string  $replacement, string  $options = 'msr', string  $encoding = null) : string

Parameters

string $str
string $pattern
string $replacement
string $options
string $encoding

Returns

string

removeLeft()

removeLeft(string  $str, string  $substring, string  $encoding = null) : string

Parameters

string $str
string $substring
string $encoding

Returns

string

removeRight()

removeRight(string  $str, string  $substring, string  $encoding = null) : string

Parameters

string $str
string $substring
string $encoding

Returns

string

repeat()

repeat(string  $str, integer  $multiplier, string  $encoding = null) : string

Parameters

string $str
integer $multiplier
string $encoding

Returns

string

replace()

replace(string  $str, string  $search, string  $replacement, string  $encoding = null) : string

Parameters

string $str
string $search
string $replacement
string $encoding

Returns

string

reverse()

reverse(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

safeTruncate()

safeTruncate(string  $str, integer  $length, string  $substring = '', string  $encoding = null) : string

Parameters

string $str
integer $length
string $substring
string $encoding

Returns

string

shuffle()

shuffle(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

slugify()

slugify(string  $str, string  $replacement = '-', string  $encoding = null) : string

Parameters

string $str
string $replacement
string $encoding

Returns

string

slice()

slice(string  $str, integer  $start, integer  $end = null, string  $encoding = null) : string

Parameters

string $str
integer $start
integer $end
string $encoding

Returns

string

split()

split(string  $str, string  $pattern, integer  $limit = null, string  $encoding = null) : string

Parameters

string $str
string $pattern
integer $limit
string $encoding

Returns

string

startsWith()

startsWith(string  $str, string  $substring, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
string $substring
boolean $caseSensitive
string $encoding

Returns

boolean

startsWithAny()

startsWithAny(string  $str, array<mixed,string>  $substrings, boolean  $caseSensitive = true, string  $encoding = null) : boolean

Parameters

string $str
array<mixed,string> $substrings
boolean $caseSensitive
string $encoding

Returns

boolean

stripWhitespace()

stripWhitespace(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

substr()

substr(string  $str, integer  $start, integer  $length = null, string  $encoding = null) : string

Parameters

string $str
integer $start
integer $length
string $encoding

Returns

string

surround()

surround(string  $str, string  $substring, string  $encoding = null) : string

Parameters

string $str
string $substring
string $encoding

Returns

string

swapCase()

swapCase(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

tidy()

tidy(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

titleize()

titleize(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

toAscii()

toAscii(string  $str, string  $language = 'en', boolean  $removeUnsupported = true, string  $encoding = null) : string

Parameters

string $str
string $language
boolean $removeUnsupported
string $encoding

Returns

string

toBoolean()

toBoolean(string  $str, string  $encoding = null) : boolean

Parameters

string $str
string $encoding

Returns

boolean

toLowerCase()

toLowerCase(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

toSpaces()

toSpaces(string  $str, integer  $tabLength = 4, string  $encoding = null) : string

Parameters

string $str
integer $tabLength
string $encoding

Returns

string

toTabs()

toTabs(string  $str, integer  $tabLength = 4, string  $encoding = null) : string

Parameters

string $str
integer $tabLength
string $encoding

Returns

string

toTitleCase()

toTitleCase(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

toUpperCase()

toUpperCase(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

trim()

trim(string  $str, string  $chars = null, string  $encoding = null) : string

Parameters

string $str
string $chars
string $encoding

Returns

string

trimLeft()

trimLeft(string  $str, string  $chars = null, string  $encoding = null) : string

Parameters

string $str
string $chars
string $encoding

Returns

string

trimRight()

trimRight(string  $str, string  $chars = null, string  $encoding = null) : string

Parameters

string $str
string $chars
string $encoding

Returns

string

truncate()

truncate(string  $str, integer  $length, string  $substring = '', string  $encoding = null) : string

Parameters

string $str
integer $length
string $substring
string $encoding

Returns

string

underscored()

underscored(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

upperCamelize()

upperCamelize(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string

upperCaseFirst()

upperCaseFirst(string  $str, string  $encoding = null) : string

Parameters

string $str
string $encoding

Returns

string