#Strings

Phuture\Coherence\Type\Strings

class Strings extends FluentClass implements Stringable, \Stringable

A fluent wrapper around the Strings utility class for chainable string manipulation.

Each method delegates to the corresponding static method on \Phuture\Coherence\Strings, stores the result internally, and returns $this to enable method chaining. Retrieve the final value by calling get() or invoking the object directly.

Example:

1use Phuture\Coherence\Type\Strings;
2
3$result = Strings::from('  hello_world  ')
4    ->trim()
5    ->replace('_', ' ')
6    ->upper()
7    ->take(5)
8    ->get();
9// 'HELLO'

#Methods

#__toString()

public function __toString(): string

Returns the string representation of the wrapped value.

Returns string — The wrapped string value

#addCSlashes()

public function addCSlashes(string $characters): self

Escapes specific characters using C-style backslash notation.

Returns self — Returns the current instance for method chaining

See also

• Transformer::addCSlashes()

#addSlashes()

public function addSlashes(): self

Escapes single quotes, double quotes, backslashes, and NUL bytes.

Returns self — Returns the current instance for method chaining

See also

• Transformer::addSlashes()

#after()

public function after(string $search): self

Returns the portion of the string after the first occurrence of a search value.

Returns self — Returns the current instance for method chaining

See also

• Transformer::after()

#afterLast()

public function afterLast(string $search): self

Returns the portion of the string after the last occurrence of a search value.

Returns self — Returns the current instance for method chaining

See also

• Transformer::afterLast()

#ascii()

public function ascii(string $language = 'en'): self

Transliterates the string to its ASCII representation.

Returns self — Returns the current instance for method chaining

See also

• Transformer::ascii()

#before()

public function before(string $search): self

Returns the portion of the string before the first occurrence of a search value.

Returns self — Returns the current instance for method chaining

See also

• Transformer::before()

#beforeLast()

public function beforeLast(string $search): self

Returns the portion of the string before the last occurrence of a search value.

Returns self — Returns the current instance for method chaining

See also

• Transformer::beforeLast()

#between()

public function between(string $start, string $end): self

Returns the portion of the string between two delimiter values.

Returns self — Returns the current instance for method chaining

See also

• Transformer::between()

#camel()

public function camel(): self

Converts the string to camelCase.

Returns self — Returns the current instance for method chaining

See also

• Transformer::camel()

#censor()

public function censor(array $bannedWords, string $replacement = '***'): self

Censors all occurrences of banned words by replacing them with a substitution.

Returns self — Returns the current instance for method chaining

See also

• Transformer::censor()

#charAt()

public function charAt(int $index): self

Returns the character at the given index position.

Returns self — Returns the current instance for method chaining

See also

• Transformer::charAt()

#dedupe()

public function dedupe(string $character = ' '): self

Collapses consecutive duplicate occurrences of a character.

Returns self — Returns the current instance for method chaining

See also

• Transformer::dedupe()

#distance()

public function distance(string $other): self

Calculates the Levenshtein edit distance between the string and another string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::distance()

#entityDecode()

public function entityDecode(int $flags = ENT_QUOTES | ENT_SUBSTITUTE): self

Converts HTML entities back to their corresponding characters.

Returns self — Returns the current instance for method chaining

See also

• Transformer::entityDecode()

#entityEncode()

public function entityEncode(int $flags = ENT_QUOTES | ENT_SUBSTITUTE): self

Converts all applicable characters to HTML entities.

Returns self — Returns the current instance for method chaining

See also

• Transformer::entityEncode()

#excerpt()

public function excerpt(string $phrase, int $radius = 100, string $omission = '...'): self

Extracts a contextual excerpt of the string around a given phrase.

Returns self — Returns the current instance for method chaining

See also

• Transformer::excerpt()

#finish()

public function finish(string $suffix): self

Ensures the string ends with exactly one occurrence of the given suffix.

Returns self — Returns the current instance for method chaining

See also

• Transformer::finish()

#first()

public function first(int $count = 1): self

Returns the first N characters of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::first()

#fixEncoding()

public function fixEncoding(): self

Fixes invalid byte sequences in the string using the current encoding.

Returns self — Returns the current instance for method chaining

See also

• Transformer::fixEncoding()

#fromBase64()

public function fromBase64(): self

Decodes a Base64-encoded string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::fromBase64()

#fromHex()

public function fromHex(): self

Decodes a hex-encoded binary string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::fromHex()

#hamming()

public function hamming(string $other): self

Calculates the Hamming distance between the string and another string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::hamming()

#headline()

public function headline(): self

Converts the string to a human-readable headline format.

