| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462 |
- <?php
- namespace Illuminate\Support;
- use ArrayAccess;
- use Closure;
- use Illuminate\Support\Facades\Date;
- use Illuminate\Support\Traits\Conditionable;
- use Illuminate\Support\Traits\Dumpable;
- use Illuminate\Support\Traits\Macroable;
- use Illuminate\Support\Traits\Tappable;
- use JsonSerializable;
- use Stringable as BaseStringable;
- class Stringable implements JsonSerializable, ArrayAccess, BaseStringable
- {
- use Conditionable, Dumpable, 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);
- }
- /**
- * Remove the given string if it exists at the start of the current string.
- *
- * @param string|array $needle
- * @return static
- */
- public function chopStart($needle)
- {
- return new static(Str::chopStart($this->value, $needle));
- }
- /**
- * Remove the given string if it exists at the end of the current string.
- *
- * @param string|array $needle
- * @return static
- */
- public function chopEnd($needle)
- {
- return new static(Str::chopEnd($this->value, $needle));
- }
- /**
- * 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
- * @param array $extensions
- * @return static
- */
- public function markdown(array $options = [], array $extensions = [])
- {
- return new static(Str::markdown($this->value, $options, $extensions));
- }
- /**
- * 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);
- }
- /**
- * Remove all non-numeric characters from a string.
- *
- * @return static
- */
- public function numbers()
- {
- return new static(Str::numbers($this->value));
- }
- /**
- * 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[]|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(Str::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(Str::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(Str::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.
- *
- * @param mixed ...$args
- * @return $this
- */
- public function dump(...$args)
- {
- dump($this->value, ...$args);
- return $this;
- }
- /**
- * 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;
- }
- }
|