Class Illuminate\Support\Stringable

`implements`	`JsonSerializable, ArrayAccess, Stringable`
`uses`	`Conditionable, Dumpable, Macroable, Tappable`


					
	public

__construct(string $value = ''): void

Create a new instance of the class.

#


					
	public

after(string $search): static

Return the remainder of a string after the first occurrence of a given value.

#


					
	public

afterLast(string $search): static

Return the remainder of a string after the last occurrence of a given value.

#


					
	public

append(array|string ...$values): static

Append the given values to the string.

#


					
	public

newLine(int $count = 1): $this

Append a new line to the string.

#


					
	public

ascii(string $language = 'en'): static

Transliterate a UTF-8 value to ASCII.

#


					
	public

basename(string $suffix = ''): static

Get the trailing name component of the path.

#


					
	public

charAt(int $index): string|false

Get the character at the specified index.

#


					
	public

chopStart(string|array $needle): static

Remove the given string if it exists at the start of the current string.

#


					
	public

chopEnd(string|array $needle): static

Remove the given string if it exists at the end of the current string.

#


					
	public

classBasename(): static

Get the basename of the class path.

#


					
	public

before(string $search): static

Get the portion of a string before the first occurrence of a given value.

#


					
	public

beforeLast(string $search): static

Get the portion of a string before the last occurrence of a given value.

#


					
	public

between(string $from, string $to): static

Get the portion of a string between two given values.

#


					
	public

betweenFirst(string $from, string $to): static

Get the smallest possible portion of a string between two given values.

#


					
	public

camel(): static

Convert a value to camel case.

#


					
	public

contains(string|iterable<string> $needles, bool $ignoreCase = false): bool

Determine if a given string contains a given substring.

#


					
	public

containsAll(iterable<string> $needles, bool $ignoreCase = false): bool

Determine if a given string contains all array values.

#


					
	public

convertCase(int $mode = MB_CASE_FOLD, string|null $encoding = 'UTF-8'): static

Convert the case of a string.

#


					
	public

deduplicate(string $character = ' '): static

Replace consecutive instances of a given character with a single character.

#


					
	public

dirname(int $levels = 1): static

Get the parent directory's path.

#


					
	public

endsWith(string|iterable<string> $needles): bool

Determine if a given string ends with a given substring.

#


					
	public

exactly(Stringable|string $value): bool

Determine if the string is an exact match with the given value.

#


					
	public

excerpt(string $phrase = '', array $options = []): string|null

Extracts an excerpt from text that matches the first instance of a phrase.

#


					
	public

explode(string $delimiter, int $limit = PHP_INT_MAX): Collection<int, string>

Explode the string into a collection.

#


					
	public

split(string|int $pattern, int $limit = -1, int $flags = 0): Collection<int, string>

Split a string using a regular expression or by length.

#


					
	public

finish(string $cap): static

Cap a string with a single instance of a given value.

#


					
	public

is(string|iterable<string> $pattern, bool $ignoreCase = false): bool

Determine if a given string matches a given pattern.

#


					
	public

isAscii(): bool

Determine if a given string is 7 bit ASCII.

#


					
	public

isJson(): bool

Determine if a given string is valid JSON.

#


					
	public

isUrl(): bool

Determine if a given value is a valid URL.

#


					
	public

isUuid(): bool

Determine if a given string is a valid UUID.

#


					
	public

isUlid(): bool

Determine if a given string is a valid ULID.

#


					
	public

isEmpty(): bool

Determine if the given string is empty.

#


					
	public

isNotEmpty(): bool

Determine if the given string is not empty.

#


					
	public

kebab(): static

Convert a string to kebab case.

#


					
	public

length(string|null $encoding = null): int

Return the length of the given string.

#


					
	public

limit(int $limit = 100, string $end = '...', bool $preserveWords = false): static

Limit the number of characters in a string.

#


					
	public

lower(): static

Convert the given string to lower-case.

#


					
	public

markdown(array $options = [], array $extensions = []): static

Convert GitHub flavored Markdown into HTML.

#


					
	public

inlineMarkdown(array $options = [], array $extensions = []): static

Convert inline Markdown into HTML.

#


					
	public

mask(string $character, int $index, int|null $length = null, string $encoding = 'UTF-8'): static

Masks a portion of a string with a repeated character.

#


					
	public

match(string $pattern): static

Get the string matching the given pattern.

#


					
	public

isMatch(string|iterable<string> $pattern): bool

Determine if a given string matches a given pattern.

#


					
	public

matchAll(string $pattern): Collection