Returns self — Returns the current instance for method chaining

See also

• Transformer::headline()

#highlight()

public function highlight(string $phrase, string $tagOpen = '<mark>', string $tagClose = '</mark>'): self

Highlights all occurrences of a phrase by wrapping them in tags.

Returns self — Returns the current instance for method chaining

See also

• Transformer::highlight()

#indent()

public function indent(int $level = 1, string $indentChar = "\t"): self

Adds indentation to each line of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::indent()

#insert()

public function insert(string $substring, int $index): self

Inserts a substring into the string at the given index position.

Returns self — Returns the current instance for method chaining

See also

• Transformer::insert()

#jaro()

public function jaro(string $other): self

Calculates the Jaro similarity between the string and another string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::jaro()

#jaroWinkler()

public function jaroWinkler(string $other, float $prefixScale = 0.1): self

Calculates the Jaro-Winkler similarity between the string and another string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::jaroWinkler()

#kebab()

public function kebab(): self

Converts the string to kebab-case.

Returns self — Returns the current instance for method chaining

See also

• Transformer::kebab()

#last()

public function last(int $count = 1): self

Returns the last N characters of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::last()

#limit()

public function limit(int $limit, string $end = ''): self

Limits the string to a given number of characters, appending an omission marker.

Returns self — Returns the current instance for method chaining

See also

• Transformer::limit()

#lower()

public function lower(): self

Converts the string to lowercase.

Returns self — Returns the current instance for method chaining

See also

• Transformer::lower()

#lowerFirst()

public function lowerFirst(): self

Converts only the first character of the string to lowercase.

Returns self — Returns the current instance for method chaining

See also

• Transformer::lowerFirst()

#mask()

public function mask(string $mask = '*', int $offset = 0, ?int $length = null): self

Masks a portion of the string with a repeated mask character.

Returns self — Returns the current instance for method chaining

See also

• Transformer::mask()

#metaphone()

public function metaphone(int $maxPhonemes = 0): self

Calculates the metaphone phonetic key of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::metaphone()

#nl2br()

public function nl2br(bool $useXhtml = true): self

Inserts HTML line breaks before all newlines.

Returns self — Returns the current instance for method chaining

See also

• Transformer::nl2br()

#normalizeNewLines()

public function normalizeNewLines(): self

Normalizes line endings to Unix-style \n.

Returns self — Returns the current instance for method chaining

See also

• Transformer::normalizeNewLines()

#pad()

public function pad(int $length, string $padString = ' ', PadDirection $direction = PadDirection::Right): self

Pads the string to a given length using a pad string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::pad()
• \Phuture\Coherence\Enum\PadDirection

#pascal()

public function pascal(): self

Converts the string to PascalCase (StudlyCase).

Returns self — Returns the current instance for method chaining

See also

• Transformer::pascal()

#quoteMeta()

public function quoteMeta(): self

Escapes regular expression meta-characters.

Returns self — Returns the current instance for method chaining

See also

• Transformer::quoteMeta()

#remove()

public function remove(string $search, bool $caseSensitive = true): self

Removes all occurrences of a search value from the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::remove()

#repeat()

public function repeat(int $times): self

Repeats the string a given number of times.

Returns self — Returns the current instance for method chaining

See also

• Transformer::repeat()

#replace()

public function replace(string $search, string $replace, bool $caseSensitive = true): self

Replaces all occurrences of a search value with a replacement.

Returns self — Returns the current instance for method chaining

See also

• Transformer::replace()

#replaceArray()

public function replaceArray(string $search, array $replacements): self

Replaces successive occurrences of a search value using values from an array.

Returns self — Returns the current instance for method chaining

See also

• Transformer::replaceArray()

#replaceAt()

public function replaceAt(string $replacement, int $position, ?int $length = null): self

Replaces a portion of the string starting at a given character position.

Returns self — Returns the current instance for method chaining

See also

• Transformer::replaceAt()

#replaceFirst()

public function replaceFirst(string $search, string $replace): self

Replaces the first occurrence of a search value with a replacement.

Returns self — Returns the current instance for method chaining

See also

• Transformer::replaceFirst()

#replaceLast()

public function replaceLast(string $search, string $replace): self

Replaces the last occurrence of a search value with a replacement.

Returns self — Returns the current instance for method chaining

See also

• Transformer::replaceLast()

#reverse()

public function reverse(): self

Reverses the string character by character.

Returns self — Returns the current instance for method chaining

See also

• Transformer::reverse()

#rot13()

public function rot13(): self

Applies the ROT13 encoding to the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::rot13()

#scrub()

