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.
You can install this package via composer:
composer require spatie/stringYou're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
First 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:
echo string('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.
echo string('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
*/
public function between($start, $end)Example:
string('StartMiddleEnd')->between('Start', 'End')->toUpper(); // MIDDLE/**
* Convert the string to uppercase.
*
* @return \Spatie\String\String
*/
public function toUpper()Example:
string('string')->toUpper(); // STRING/**
* Convert the string to lowercase.
*
* @return \Spatie\String\String
*/
public function 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
*/
public function 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 last occurrence of a string.
*
* @param $search
* @param $replace
* @return \Spatie\String\String
*/
public function 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
*/
public function prefix($string)Example:
string('world')->prefix('hello '); //hello world/**
* Suffix a string.
*
* @param $string
* @return \Spatie\String\String
*/
public function 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
*/
public function possessive()Example:
string('Bob')->possessive(); // Bob's
string('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
*/
public function segment($delimiter, $index)Related methods:
/**
* Get the first segment from a string based on a delimiter.
*
* @param string $delimiter
*
* @return \Spatie\String\String
*/
public function 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); // foo
string('foo/bar/baz')->segment('/', 1); // bar
string('foo/bar/baz')->segment('/', 0, true); // baz
string('foo/bar/baz')->firstSegment('/'); // foo
string('foo/bar/baz')->lastSegment('/'); // baz/**
* Pop (remove) the last segment of a string based on a delimiter
*
* @param string $delimiter
*
* @return \Spatie\String\String
*/
public function pop($delimiter)Example:
string('foo/bar/baz')->pop('/'); // foo/bar
string('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
*/
public function contains($delimiter)Example:
string('hello world')->contains('world'); // true
string('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;Please see CHANGELOG for more information what has changed recently.
You can run the tests with:
vendor/bin/phpunitWe are very happy to receive pull requests to add functions to this class. Please see CONTRIBUTING for details.
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
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.