Get the string matching the given pattern.

#


					
	public

test(string $pattern): bool

Determine if the string matches the given pattern.

#


					
	public

numbers(): static

Remove all non-numeric characters from a string.

#


					
	public

padBoth(int $length, string $pad = ' '): static

Pad both sides of the string with another.

#


					
	public

padLeft(int $length, string $pad = ' '): static

Pad the left side of the string with another.

#


					
	public

padRight(int $length, string $pad = ' '): static

Pad the right side of the string with another.

#


					
	public

parseCallback(string|null $default = null): array<int, string|null>

Parse a Class@method style callback into class and method.

#


					
	public

pipe(callable $callback): static

Call the given callback and return a new string.

#


					
	public

plural(int|array|Countable $count = 2): static

Get the plural form of an English word.

#


					
	public

pluralStudly(int|array|Countable $count = 2): static

Pluralize the last word of an English, studly caps case string.

#


					
	public

pluralPascal(int|array|Countable $count = 2): static

Pluralize the last word of an English, Pascal caps case string.

#


					
	public

position(string $needle, int $offset = 0, string|null $encoding = null): int|false

Find the multi-byte safe position of the first occurrence of the given substring.

#


					
	public

prepend(string ...$values): static

Prepend the given values to the string.

#


					
	public

remove(string|iterable<string> $search, bool $caseSensitive = true): static

Remove any occurrence of the given string in the subject.

#


					
	public

reverse(): static

Reverse the string.

#


					
	public

repeat(int $times): static

Repeat the string.

#


					
	public

replace(string|iterable<string> $search, string|iterable<string> $replace, bool $caseSensitive = true): static

Replace the given value in the given string.

#


					
	public

replaceArray(string $search, iterable<string> $replace): static

Replace a given value in the string sequentially with an array.

#


					
	public

replaceFirst(string $search, string $replace): static

Replace the first occurrence of a given value in the string.

#


					
	public

replaceStart(string $search, string $replace): static

Replace the first occurrence of the given value if it appears at the start of the string.

#


					
	public

replaceLast(string $search, string $replace): static

Replace the last occurrence of a given value in the string.

#


					
	public

replaceEnd(string $search, string $replace): static

Replace the last occurrence of a given value if it appears at the end of the string.

#


					
	public

replaceMatches(array|string $pattern, Closure|string[]|string $replace, int $limit = -1): static

Replace the patterns matching the given regular expression.

#


					
	public

scan(string $format): Collection

Parse input from a string to a collection, according to a format.

#


					
	public

squish(): static

Remove all "extra" blank space from the given string.

#


					
	public

start(string $prefix): static

Begin a string with a single instance of a given value.

#


					
	public

stripTags(string[]|string|null $allowedTags = null): static

Strip HTML and PHP tags from the given string.

#


					
	public

upper(): static

Convert the given string to upper-case.

#


					
	public

title(): static

Convert the given string to proper case.

#


					
	public

headline(): static

Convert the given string to proper case for each word.

#


					
	public

apa(): static

Convert the given string to APA-style title case.

#


					
	public

transliterate(string|null $unknown = '?', bool|null $strict = false): static

Transliterate a string to its closest ASCII representation.

#


					
	public

singular(): static

Get the singular form of an English word.

#


					
	public

slug(string $separator = '-', string|null $language = 'en', array<string, string> $dictionary = ['@' => 'at']): static

Generate a URL friendly "slug" from a given string.

#


					
	public

snake(string $delimiter = '_'): static

Convert a string to snake case.

#


					
	public

startsWith(string|iterable<string> $needles): bool

Determine if a given string starts with a given substring.

#


					
	public

studly(): static

Convert a value to studly caps case.

#


					
	public

pascal(): static

Convert the string to Pascal case.

#


					
	public

substr(int $start, int|null $length = null, string $encoding = 'UTF-8'): static

Returns the portion of the string specified by the start and length parameters.

#


					
	public

substrCount(string $needle, int $offset = 0, int|null $length = null): int

Returns the number of substring occurrences.

#


					
	public

substrReplace(string|string[] $replace, int|int[] $offset = 0, int|int[]|null $length = null): static

Replace text within a portion of a string.

#


					
	public

swap(array $map): static

Swap multiple keywords in a string with other keywords.

#


					
	public

take(int $limit): static

Take the first or last {$limit} characters.

#


					
	public

trim(string $characters = null): static

Trim the string of the given characters.

#


					
	public

ltrim(string $characters = null): static

Left trim the string of the given characters.

#


					
	public

rtrim(string $characters = null): static