public function scrub(): self

Removes dangerous control characters from the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::scrub()

#search()

public function search(string $search, bool $beforeNeedle = false, bool $caseSensitive = true): self

Returns the portion of the string from the first occurrence of a search value.

Returns self — Returns the current instance for method chaining

See also

• Transformer::search()

#setEncoding()

public function setEncoding(string $encoding): self

Sets the character encoding used for all multibyte operations in the chain.

Changes the encoding applied by every subsequent method call on this instance. The default encoding is 'UTF-8'.

Example:

1use Phuture\Coherence\Type\Strings;
2
3$result = Strings::from('héllo')
4    ->setEncoding('UTF-8')
5    ->upper()
6    ->get();
7// Returns 'HÉLLO'

Returns self — Returns the current instance for method chaining

#shuffle()

public function shuffle(): self

Randomly shuffles the characters in the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::shuffle()

#similar()

public function similar(string $other): self

Calculates the similarity percentage between the string and another string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::similar()

#slice()

public function slice(int $start, ?int $length = null): self

Extracts a portion of the string by start position and optional length.

Returns self — Returns the current instance for method chaining

See also

• Transformer::slice()

#slug()

public function slug(string $separator = '-', string $language = 'en'): self

Generates a URL-friendly slug from the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::slug()

#snake()

public function snake(string $delimiter = '_'): self

Converts the string to snake_case with a configurable delimiter.

Returns self — Returns the current instance for method chaining

See also

• Transformer::snake()

#soundex()

public function soundex(): self

Calculates the soundex phonetic key of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::soundex()

#squish()

public function squish(): self

Collapses all whitespace sequences into a single space and trims the result.

Returns self — Returns the current instance for method chaining

See also

• Transformer::squish()

#start()

public function start(string $prefix): self

Ensures the string begins with exactly one occurrence of the given prefix.

Returns self — Returns the current instance for method chaining

See also

• Transformer::start()

#strip()

public function strip(string $allowedTags = ''): self

Strips HTML and PHP tags from the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::strip()

#stripCSlashes()

public function stripCSlashes(): self

Removes C-style backslash escapes.

Returns self — Returns the current instance for method chaining

See also

• Transformer::stripCSlashes()

#stripSlashes()

public function stripSlashes(): self

Removes backslash escapes added by addSlashes.

Returns self — Returns the current instance for method chaining

See also

• Transformer::stripSlashes()

#swap()

public function swap(array $replacements): self

Performs multiple simultaneous search-and-replace operations.

Returns self — Returns the current instance for method chaining

See also

• Transformer::swap()

#take()

public function take(int $count): self

Returns the first or last N characters based on the sign of count.

Returns self — Returns the current instance for method chaining

See also

• Transformer::take()

#title()

public function title(): self

Converts every word in the string to Title Case.

Returns self — Returns the current instance for method chaining

See also

• Transformer::title()

#toBase64()

public function toBase64(): self

Encodes the string to its Base64 representation.

Returns self — Returns the current instance for method chaining

See also

• Transformer::toBase64()

#toHex()

public function toHex(): self

Converts the string to its hexadecimal representation.

Returns self — Returns the current instance for method chaining

See also

• Transformer::toHex()

#toString()

public function toString(): string

Converts the wrapped value to a string.

Returns string — The wrapped string value

#trim()

public function trim(?string $characters = null): self

Strips whitespace (or given characters) from both ends of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::trim()

#trimLeft()

public function trimLeft(?string $characters = null): self

Strips whitespace (or given characters) from the beginning of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::trimLeft()

#trimRight()

public function trimRight(?string $characters = null): self

Strips whitespace (or given characters) from the end of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::trimRight()

#unwrap()

public function unwrap(string $wrapper): self

Removes a surrounding wrapper string from both ends of the string.

Returns self — Returns the current instance for method chaining

See also

• Transformer::unwrap()

#upper()

public function upper(): self

Converts the string to uppercase.

Returns self — Returns the current instance for method chaining

See also

• Transformer::upper()

#upperFirst()

public function upperFirst(): self

Converts only the first character of the string to uppercase.

Returns self — Returns the current instance for method chaining

See also

• Transformer::upperFirst()

#wordWrap()

public function wordWrap(int $width = 75, string $break = "\n", bool $cutLongWords = false): self

Wraps the string at a given number of characters.

Returns self — Returns the current instance for method chaining

See also

• Transformer::wordWrap()

#wrap()

public function wrap(string $wrapper): self

Wraps the string with a given wrapper string on both sides.

Returns self — Returns the current instance for method chaining

See also

• Transformer::wrap()