This package provides a handy way to work with strings in php.
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install this package via composer:
composer require spatie/stringFirst you must wrap a native string in a String-object. This can be done with the string-function.
string('myFirstString');From then on you can chain methods like there's no tomorrow:
echostring('StartMiddleEnd')->between('Start', 'End')->toUpper(); // outputs "MIDDLE"Of course you can keep concatenate the output with the .-operator we all know and love.
echo'stuck in the ' . string('StartMiddleEnd')->between('Start', 'End')->toLower() . ' with you';You can also use offsets to manipulate a string.
echostring('hello')[1]->toUpper(); //outputs "E"$string = string('gray');
$string[2] = 'e';
echo$string->toUpper(); //outputs "GREY"/** * Get the string between the given start and end. * * @param $start * @param $end * @return \Spatie\String\String */publicfunction between($start, $end)Example:
string('StartMiddleEnd')->between('Start', 'End')->toUpper(); // MIDDLE/** * Convert the string to uppercase. * * @return \Spatie\String\String */publicfunction toUpper()Example:
string('string')->toUpper(); // STRING/** * Convert the string to lowercase. * * @return \Spatie\String\String */publicfunction toLower()Example:
string('STRING')->toLower(); // string/** * Shortens a string in a pretty way. It will clean it by trimming * it, remove all double spaces and html. If the string is then still * longer than the specified $length it will be shortened. The end * of the string is always a full word concatinated with the * specified moreTextIndicator. * * @param int $length * @param string $moreTextIndicator * @return \Spatie\String\String */publicfunction tease($length = 200, $moreTextIndicator = '...')Example:
$longText = 'Now that there is the Tec-9, a crappy spray gun from South Miami. This gun is advertised as the most popular gun in American crime. Do you believe that shit? It actually says that in the little book that comes with it: the most popular gun in American crime.'string($longText)->tease(10); // Now that.../** * Replace the first occurrence of a string. * * @param $search * @param $replace * @return \Spatie\String\String */publicfunction replaceFirst($search, $replace)Example:
$sentence = 'A good thing is not a good thing.';
string($sentence)->replaceFirst('good', 'bad'); // A bad thing is not a good thing./** * Replace the last occurrence of a string. * * @param $search * @param $replace * @return \Spatie\String\String */publicfunction replaceLast($search, $replace)Example:
$sentence = 'A good thing is not a good thing.';
string($sentence)->replaceLast('good', 'bad'); // A good thing is not a bad thing./** * Prefix a string. * * @param $string * @return \Spatie\String\String */publicfunction prefix($string)Example:
string('world')->prefix('hello '); //hello world/** * Suffix a string. * * @param $string * @return \Spatie\String\String */publicfunction suffix($string)Example:
string('hello')->suffix(' world'); // hello worldThis is identical to the suffix-function.
/** * Get the possessive version of a string. * * @return \Spatie\String\String */publicfunction possessive()Example:
string('Bob')->possessive(); // Bob'sstring('Charles')->possessive(); // Charles'/** * Get a segment from a string based on a delimiter. * Returns an empty string when the offset doesn't exist. * Use a negative index to start counting from the last element. * * @param string $delimiter * @param int $index * * @return \Spatie\String\String */publicfunction segment($delimiter, $index)Related methods:
/** * Get the first segment from a string based on a delimiter. * * @param string $delimiter * * @return \Spatie\String\String */publicfunction firstSegment($delimiter)
/** * Get the last segment from a string based on a delimiter. * * @param string $delimiter * * @return \Spatie\String\String */
public function lastSegment($delimiter)Example:
string('foo/bar/baz')->segment('/', 0); // foostring('foo/bar/baz')->segment('/', 1); // barstring('foo/bar/baz')->firstSegment('/'); // foostring('foo/bar/baz')->lastSegment('/'); // baz/** * Pop (remove) the last segment of a string based on a delimiter * * @param string $delimiter * * @return \Spatie\String\String */publicfunction pop($delimiter)Example:
string('foo/bar/baz')->pop('/'); // foo/barstring('foo/bar/baz')->pop('/')->pop('/'); // foo/** * Check whether a string contains a substring * * @param array|string $needle * @param bool $caseSensitive * @param bool $absolute * * @return bool */publicfunction contains($delimiter)Example:
string('hello world')->contains('world'); // truestring('hello world')->contains('belgium'); // falseIn addition to the methods described above, you can also use all string methods provided by Maxime Fabre's underscore package.
For example:
string('i am a slug')->slugify()` // returns 'i-am-a-slug'Of course, you can chain underscore's methods with our own.
string('i am a slug')->slugify()->between('i', 'a-slug`) // returns '-am-'Be aware that some underscore methods do not return a string value. Such methods are not chainable.
string('freek@spatie.be')->isEmail() // returns true;You can run the tests with:
vendor/bin/phpunitPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
This package is primarily built for usage in our own projects. If you need a more full fledged string package take at look at these ones:
The MIT License (MIT). Please see License File for more information.