Right trim the string of the given characters.

#


					
	public

lcfirst(): static

Make a string's first character lowercase.

#


					
	public

ucfirst(): static

Make a string's first character uppercase.

#


					
	public

ucsplit(): Collection<int, string>

Split a string by uppercase characters.

#


					
	public

whenContains(string|iterable<string> $needles, callable $callback, callable|null $default = null): static

Execute the given callback if the string contains a given substring.

#


					
	public

whenContainsAll(iterable<string> $needles, callable $callback, callable|null $default = null): static

Execute the given callback if the string contains all array values.

#


					
	public

whenEmpty(callable $callback, callable|null $default = null): static

Execute the given callback if the string is empty.

#


					
	public

whenNotEmpty(callable $callback, callable|null $default = null): static

Execute the given callback if the string is not empty.

#


					
	public

whenEndsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null): static

Execute the given callback if the string ends with a given substring.

#


					
	public

whenExactly(string $value, callable $callback, callable|null $default = null): static

Execute the given callback if the string is an exact match with the given value.

#


					
	public

whenNotExactly(string $value, callable $callback, callable|null $default = null): static

Execute the given callback if the string is not an exact match with the given value.

#


					
	public

whenIs(string|iterable<string> $pattern, callable $callback, callable|null $default = null): static

Execute the given callback if the string matches a given pattern.

#


					
	public

whenIsAscii(callable $callback, callable|null $default = null): static

Execute the given callback if the string is 7 bit ASCII.

#


					
	public

whenIsUuid(callable $callback, callable|null $default = null): static

Execute the given callback if the string is a valid UUID.

#


					
	public

whenIsUlid(callable $callback, callable|null $default = null): static

Execute the given callback if the string is a valid ULID.

#


					
	public

whenStartsWith(string|iterable<string> $needles, callable $callback, callable|null $default = null): static

Execute the given callback if the string starts with a given substring.

#


					
	public

whenTest(string $pattern, callable $callback, callable|null $default = null): static

Execute the given callback if the string matches the given pattern.

#


					
	public

words(int $words = 100, string $end = '...'): static

Limit the number of words in a string.

#


					
	public

wordCount(string|null $characters = null): int

Get the number of words a string contains.

#


					
	public

wordWrap(int $characters = 75, string $break = "\n", bool $cutLongWords = false): static

Wrap a string to a given number of characters.

#


					
	public

wrap(string $before, string|null $after = null): static

Wrap the string with the given strings.

#


					
	public

unwrap(string $before, string|null $after = null): static

Unwrap the string with the given strings.

#


					
	public

toHtmlString(): HtmlString

Convert the string into a `HtmlString` instance.

Convert the string into a HtmlString instance.

#


					
	public

toBase64(): static

Convert the string to Base64 encoding.

#


					
	public

fromBase64(bool $strict = false): static

Decode the Base64 encoded string.

#


					
	public

dump(mixed ...$args): $this

Dump the string.

#


					
	public

value(): string

Get the underlying string value.

#


					
	public

toString(): string

Get the underlying string value.

#


					
	public

toInteger(int $base = 10): int

Get the underlying string value as an integer.

#


					
	public

toFloat(): float

Get the underlying string value as a float.

#


					
	public

toBoolean(): bool

Get the underlying string value as a boolean.

Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.

#


					
	public

toDate(string|null $format = null, string|null $tz = null): Carbon

Get the underlying string value as a Carbon instance.

Throws

Carbon\Exceptions\InvalidFormatException

#


					
	public

jsonSerialize(): string

Convert the object to a string when JSON encoded.

Implements

JsonSerializable::jsonSerialize()

#


					
	public

offsetExists(mixed $offset): bool

Determine if the given offset exists.

Implements

ArrayAccess::offsetExists()

#


					
	public

offsetGet(mixed $offset): string

Get the value at the given offset.

Implements

ArrayAccess::offsetGet()

#


					
	public

offsetSet(mixed $offset, mixed $value): void

Set the value at the given offset.

Implements

ArrayAccess::offsetSet()

#


					
	public

offsetUnset(mixed $offset): void

Unset the value at the given offset.

Implements

ArrayAccess::offsetUnset()

#


					
	public

__get(string $key): mixed

Proxy dynamic properties onto methods.

#


					
	public

__toString(): string

Get the raw string value.

Implements

Stringable::__toString()

#

Namespaces

Classes

Interfaces

Traits

Exceptions

Class Illuminate\Support\Stringable

Throws

Implements

Implements

Implements

Implements

Implements

Implements