12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439 |
- <?php
- namespace Illuminate\Support;
- use ArrayAccess;
- use Closure;
- use Illuminate\Support\Facades\Date;
- use Illuminate\Support\Traits\Conditionable;
- use Illuminate\Support\Traits\Macroable;
- use Illuminate\Support\Traits\Tappable;
- use JsonSerializable;
- use Symfony\Component\VarDumper\VarDumper;
- class Stringable implements JsonSerializable, ArrayAccess
- {
- use Conditionable, Macroable, Tappable;
- /**
- * The underlying string value.
- *
- * @var string
- */
- protected $value;
- /**
- * Create a new instance of the class.
- *
- * @param string $value
- * @return void
- */
- public function __construct($value = '')
- {
- $this->value = (string) $value;
- }
- /**
- * Return the remainder of a string after the first occurrence of a given value.
- *
- * @param string $search
- * @return static
- */
- public function after($search)
- {
- return new static(Str::after($this->value, $search));
- }
- /**
- * Return the remainder of a string after the last occurrence of a given value.
- *
- * @param string $search
- * @return static
- */
- public function afterLast($search)
- {
- return new static(Str::afterLast($this->value, $search));
- }
- /**
- * Append the given values to the string.
- *
- * @param array|string ...$values
- * @return static
- */
- public function append(...$values)
- {
- return new static($this->value.implode('', $values));
- }
- /**
- * Append a new line to the string.
- *
- * @param int $count
- * @return $this
- */
- public function newLine($count = 1)
- {
- return $this->append(str_repeat(PHP_EOL, $count));
- }
- /**
- * Transliterate a UTF-8 value to ASCII.
- *
- * @param string $language
- * @return static
- */
- public function ascii($language = 'en')
- {
- return new static(Str::ascii($this->value, $language));
- }
- /**
- * Get the trailing name component of the path.
- *
- * @param string $suffix
- * @return static
- */
- public function basename($suffix = '')
- {
- return new static(basename($this->value, $suffix));
- }
- /**
- * Get the character at the specified index.
- *
- * @param int $index
- * @return string|false
- */
- public function charAt($index)
- {
- return Str::charAt($this->value, $index);
- }
- /**
- * Get the basename of the class path.
- *
- * @return static
- */
- public function classBasename()
- {
- return new static(class_basename($this->value));
- }
- /**
- * Get the portion of a string before the first occurrence of a given value.
- *
- * @param string $search
- * @return static
- */
- public function before($search)
- {
- return new static(Str::before($this->value, $search));
- }
- /**
- * Get the portion of a string before the last occurrence of a given value.
- *
- * @param string $search
- * @return static
- */
- public function beforeLast($search)
- {
- return new static(Str::beforeLast($this->value, $search));
- }
- /**
- * Get the portion of a string between two given values.
- *
- * @param string $from
- * @param string $to
- * @return static
- */
- public function between($from, $to)
- {
- return new static(Str::between($this->value, $from, $to));
- }
- /**
- * Get the smallest possible portion of a string between two given values.
- *
- * @param string $from
- * @param string $to
- * @return static
- */
- public function betweenFirst($from, $to)
- {
- return new static(Str::betweenFirst($this->value, $from, $to));
- }
- /**
- * Convert a value to camel case.
- *
- * @return static
- */
- public function camel()
- {
- return new static(Str::camel($this->value));
- }
- /**
- * Determine if a given string contains a given substring.
- *
- * @param string|iterable<string> $needles
- * @param bool $ignoreCase
- * @return bool
- */
- public function contains($needles, $ignoreCase = false)
- {
- return Str::contains($this->value, $needles, $ignoreCase);
- }
- /**
- * Determine if a given string contains all array values.
- *
- * @param iterable<string> $needles
- * @param bool $ignoreCase
- * @return bool
- */
- public function containsAll($needles, $ignoreCase = false)
- {
- return Str::containsAll($this->value, $needles, $ignoreCase);
- }
- /**
- * Convert the case of a string.
- *
- * @param int $mode
- * @param string|null $encoding
- * @return static
- */
- public function convertCase(int $mode = MB_CASE_FOLD, ?string $encoding = 'UTF-8')
- {
- return new static(Str::convertCase($this->value, $mode, $encoding));
- }
- /**
- * Get the parent directory's path.
- *
- * @param int $levels
- * @return static
- */
- public function dirname($levels = 1)
- {
- return new static(dirname($this->value, $levels));
- }
- /**
- * Determine if a given string ends with a given substring.
- *
- * @param string|iterable<string> $needles
- * @return bool
- */
- public function endsWith($needles)
- {
- return Str::endsWith($this->value, $needles);
- }
- /**
- * Determine if the string is an exact match with the given value.
- *
- * @param \Illuminate\Support\Stringable|string $value
- * @return bool
- */
- public function exactly($value)
- {
- if ($value instanceof Stringable) {
- $value = $value->toString();
- }
- return $this->value === $value;
- }
- /**
- * Extracts an excerpt from text that matches the first instance of a phrase.
- *
- * @param string $phrase
- * @param array $options
- * @return string|null
- */
- public function excerpt($phrase = '', $options = [])
- {
- return Str::excerpt($this->value, $phrase, $options);
- }
- /**
- * Explode the string into an array.
- *
- * @param string $delimiter
- * @param int $limit
- * @return \Illuminate\Support\Collection<int, string>
- */
- public function explode($delimiter, $limit = PHP_INT_MAX)
- {
- return collect(explode($delimiter, $this->value, $limit));
- }
- /**
- * Split a string using a regular expression or by length.
- *
- * @param string|int $pattern
- * @param int $limit
- * @param int $flags
- * @return \Illuminate\Support\Collection<int, string>
- */
- public function split($pattern, $limit = -1, $flags = 0)
- {
- if (filter_var($pattern, FILTER_VALIDATE_INT) !== false) {
- return collect(mb_str_split($this->value, $pattern));
- }
- $segments = preg_split($pattern, $this->value, $limit, $flags);
- return ! empty($segments) ? collect($segments) : collect();
- }
- /**
- * Cap a string with a single instance of a given value.
- *
- * @param string $cap
- * @return static
- */
- public function finish($cap)
- {
- return new static(Str::finish($this->value, $cap));
- }
- /**
- * Determine if a given string matches a given pattern.
- *
- * @param string|iterable<string> $pattern
- * @return bool
- */
- public function is($pattern)
- {
- return Str::is($pattern, $this->value);
- }
- /**
- * Determine if a given string is 7 bit ASCII.
- *
- * @return bool
- */
- public function isAscii()
- {
- return Str::isAscii($this->value);
- }
- /**
- * Determine if a given string is valid JSON.
- *
- * @return bool
- */
- public function isJson()
- {
- return Str::isJson($this->value);
- }
- /**
- * Determine if a given value is a valid URL.
- *
- * @return bool
- */
- public function isUrl()
- {
- return Str::isUrl($this->value);
- }
- /**
- * Determine if a given string is a valid UUID.
- *
- * @return bool
- */
- public function isUuid()
- {
- return Str::isUuid($this->value);
- }
- /**
- * Determine if a given string is a valid ULID.
- *
- * @return bool
- */
- public function isUlid()
- {
- return Str::isUlid($this->value);
- }
- /**
- * Determine if the given string is empty.
- *
- * @return bool
- */
- public function isEmpty()
- {
- return $this->value === '';
- }
- /**
- * Determine if the given string is not empty.
- *
- * @return bool
- */
- public function isNotEmpty()
- {
- return ! $this->isEmpty();
- }
- /**
- * Convert a string to kebab case.
- *
- * @return static
- */
- public function kebab()
- {
- return new static(Str::kebab($this->value));
- }
- /**
- * Return the length of the given string.
- *
- * @param string|null $encoding
- * @return int
- */
- public function length($encoding = null)
- {
- return Str::length($this->value, $encoding);
- }
- /**
- * Limit the number of characters in a string.
- *
- * @param int $limit
- * @param string $end
- * @return static
- */
- public function limit($limit = 100, $end = '...')
- {
- return new static(Str::limit($this->value, $limit, $end));
- }
- /**
- * Convert the given string to lower-case.
- *
- * @return static
- */
- public function lower()
- {
- return new static(Str::lower($this->value));
- }
- /**
- * Convert GitHub flavored Markdown into HTML.
- *
- * @param array $options
- * @return static
- */
- public function markdown(array $options = [])
- {
- return new static(Str::markdown($this->value, $options));
- }
- /**
- * Convert inline Markdown into HTML.
- *
- * @param array $options
- * @return static
- */
- public function inlineMarkdown(array $options = [])
- {
- return new static(Str::inlineMarkdown($this->value, $options));
- }
- /**
- * Masks a portion of a string with a repeated character.
- *
- * @param string $character
- * @param int $index
- * @param int|null $length
- * @param string $encoding
- * @return static
- */
- public function mask($character, $index, $length = null, $encoding = 'UTF-8')
- {
- return new static(Str::mask($this->value, $character, $index, $length, $encoding));
- }
- /**
- * Get the string matching the given pattern.
- *
- * @param string $pattern
- * @return static
- */
- public function match($pattern)
- {
- return new static(Str::match($pattern, $this->value));
- }
- /**
- * Determine if a given string matches a given pattern.
- *
- * @param string|iterable<string> $pattern
- * @return bool
- */
- public function isMatch($pattern)
- {
- return Str::isMatch($pattern, $this->value);
- }
- /**
- * Get the string matching the given pattern.
- *
- * @param string $pattern
- * @return \Illuminate\Support\Collection
- */
- public function matchAll($pattern)
- {
- return Str::matchAll($pattern, $this->value);
- }
- /**
- * Determine if the string matches the given pattern.
- *
- * @param string $pattern
- * @return bool
- */
- public function test($pattern)
- {
- return $this->isMatch($pattern);
- }
- /**
- * Pad both sides of the string with another.
- *
- * @param int $length
- * @param string $pad
- * @return static
- */
- public function padBoth($length, $pad = ' ')
- {
- return new static(Str::padBoth($this->value, $length, $pad));
- }
- /**
- * Pad the left side of the string with another.
- *
- * @param int $length
- * @param string $pad
- * @return static
- */
- public function padLeft($length, $pad = ' ')
- {
- return new static(Str::padLeft($this->value, $length, $pad));
- }
- /**
- * Pad the right side of the string with another.
- *
- * @param int $length
- * @param string $pad
- * @return static
- */
- public function padRight($length, $pad = ' ')
- {
- return new static(Str::padRight($this->value, $length, $pad));
- }
- /**
- * Parse a Class@method style callback into class and method.
- *
- * @param string|null $default
- * @return array<int, string|null>
- */
- public function parseCallback($default = null)
- {
- return Str::parseCallback($this->value, $default);
- }
- /**
- * Call the given callback and return a new string.
- *
- * @param callable $callback
- * @return static
- */
- public function pipe(callable $callback)
- {
- return new static($callback($this));
- }
- /**
- * Get the plural form of an English word.
- *
- * @param int|array|\Countable $count
- * @return static
- */
- public function plural($count = 2)
- {
- return new static(Str::plural($this->value, $count));
- }
- /**
- * Pluralize the last word of an English, studly caps case string.
- *
- * @param int|array|\Countable $count
- * @return static
- */
- public function pluralStudly($count = 2)
- {
- return new static(Str::pluralStudly($this->value, $count));
- }
- /**
- * Find the multi-byte safe position of the first occurrence of the given substring.
- *
- * @param string $needle
- * @param int $offset
- * @param string|null $encoding
- * @return int|false
- */
- public function position($needle, $offset = 0, $encoding = null)
- {
- return Str::position($this->value, $needle, $offset, $encoding);
- }
- /**
- * Prepend the given values to the string.
- *
- * @param string ...$values
- * @return static
- */
- public function prepend(...$values)
- {
- return new static(implode('', $values).$this->value);
- }
- /**
- * Remove any occurrence of the given string in the subject.
- *
- * @param string|iterable<string> $search
- * @param bool $caseSensitive
- * @return static
- */
- public function remove($search, $caseSensitive = true)
- {
- return new static(Str::remove($search, $this->value, $caseSensitive));
- }
- /**
- * Reverse the string.
- *
- * @return static
- */
- public function reverse()
- {
- return new static(Str::reverse($this->value));
- }
- /**
- * Repeat the string.
- *
- * @param int $times
- * @return static
- */
- public function repeat(int $times)
- {
- return new static(str_repeat($this->value, $times));
- }
- /**
- * Replace the given value in the given string.
- *
- * @param string|iterable<string> $search
- * @param string|iterable<string> $replace
- * @param bool $caseSensitive
- * @return static
- */
- public function replace($search, $replace, $caseSensitive = true)
- {
- return new static(Str::replace($search, $replace, $this->value, $caseSensitive));
- }
- /**
- * Replace a given value in the string sequentially with an array.
- *
- * @param string $search
- * @param iterable<string> $replace
- * @return static
- */
- public function replaceArray($search, $replace)
- {
- return new static(Str::replaceArray($search, $replace, $this->value));
- }
- /**
- * Replace the first occurrence of a given value in the string.
- *
- * @param string $search
- * @param string $replace
- * @return static
- */
- public function replaceFirst($search, $replace)
- {
- return new static(Str::replaceFirst($search, $replace, $this->value));
- }
- /**
- * Replace the first occurrence of the given value if it appears at the start of the string.
- *
- * @param string $search
- * @param string $replace
- * @return static
- */
- public function replaceStart($search, $replace)
- {
- return new static(Str::replaceStart($search, $replace, $this->value));
- }
- /**
- * Replace the last occurrence of a given value in the string.
- *
- * @param string $search
- * @param string $replace
- * @return static
- */
- public function replaceLast($search, $replace)
- {
- return new static(Str::replaceLast($search, $replace, $this->value));
- }
- /**
- * Replace the last occurrence of a given value if it appears at the end of the string.
- *
- * @param string $search
- * @param string $replace
- * @return static
- */
- public function replaceEnd($search, $replace)
- {
- return new static(Str::replaceEnd($search, $replace, $this->value));
- }
- /**
- * Replace the patterns matching the given regular expression.
- *
- * @param array|string $pattern
- * @param \Closure|string $replace
- * @param int $limit
- * @return static
- */
- public function replaceMatches($pattern, $replace, $limit = -1)
- {
- if ($replace instanceof Closure) {
- return new static(preg_replace_callback($pattern, $replace, $this->value, $limit));
- }
- return new static(preg_replace($pattern, $replace, $this->value, $limit));
- }
- /**
- * Parse input from a string to a collection, according to a format.
- *
- * @param string $format
- * @return \Illuminate\Support\Collection
- */
- public function scan($format)
- {
- return collect(sscanf($this->value, $format));
- }
- /**
- * Remove all "extra" blank space from the given string.
- *
- * @return static
- */
- public function squish()
- {
- return new static(Str::squish($this->value));
- }
- /**
- * Begin a string with a single instance of a given value.
- *
- * @param string $prefix
- * @return static
- */
- public function start($prefix)
- {
- return new static(Str::start($this->value, $prefix));
- }
- /**
- * Strip HTML and PHP tags from the given string.
- *
- * @param string[]|string|null $allowedTags
- * @return static
- */
- public function stripTags($allowedTags = null)
- {
- return new static(strip_tags($this->value, $allowedTags));
- }
- /**
- * Convert the given string to upper-case.
- *
- * @return static
- */
- public function upper()
- {
- return new static(Str::upper($this->value));
- }
- /**
- * Convert the given string to proper case.
- *
- * @return static
- */
- public function title()
- {
- return new static(Str::title($this->value));
- }
- /**
- * Convert the given string to proper case for each word.
- *
- * @return static
- */
- public function headline()
- {
- return new static(Str::headline($this->value));
- }
- /**
- * Convert the given string to APA-style title case.
- *
- * @return static
- */
- public function apa()
- {
- return new static(Str::apa($this->value));
- }
- /**
- * Transliterate a string to its closest ASCII representation.
- *
- * @param string|null $unknown
- * @param bool|null $strict
- * @return static
- */
- public function transliterate($unknown = '?', $strict = false)
- {
- return new static(Str::transliterate($this->value, $unknown, $strict));
- }
- /**
- * Get the singular form of an English word.
- *
- * @return static
- */
- public function singular()
- {
- return new static(Str::singular($this->value));
- }
- /**
- * Generate a URL friendly "slug" from a given string.
- *
- * @param string $separator
- * @param string|null $language
- * @param array<string, string> $dictionary
- * @return static
- */
- public function slug($separator = '-', $language = 'en', $dictionary = ['@' => 'at'])
- {
- return new static(Str::slug($this->value, $separator, $language, $dictionary));
- }
- /**
- * Convert a string to snake case.
- *
- * @param string $delimiter
- * @return static
- */
- public function snake($delimiter = '_')
- {
- return new static(Str::snake($this->value, $delimiter));
- }
- /**
- * Determine if a given string starts with a given substring.
- *
- * @param string|iterable<string> $needles
- * @return bool
- */
- public function startsWith($needles)
- {
- return Str::startsWith($this->value, $needles);
- }
- /**
- * Convert a value to studly caps case.
- *
- * @return static
- */
- public function studly()
- {
- return new static(Str::studly($this->value));
- }
- /**
- * Returns the portion of the string specified by the start and length parameters.
- *
- * @param int $start
- * @param int|null $length
- * @param string $encoding
- * @return static
- */
- public function substr($start, $length = null, $encoding = 'UTF-8')
- {
- return new static(Str::substr($this->value, $start, $length, $encoding));
- }
- /**
- * Returns the number of substring occurrences.
- *
- * @param string $needle
- * @param int $offset
- * @param int|null $length
- * @return int
- */
- public function substrCount($needle, $offset = 0, $length = null)
- {
- return Str::substrCount($this->value, $needle, $offset, $length);
- }
- /**
- * Replace text within a portion of a string.
- *
- * @param string|string[] $replace
- * @param int|int[] $offset
- * @param int|int[]|null $length
- * @return static
- */
- public function substrReplace($replace, $offset = 0, $length = null)
- {
- return new static(Str::substrReplace($this->value, $replace, $offset, $length));
- }
- /**
- * Swap multiple keywords in a string with other keywords.
- *
- * @param array $map
- * @return static
- */
- public function swap(array $map)
- {
- return new static(strtr($this->value, $map));
- }
- /**
- * Take the first or last {$limit} characters.
- *
- * @param int $limit
- * @return static
- */
- public function take(int $limit)
- {
- if ($limit < 0) {
- return $this->substr($limit);
- }
- return $this->substr(0, $limit);
- }
- /**
- * Trim the string of the given characters.
- *
- * @param string $characters
- * @return static
- */
- public function trim($characters = null)
- {
- return new static(trim(...array_merge([$this->value], func_get_args())));
- }
- /**
- * Left trim the string of the given characters.
- *
- * @param string $characters
- * @return static
- */
- public function ltrim($characters = null)
- {
- return new static(ltrim(...array_merge([$this->value], func_get_args())));
- }
- /**
- * Right trim the string of the given characters.
- *
- * @param string $characters
- * @return static
- */
- public function rtrim($characters = null)
- {
- return new static(rtrim(...array_merge([$this->value], func_get_args())));
- }
- /**
- * Make a string's first character lowercase.
- *
- * @return static
- */
- public function lcfirst()
- {
- return new static(Str::lcfirst($this->value));
- }
- /**
- * Make a string's first character uppercase.
- *
- * @return static
- */
- public function ucfirst()
- {
- return new static(Str::ucfirst($this->value));
- }
- /**
- * Split a string by uppercase characters.
- *
- * @return \Illuminate\Support\Collection<int, string>
- */
- public function ucsplit()
- {
- return collect(Str::ucsplit($this->value));
- }
- /**
- * Execute the given callback if the string contains a given substring.
- *
- * @param string|iterable<string> $needles
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenContains($needles, $callback, $default = null)
- {
- return $this->when($this->contains($needles), $callback, $default);
- }
- /**
- * Execute the given callback if the string contains all array values.
- *
- * @param iterable<string> $needles
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenContainsAll(array $needles, $callback, $default = null)
- {
- return $this->when($this->containsAll($needles), $callback, $default);
- }
- /**
- * Execute the given callback if the string is empty.
- *
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenEmpty($callback, $default = null)
- {
- return $this->when($this->isEmpty(), $callback, $default);
- }
- /**
- * Execute the given callback if the string is not empty.
- *
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenNotEmpty($callback, $default = null)
- {
- return $this->when($this->isNotEmpty(), $callback, $default);
- }
- /**
- * Execute the given callback if the string ends with a given substring.
- *
- * @param string|iterable<string> $needles
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenEndsWith($needles, $callback, $default = null)
- {
- return $this->when($this->endsWith($needles), $callback, $default);
- }
- /**
- * Execute the given callback if the string is an exact match with the given value.
- *
- * @param string $value
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenExactly($value, $callback, $default = null)
- {
- return $this->when($this->exactly($value), $callback, $default);
- }
- /**
- * Execute the given callback if the string is not an exact match with the given value.
- *
- * @param string $value
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenNotExactly($value, $callback, $default = null)
- {
- return $this->when(! $this->exactly($value), $callback, $default);
- }
- /**
- * Execute the given callback if the string matches a given pattern.
- *
- * @param string|iterable<string> $pattern
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenIs($pattern, $callback, $default = null)
- {
- return $this->when($this->is($pattern), $callback, $default);
- }
- /**
- * Execute the given callback if the string is 7 bit ASCII.
- *
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenIsAscii($callback, $default = null)
- {
- return $this->when($this->isAscii(), $callback, $default);
- }
- /**
- * Execute the given callback if the string is a valid UUID.
- *
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenIsUuid($callback, $default = null)
- {
- return $this->when($this->isUuid(), $callback, $default);
- }
- /**
- * Execute the given callback if the string is a valid ULID.
- *
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenIsUlid($callback, $default = null)
- {
- return $this->when($this->isUlid(), $callback, $default);
- }
- /**
- * Execute the given callback if the string starts with a given substring.
- *
- * @param string|iterable<string> $needles
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenStartsWith($needles, $callback, $default = null)
- {
- return $this->when($this->startsWith($needles), $callback, $default);
- }
- /**
- * Execute the given callback if the string matches the given pattern.
- *
- * @param string $pattern
- * @param callable $callback
- * @param callable|null $default
- * @return static
- */
- public function whenTest($pattern, $callback, $default = null)
- {
- return $this->when($this->test($pattern), $callback, $default);
- }
- /**
- * Limit the number of words in a string.
- *
- * @param int $words
- * @param string $end
- * @return static
- */
- public function words($words = 100, $end = '...')
- {
- return new static(Str::words($this->value, $words, $end));
- }
- /**
- * Get the number of words a string contains.
- *
- * @param string|null $characters
- * @return int
- */
- public function wordCount($characters = null)
- {
- return Str::wordCount($this->value, $characters);
- }
- /**
- * Wrap a string to a given number of characters.
- *
- * @param int $characters
- * @param string $break
- * @param bool $cutLongWords
- * @return static
- */
- public function wordWrap($characters = 75, $break = "\n", $cutLongWords = false)
- {
- return new static(Str::wordWrap($this->value, $characters, $break, $cutLongWords));
- }
- /**
- * Wrap the string with the given strings.
- *
- * @param string $before
- * @param string|null $after
- * @return static
- */
- public function wrap($before, $after = null)
- {
- return new static(Str::wrap($this->value, $before, $after));
- }
- /**
- * Unwrap the string with the given strings.
- *
- * @param string $before
- * @param string|null $after
- * @return static
- */
- public function unwrap($before, $after = null)
- {
- return new static(Str::unwrap($this->value, $before, $after));
- }
- /**
- * Convert the string into a `HtmlString` instance.
- *
- * @return \Illuminate\Support\HtmlString
- */
- public function toHtmlString()
- {
- return new HtmlString($this->value);
- }
- /**
- * Convert the string to Base64 encoding.
- *
- * @return static
- */
- public function toBase64()
- {
- return new static(base64_encode($this->value));
- }
- /**
- * Decode the Base64 encoded string.
- *
- * @param bool $strict
- * @return static
- */
- public function fromBase64($strict = false)
- {
- return new static(base64_decode($this->value, $strict));
- }
- /**
- * Dump the string.
- *
- * @return $this
- */
- public function dump()
- {
- VarDumper::dump($this->value);
- return $this;
- }
- /**
- * Dump the string and end the script.
- *
- * @return never
- */
- public function dd()
- {
- $this->dump();
- exit(1);
- }
- /**
- * Get the underlying string value.
- *
- * @return string
- */
- public function value()
- {
- return $this->toString();
- }
- /**
- * Get the underlying string value.
- *
- * @return string
- */
- public function toString()
- {
- return $this->value;
- }
- /**
- * Get the underlying string value as an integer.
- *
- * @param int $base
- * @return int
- */
- public function toInteger($base = 10)
- {
- return intval($this->value, $base);
- }
- /**
- * Get the underlying string value as a float.
- *
- * @return float
- */
- public function toFloat()
- {
- return floatval($this->value);
- }
- /**
- * Get the underlying string value as a boolean.
- *
- * Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.
- *
- * @return bool
- */
- public function toBoolean()
- {
- return filter_var($this->value, FILTER_VALIDATE_BOOLEAN);
- }
- /**
- * Get the underlying string value as a Carbon instance.
- *
- * @param string|null $format
- * @param string|null $tz
- * @return \Illuminate\Support\Carbon
- *
- * @throws \Carbon\Exceptions\InvalidFormatException
- */
- public function toDate($format = null, $tz = null)
- {
- if (is_null($format)) {
- return Date::parse($this->value, $tz);
- }
- return Date::createFromFormat($format, $this->value, $tz);
- }
- /**
- * Convert the object to a string when JSON encoded.
- *
- * @return string
- */
- public function jsonSerialize(): string
- {
- return $this->__toString();
- }
- /**
- * Determine if the given offset exists.
- *
- * @param mixed $offset
- * @return bool
- */
- public function offsetExists(mixed $offset): bool
- {
- return isset($this->value[$offset]);
- }
- /**
- * Get the value at the given offset.
- *
- * @param mixed $offset
- * @return string
- */
- public function offsetGet(mixed $offset): string
- {
- return $this->value[$offset];
- }
- /**
- * Set the value at the given offset.
- *
- * @param mixed $offset
- * @return void
- */
- public function offsetSet(mixed $offset, mixed $value): void
- {
- $this->value[$offset] = $value;
- }
- /**
- * Unset the value at the given offset.
- *
- * @param mixed $offset
- * @return void
- */
- public function offsetUnset(mixed $offset): void
- {
- unset($this->value[$offset]);
- }
- /**
- * Proxy dynamic properties onto methods.
- *
- * @param string $key
- * @return mixed
- */
- public function __get($key)
- {
- return $this->{$key}();
- }
- /**
- * Get the raw string value.
- *
- * @return string
- */
- public function __toString()
- {
- return (string) $this->value;
- }
- }
|