Introduction
Laravel includes a variety of global "helper" PHP functions. Many of these functions are used by the framework itself; however, you are free to use them in your own applications if you find them convenient.
Available Methods
Arrays & Objects
Paths
Strings
Fluent Strings
URLs
Miscellaneous
Method Listing
Arrays & Objects
Arr::accessible()
The Arr::accessible
method determines if the given value
is array accessible:
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
$isAccessible = Arr::accessible(['a' => 1, 'b' => 2]);
// true
$isAccessible = Arr::accessible(new Collection);
// true
$isAccessible = Arr::accessible('abc');
// false
$isAccessible = Arr::accessible(new stdClass);
// false
Arr::add()
The Arr::add
method adds a given key / value pair to an
array if the given key doesn't already exist in the array or is set to
null
:
use Illuminate\Support\Arr;
$array = Arr::add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
$array = Arr::add(['name' => 'Desk', 'price' => null], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
Arr::collapse()
The Arr::collapse
method collapses an array of arrays
into a single array:
use Illuminate\Support\Arr;
$array = Arr::collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]
Arr::crossJoin()
The Arr::crossJoin
method cross joins the given arrays,
returning a Cartesian product with all possible permutations:
use Illuminate\Support\Arr;
$matrix = Arr::crossJoin([1, 2], ['a', 'b']);
/*
[
[1, 'a'],
[1, 'b'],
[2, 'a'],
[2, 'b'],
]
*/
$matrix = Arr::crossJoin([1, 2], ['a', 'b'], ['I', 'II']);
/*
[
[1, 'a', 'I'],
[1, 'a', 'II'],
[1, 'b', 'I'],
[1, 'b', 'II'],
[2, 'a', 'I'],
[2, 'a', 'II'],
[2, 'b', 'I'],
[2, 'b', 'II'],
]
*/
Arr::divide()
The Arr::divide
method returns two arrays: one
containing the keys and the other containing the values of the given
array:
use Illuminate\Support\Arr;
[$keys, $values] = Arr::divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
Arr::dot()
The Arr::dot
method flattens a multi-dimensional array
into a single level array that uses "dot" notation to indicate
depth:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$flattened = Arr::dot($array);
// ['products.desk.price' => 100]
Arr::except()
The Arr::except
method removes the given key / value
pairs from an array:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$filtered = Arr::except($array, ['price']);
// ['name' => 'Desk']
Arr::exists()
The Arr::exists
method checks that the given key exists
in the provided array:
use Illuminate\Support\Arr;
$array = ['name' => 'John Doe', 'age' => 17];
$exists = Arr::exists($array, 'name');
// true
$exists = Arr::exists($array, 'salary');
// false
Arr::first()
The Arr::first
method returns the first element of an
array passing a given truth test:
use Illuminate\Support\Arr;
$array = [100, 200, 300];
$first = Arr::first($array, function ($value, $key) {
return $value >= 150;
});
// 200
A default value may also be passed as the third parameter to the method. This value will be returned if no value passes the truth test:
use Illuminate\Support\Arr;
$first = Arr::first($array, $callback, $default);
Arr::flatten()
The Arr::flatten
method flattens a multi-dimensional
array into a single level array:
use Illuminate\Support\Arr;
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$flattened = Arr::flatten($array);
// ['Joe', 'PHP', 'Ruby']
Arr::forget()
The Arr::forget
method removes a given key / value pair
from a deeply nested array using "dot" notation:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::forget($array, 'products.desk');
// ['products' => []]
Arr::get()
The Arr::get
method retrieves a value from a deeply
nested array using "dot" notation:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
$price = Arr::get($array, 'products.desk.price');
// 100
The Arr::get
method also accepts a default value, which
will be returned if the specified key is not present in the array:
use Illuminate\Support\Arr;
$discount = Arr::get($array, 'products.desk.discount', 0);
// 0
Arr::has()
The Arr::has
method checks whether a given item or items
exists in an array using "dot" notation:
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::has($array, 'product.name');
// true
$contains = Arr::has($array, ['product.price', 'product.discount']);
// false
Arr::hasAny()
The Arr::hasAny
method checks whether any item in a
given set exists in an array using "dot" notation:
use Illuminate\Support\Arr;
$array = ['product' => ['name' => 'Desk', 'price' => 100]];
$contains = Arr::hasAny($array, 'product.name');
// true
$contains = Arr::hasAny($array, ['product.name', 'product.discount']);
// true
$contains = Arr::hasAny($array, ['category', 'product.discount']);
// false
Arr::isAssoc()
The Arr::isAssoc
returns true
if the given
array is an associative array. An array is considered "associative" if
it doesn't have sequential numerical keys beginning with zero:
use Illuminate\Support\Arr;
$isAssoc = Arr::isAssoc(['product' => ['name' => 'Desk', 'price' => 100]]);
// true
$isAssoc = Arr::isAssoc([1, 2, 3]);
// false
Arr::last()
The Arr::last
method returns the last element of an
array passing a given truth test:
use Illuminate\Support\Arr;
$array = [100, 200, 300, 110];
$last = Arr::last($array, function ($value, $key) {
return $value >= 150;
});
// 300
A default value may be passed as the third argument to the method. This value will be returned if no value passes the truth test:
use Illuminate\Support\Arr;
$last = Arr::last($array, $callback, $default);
Arr::only()
The Arr::only
method returns only the specified key /
value pairs from the given array:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$slice = Arr::only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
Arr::pluck()
The Arr::pluck
method retrieves all of the values for a
given key from an array:
use Illuminate\Support\Arr;
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$names = Arr::pluck($array, 'developer.name');
// ['Taylor', 'Abigail']
You may also specify how you wish the resulting list to be keyed:
use Illuminate\Support\Arr;
$names = Arr::pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail']
Arr::prepend()
The Arr::prepend
method will push an item onto the
beginning of an array:
use Illuminate\Support\Arr;
$array = ['one', 'two', 'three', 'four'];
$array = Arr::prepend($array, 'zero');
// ['zero', 'one', 'two', 'three', 'four']
If needed, you may specify the key that should be used for the value:
use Illuminate\Support\Arr;
$array = ['price' => 100];
$array = Arr::prepend($array, 'Desk', 'name');
// ['name' => 'Desk', 'price' => 100]
Arr::pull()
The Arr::pull
method returns and removes a key / value
pair from an array:
use Illuminate\Support\Arr;
$array = ['name' => 'Desk', 'price' => 100];
$name = Arr::pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]
A default value may be passed as the third argument to the method. This value will be returned if the key doesn't exist:
use Illuminate\Support\Arr;
$value = Arr::pull($array, $key, $default);
Arr::query()
The Arr::query
method converts the array into a query
string:
use Illuminate\Support\Arr;
$array = [
'name' => 'Taylor',
'order' => [
'column' => 'created_at',
'direction' => 'desc'
]
];
Arr::query($array);
// name=Taylor&order[column]=created_at&order[direction]=desc
Arr::random()
The Arr::random
method returns a random value from an
array:
use Illuminate\Support\Arr;
$array = [1, 2, 3, 4, 5];
$random = Arr::random($array);
// 4 - (retrieved randomly)
You may also specify the number of items to return as an optional second argument. Note that providing this argument will return an array even if only one item is desired:
use Illuminate\Support\Arr;
$items = Arr::random($array, 2);
// [2, 5] - (retrieved randomly)
Arr::set()
The Arr::set
method sets a value within a deeply nested
array using "dot" notation:
use Illuminate\Support\Arr;
$array = ['products' => ['desk' => ['price' => 100]]];
Arr::set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
Arr::shuffle()
The Arr::shuffle
method randomly shuffles the items in
the array:
use Illuminate\Support\Arr;
$array = Arr::shuffle([1, 2, 3, 4, 5]);
// [3, 2, 5, 1, 4] - (generated randomly)
Arr::sort()
The Arr::sort
method sorts an array by its values:
use Illuminate\Support\Arr;
$array = ['Desk', 'Table', 'Chair'];
$sorted = Arr::sort($array);
// ['Chair', 'Desk', 'Table']
You may also sort the array by the results of a given closure:
use Illuminate\Support\Arr;
$array = [
['name' => 'Desk'],
['name' => 'Table'],
['name' => 'Chair'],
];
$sorted = array_values(Arr::sort($array, function ($value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
['name' => 'Table'],
]
*/
Arr::sortRecursive()
The Arr::sortRecursive
method recursively sorts an array
using the sort
function for numerically indexed sub-arrays
and the ksort
function for associative sub-arrays:
use Illuminate\Support\Arr;
$array = [
['Roman', 'Taylor', 'Li'],
['PHP', 'Ruby', 'JavaScript'],
['one' => 1, 'two' => 2, 'three' => 3],
];
$sorted = Arr::sortRecursive($array);
/*
[
['JavaScript', 'PHP', 'Ruby'],
['one' => 1, 'three' => 3, 'two' => 2],
['Li', 'Roman', 'Taylor'],
]
*/
Arr::toCssClasses()
The Arr::toCssClasses
conditionally compiles a CSS class
string. The method accepts an array of classes where the array key
contains the class or classes you wish to add, while the value is a
boolean expression. If the array element has a numeric key, it will
always be included in the rendered class list:
use Illuminate\Support\Arr;
$isActive = false;
$hasError = true;
$array = ['p-4', 'font-bold' => $isActive, 'bg-red' => $hasError];
$classes = Arr::toCssClasses($array);
/*
'p-4 bg-red'
*/
This method powers Laravel's functionality allowing merging classes with a
Blade component's attribute bag as well as the @class
Blade directive.
Arr::undot()
The Arr::undot
method expands a single-dimensional array
that uses "dot" notation into a multi-dimensional array:
use Illuminate\Support\Arr;
$array = [
'user.name' => 'Kevin Malone',
'user.occupation' => 'Accountant',
];
$array = Arr::undot($array);
// ['user' => ['name' => 'Kevin Malone', 'occupation' => 'Accountant']]
Arr::where()
The Arr::where
method filters an array using the given
closure:
use Illuminate\Support\Arr;
$array = [100, '200', 300, '400', 500];
$filtered = Arr::where($array, function ($value, $key) {
return is_string($value);
});
// [1 => '200', 3 => '400']
Arr::whereNotNull()
The Arr::whereNotNull
method removes all
null
values from the given array:
use Illuminate\Support\Arr;
$array = [0, null];
$filtered = Arr::whereNotNull($array);
// [0 => 0]
Arr::wrap()
The Arr::wrap
method wraps the given value in an array.
If the given value is already an array it will be returned without
modification:
use Illuminate\Support\Arr;
$string = 'Laravel';
$array = Arr::wrap($string);
// ['Laravel']
If the given value is null
, an empty array will be
returned:
use Illuminate\Support\Arr;
$array = Arr::wrap(null);
// []
data_fill()
The data_fill
function sets a missing value within a
nested array or object using "dot" notation:
$data = ['products' => ['desk' => ['price' => 100]]];
data_fill($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 100]]]
data_fill($data, 'products.desk.discount', 10);
// ['products' => ['desk' => ['price' => 100, 'discount' => 10]]]
This function also accepts asterisks as wildcards and will fill the target accordingly:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2'],
],
];
data_fill($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 200],
],
]
*/
data_get()
The data_get
function retrieves a value from a nested
array or object using "dot" notation:
$data = ['products' => ['desk' => ['price' => 100]]];
$price = data_get($data, 'products.desk.price');
// 100
The data_get
function also accepts a default value,
which will be returned if the specified key is not found:
$discount = data_get($data, 'products.desk.discount', 0);
// 0
The function also accepts wildcards using asterisks, which may target any key of the array or object:
$data = [
'product-one' => ['name' => 'Desk 1', 'price' => 100],
'product-two' => ['name' => 'Desk 2', 'price' => 150],
];
data_get($data, '*.name');
// ['Desk 1', 'Desk 2'];
data_set()
The data_set
function sets a value within a nested array
or object using "dot" notation:
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
This function also accepts wildcards using asterisks and will set values on the target accordingly:
$data = [
'products' => [
['name' => 'Desk 1', 'price' => 100],
['name' => 'Desk 2', 'price' => 150],
],
];
data_set($data, 'products.*.price', 200);
/*
[
'products' => [
['name' => 'Desk 1', 'price' => 200],
['name' => 'Desk 2', 'price' => 200],
],
]
*/
By default, any existing values are overwritten. If you wish to only
set a value if it doesn't exist, you may pass false
as the
fourth argument to the function:
$data = ['products' => ['desk' => ['price' => 100]]];
data_set($data, 'products.desk.price', 200, $overwrite = false);
// ['products' => ['desk' => ['price' => 100]]]
head()
The head
function returns the first element in the given
array:
$array = [100, 200, 300];
$first = head($array);
// 100
last()
The last
function returns the last element in the given
array:
$array = [100, 200, 300];
$last = last($array);
// 300
Paths
app_path()
The app_path
function returns the fully qualified path
to your application's app
directory. You may also use the
app_path
function to generate a fully qualified path to a
file relative to the application directory:
$path = app_path();
$path = app_path('Http/Controllers/Controller.php');
base_path()
The base_path
function returns the fully qualified path
to your application's root directory. You may also use the
base_path
function to generate a fully qualified path to a
given file relative to the project root directory:
$path = base_path();
$path = base_path('vendor/bin');
config_path()
The config_path
function returns the fully qualified
path to your application's config
directory. You may also
use the config_path
function to generate a fully qualified
path to a given file within the application's configuration
directory:
$path = config_path();
$path = config_path('app.php');
database_path()
The database_path
function returns the fully qualified
path to your application's database
directory. You may also
use the database_path
function to generate a fully
qualified path to a given file within the database directory:
$path = database_path();
$path = database_path('factories/UserFactory.php');
mix()
The mix
function returns the path to a versioned Mix file:
$path = mix('css/app.css');
public_path()
The public_path
function returns the fully qualified
path to your application's public
directory. You may also
use the public_path
function to generate a fully qualified
path to a given file within the public directory:
$path = public_path();
$path = public_path('css/app.css');
resource_path()
The resource_path
function returns the fully qualified
path to your application's resources
directory. You may
also use the resource_path
function to generate a fully
qualified path to a given file within the resources directory:
$path = resource_path();
$path = resource_path('sass/app.scss');
storage_path()
The storage_path
function returns the fully qualified
path to your application's storage
directory. You may also
use the storage_path
function to generate a fully qualified
path to a given file within the storage directory:
$path = storage_path();
$path = storage_path('app/file.txt');
Strings
__()
The __
function translates the given translation string
or translation key using your localization
files:
echo __('Welcome to our application');
echo __('messages.welcome');
If the specified translation string or key does not exist, the
__
function will return the given value. So, using the
example above, the __
function would return
messages.welcome
if that translation key does not
exist.
class_basename()
The class_basename
function returns the class name of
the given class with the class's namespace removed:
$class = class_basename('Foo\Bar\Baz');
// Baz
e()
The e
function runs PHP's htmlspecialchars
function with the double_encode
option set to
true
by default:
echo e('<html>foo</html>');
// <html>foo</html>
preg_replace_array()
The preg_replace_array
function replaces a given pattern
in the string sequentially using an array:
$string = 'The event will take place between :start and :end';
$replaced = preg_replace_array('/:[a-z_]+/', ['8:30', '9:00'], $string);
// The event will take place between 8:30 and 9:00
Str::after()
The Str::after
method returns everything after the given
value in a string. The entire string will be returned if the value does
not exist within the string:
use Illuminate\Support\Str;
$slice = Str::after('This is my name', 'This is');
// ' my name'
Str::afterLast()
The Str::afterLast
method returns everything after the
last occurrence of the given value in a string. The entire string will
be returned if the value does not exist within the string:
use Illuminate\Support\Str;
$slice = Str::afterLast('App\Http\Controllers\Controller', '\\');
// 'Controller'
Str::ascii()
The Str::ascii
method will attempt to transliterate the
string into an ASCII value:
use Illuminate\Support\Str;
$slice = Str::ascii('û');
// 'u'
Str::before()
The Str::before
method returns everything before the
given value in a string:
use Illuminate\Support\Str;
$slice = Str::before('This is my name', 'my name');
// 'This is '
Str::beforeLast()
The Str::beforeLast
method returns everything before the
last occurrence of the given value in a string:
use Illuminate\Support\Str;
$slice = Str::beforeLast('This is my name', 'is');
// 'This '
Str::between()
The Str::between
method returns the portion of a string
between two values:
use Illuminate\Support\Str;
$slice = Str::between('This is my name', 'This', 'name');
// ' is my '
Str::camel()
The Str::camel
method converts the given string to
camelCase
:
use Illuminate\Support\Str;
$converted = Str::camel('foo_bar');
// fooBar
Str::contains()
The Str::contains
method determines if the given string
contains the given value. This method is case sensitive:
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', 'my');
// true
You may also pass an array of values to determine if the given string contains any of the values in the array:
use Illuminate\Support\Str;
$contains = Str::contains('This is my name', ['my', 'foo']);
// true
Str::containsAll()
The Str::containsAll
method determines if the given
string contains all of the values in a given array:
use Illuminate\Support\Str;
$containsAll = Str::containsAll('This is my name', ['my', 'name']);
// true
Str::endsWith()
The Str::endsWith
method determines if the given string
ends with the given value:
use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', 'name');
// true
You may also pass an array of values to determine if the given string ends with any of the values in the array:
use Illuminate\Support\Str;
$result = Str::endsWith('This is my name', ['name', 'foo']);
// true
$result = Str::endsWith('This is my name', ['this', 'foo']);
// false
Str::finish()
The Str::finish
method adds a single instance of the
given value to a string if it does not already end with that value:
use Illuminate\Support\Str;
$adjusted = Str::finish('this/string', '/');
// this/string/
$adjusted = Str::finish('this/string/', '/');
// this/string/
Str::headline()
The Str::headline
method will convert strings delimited
by casing, hyphens, or underscores into a space delimited string with
each word's first letter capitalized:
use Illuminate\Support\Str;
$headline = Str::headline('steve_jobs');
// Steve Jobs
$headline = Str::headline('EmailNotificationSent');
// Email Notification Sent
Str::is()
The Str::is
method determines if a given string matches
a given pattern. Asterisks may be used as wildcard values:
use Illuminate\Support\Str;
$matches = Str::is('foo*', 'foobar');
// true
$matches = Str::is('baz*', 'foobar');
// false
Str::isAscii()
The Str::isAscii
method determines if a given string is
7 bit ASCII:
use Illuminate\Support\Str;
$isAscii = Str::isAscii('Taylor');
// true
$isAscii = Str::isAscii('ü');
// false
Str::isUuid()
The Str::isUuid
method determines if the given string is
a valid UUID:
use Illuminate\Support\Str;
$isUuid = Str::isUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de');
// true
$isUuid = Str::isUuid('laravel');
// false
Str::kebab()
The Str::kebab
method converts the given string to
kebab-case
:
use Illuminate\Support\Str;
$converted = Str::kebab('fooBar');
// foo-bar
Str::length()
The Str::length
method returns the length of the given
string:
use Illuminate\Support\Str;
$length = Str::length('Laravel');
// 7
Str::limit()
The Str::limit
method truncates the given string to the
specified length:
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20);
// The quick brown fox...
You may pass a third argument to the method to change the string that will be appended to the end of the truncated string:
use Illuminate\Support\Str;
$truncated = Str::limit('The quick brown fox jumps over the lazy dog', 20, ' (...)');
// The quick brown fox (...)
Str::lower()
The Str::lower
method converts the given string to
lowercase:
use Illuminate\Support\Str;
$converted = Str::lower('LARAVEL');
// laravel
Str::markdown()
The Str::markdown
method converts GitHub flavored
Markdown into HTML:
use Illuminate\Support\Str;
$html = Str::markdown('# Laravel');
// <h1>Laravel</h1>
$html = Str::markdown('# Taylor <b>Otwell</b>', [
'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>
Str::mask()
The Str::mask
method masks a portion of a string with a
repeated character, and may be used to obfuscate segments of strings
such as email addresses and phone numbers:
use Illuminate\Support\Str;
$string = Str::mask('taylor@example.com', '*', 3);
// tay***************
If needed, you provide a negative number as the third argument to the
mask
method, which will instruct the method to begin
masking at the given distance from the end of the string:
$string = Str::mask('taylor@example.com', '*', -15, 3);
// tay***@example.com
Str::orderedUuid()
The Str::orderedUuid
method generates a "timestamp
first" UUID that may be efficiently stored in an indexed database
column. Each UUID that is generated using this method will be sorted
after UUIDs previously generated using the method:
use Illuminate\Support\Str;
return (string) Str::orderedUuid();
Str::padBoth()
The Str::padBoth
method wraps PHP's str_pad
function, padding both sides of a string with another string until the
final string reaches a desired length:
use Illuminate\Support\Str;
$padded = Str::padBoth('James', 10, '_');
// '__James___'
$padded = Str::padBoth('James', 10);
// ' James '
Str::padLeft()
The Str::padLeft
method wraps PHP's str_pad
function, padding the left side of a string with another string until
the final string reaches a desired length:
use Illuminate\Support\Str;
$padded = Str::padLeft('James', 10, '-=');
// '-=-=-James'
$padded = Str::padLeft('James', 10);
// ' James'
Str::padRight()
The Str::padRight
method wraps PHP's
str_pad
function, padding the right side of a string with
another string until the final string reaches a desired length:
use Illuminate\Support\Str;
$padded = Str::padRight('James', 10, '-');
// 'James-----'
$padded = Str::padRight('James', 10);
// 'James '
Str::plural()
The Str::plural
method converts a singular word string
to its plural form. This function currently only supports the English
language:
use Illuminate\Support\Str;
$plural = Str::plural('car');
// cars
$plural = Str::plural('child');
// children
You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
use Illuminate\Support\Str;
$plural = Str::plural('child', 2);
// children
$singular = Str::plural('child', 1);
// child
Str::pluralStudly()
The Str::pluralStudly
method converts a singular word
string formatted in studly caps case to its plural form. This function
currently only supports the English language:
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman');
// VerifiedHumans
$plural = Str::pluralStudly('UserFeedback');
// UserFeedback
You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
use Illuminate\Support\Str;
$plural = Str::pluralStudly('VerifiedHuman', 2);
// VerifiedHumans
$singular = Str::pluralStudly('VerifiedHuman', 1);
// VerifiedHuman
Str::random()
The Str::random
method generates a random string of the
specified length. This function uses PHP's random_bytes
function:
use Illuminate\Support\Str;
$random = Str::random(40);
Str::remove()
The Str::remove
method removes the given value or array
of values from the string:
use Illuminate\Support\Str;
$string = 'Peter Piper picked a peck of pickled peppers.';
$removed = Str::remove('e', $string);
// Ptr Pipr pickd a pck of pickld ppprs.
You may also pass false
as a third argument to the
remove
method to ignore case when removing strings.
Str::replace()
The Str::replace
method replaces a given string within
the string:
use Illuminate\Support\Str;
$string = 'Laravel 8.x';
$replaced = Str::replace('8.x', '9.x', $string);
// Laravel 9.x
Str::replaceArray()
The Str::replaceArray
method replaces a given value in
the string sequentially using an array:
use Illuminate\Support\Str;
$string = 'The event will take place between ? and ?';
$replaced = Str::replaceArray('?', ['8:30', '9:00'], $string);
// The event will take place between 8:30 and 9:00
Str::replaceFirst()
The Str::replaceFirst
method replaces the first
occurrence of a given value in a string:
use Illuminate\Support\Str;
$replaced = Str::replaceFirst('the', 'a', 'the quick brown fox jumps over the lazy dog');
// a quick brown fox jumps over the lazy dog
Str::replaceLast()
The Str::replaceLast
method replaces the last occurrence
of a given value in a string:
use Illuminate\Support\Str;
$replaced = Str::replaceLast('the', 'a', 'the quick brown fox jumps over the lazy dog');
// the quick brown fox jumps over a lazy dog
Str::reverse()
The Str::reverse
method reverses the given string:
use Illuminate\Support\Str;
$reversed = Str::reverse('Hello World');
// dlroW olleH
Str::singular()
The Str::singular
method converts a string to its
singular form. This function currently only supports the English
language:
use Illuminate\Support\Str;
$singular = Str::singular('cars');
// car
$singular = Str::singular('children');
// child
Str::slug()
The Str::slug
method generates a URL friendly "slug"
from the given string:
use Illuminate\Support\Str;
$slug = Str::slug('Laravel 5 Framework', '-');
// laravel-5-framework
Str::snake()
The Str::snake
method converts the given string to
snake_case
:
use Illuminate\Support\Str;
$converted = Str::snake('fooBar');
// foo_bar
$converted = Str::snake('fooBar', '-');
// foo-bar
Str::start()
The Str::start
method adds a single instance of the
given value to a string if it does not already start with that
value:
use Illuminate\Support\Str;
$adjusted = Str::start('this/string', '/');
// /this/string
$adjusted = Str::start('/this/string', '/');
// /this/string
Str::startsWith()
The Str::startsWith
method determines if the given
string begins with the given value:
use Illuminate\Support\Str;
$result = Str::startsWith('This is my name', 'This');
// true
If an array of possible values is passed, the startsWith
method will return true
if the string begins with any of
the given values:
$result = Str::startsWith('This is my name', ['This', 'That', 'There']);
// true
Str::studly()
The Str::studly
method converts the given string to
StudlyCase
:
use Illuminate\Support\Str;
$converted = Str::studly('foo_bar');
// FooBar
Str::substr()
The Str::substr
method returns the portion of string
specified by the start and length parameters:
use Illuminate\Support\Str;
$converted = Str::substr('The Laravel Framework', 4, 7);
// Laravel
Str::substrCount()
The Str::substrCount
method returns the number of
occurrences of a given value in the given string:
use Illuminate\Support\Str;
$count = Str::substrCount('If you like ice cream, you will like snow cones.', 'like');
// 2
Str::substrReplace()
The Str::substrReplace
method replaces text within a
portion of a string, starting at the position specified by the third
argument and replacing the number of characters specified by the fourth
argument. Passing 0
to the method's fourth argument will
insert the string at the specified position without replacing any of the
existing characters in the string:
use Illuminate\Support\Str;
$result = Str::substrReplace('1300', ':', 2);
// 13:
$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00
Str::title()
The Str::title
method converts the given string to
Title Case
:
use Illuminate\Support\Str;
$converted = Str::title('a nice title uses the correct case');
// A Nice Title Uses The Correct Case
Str::toHtmlString()
The Str::toHtmlString
method converts the string
instance to an instance of Illuminate\Support\HtmlString
,
which may be displayed in Blade templates:
use Illuminate\Support\Str;
$htmlString = Str::of('Nuno Maduro')->toHtmlString();
Str::ucfirst()
The Str::ucfirst
method returns the given string with
the first character capitalized:
use Illuminate\Support\Str;
$string = Str::ucfirst('foo bar');
// Foo bar
Str::upper()
The Str::upper
method converts the given string to
uppercase:
use Illuminate\Support\Str;
$string = Str::upper('laravel');
// LARAVEL
Str::uuid()
The Str::uuid
method generates a UUID (version 4):
use Illuminate\Support\Str;
return (string) Str::uuid();
Str::wordCount()
The Str::wordCount
method returns the number of words
that a string contains:
use Illuminate\Support\Str;
Str::wordCount('Hello, world!'); // 2
Str::words()
The Str::words
method limits the number of words in a
string. An additional string may be passed to this method via its third
argument to specify which string should be appended to the end of the
truncated string:
use Illuminate\Support\Str;
return Str::words('Perfectly balanced, as all things should be.', 3, ' >>>');
// Perfectly balanced, as >>>
trans()
The trans
function translates the given translation key
using your localization files:
echo trans('messages.welcome');
If the specified translation key does not exist, the
trans
function will return the given key. So, using the
example above, the trans
function would return
messages.welcome
if the translation key does not exist.
trans_choice()
The trans_choice
function translates the given
translation key with inflection:
echo trans_choice('messages.notifications', $unreadCount);
If the specified translation key does not exist, the
trans_choice
function will return the given key. So, using
the example above, the trans_choice
function would return
messages.notifications
if the translation key does not
exist.
Fluent Strings
Fluent strings provide a more fluent, object-oriented interface for working with string values, allowing you to chain multiple string operations together using a more readable syntax compared to traditional string operations.
after
The after
method returns everything after the given
value in a string. The entire string will be returned if the value does
not exist within the string:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->after('This is');
// ' my name'
afterLast
The afterLast
method returns everything after the last
occurrence of the given value in a string. The entire string will be
returned if the value does not exist within the string:
use Illuminate\Support\Str;
$slice = Str::of('App\Http\Controllers\Controller')->afterLast('\\');
// 'Controller'
append
The append
method appends the given values to the
string:
use Illuminate\Support\Str;
$string = Str::of('Taylor')->append(' Otwell');
// 'Taylor Otwell'
ascii
The ascii
method will attempt to transliterate the
string into an ASCII value:
use Illuminate\Support\Str;
$string = Str::of('ü')->ascii();
// 'u'
basename
The basename
method will return the trailing name
component of the given string:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->basename();
// 'baz'
If needed, you may provide an "extension" that will be removed from the trailing component:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz.jpg')->basename('.jpg');
// 'baz'
before
The before
method returns everything before the given
value in a string:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->before('my name');
// 'This is '
beforeLast
The beforeLast
method returns everything before the last
occurrence of the given value in a string:
use Illuminate\Support\Str;
$slice = Str::of('This is my name')->beforeLast('is');
// 'This '
between
The between
method returns the portion of a string
between two values:
use Illuminate\Support\Str;
$converted = Str::of('This is my name')->between('This', 'name');
// ' is my '
camel
The camel
method converts the given string to
camelCase
:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->camel();
// fooBar
contains
The contains
method determines if the given string
contains the given value. This method is case sensitive:
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains('my');
// true
You may also pass an array of values to determine if the given string contains any of the values in the array:
use Illuminate\Support\Str;
$contains = Str::of('This is my name')->contains(['my', 'foo']);
// true
containsAll
The containsAll
method determines if the given string
contains all of the values in the given array:
use Illuminate\Support\Str;
$containsAll = Str::of('This is my name')->containsAll(['my', 'name']);
// true
dirname
The dirname
method returns the parent directory portion
of the given string:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname();
// '/foo/bar'
If necessary, you may specify how many directory levels you wish to trim from the string:
use Illuminate\Support\Str;
$string = Str::of('/foo/bar/baz')->dirname(2);
// '/foo'
endsWith
The endsWith
method determines if the given string ends
with the given value:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith('name');
// true
You may also pass an array of values to determine if the given string ends with any of the values in the array:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->endsWith(['name', 'foo']);
// true
$result = Str::of('This is my name')->endsWith(['this', 'foo']);
// false
exactly
The exactly
method determines if the given string is an
exact match with another string:
use Illuminate\Support\Str;
$result = Str::of('Laravel')->exactly('Laravel');
// true
explode
The explode
method splits the string by the given
delimiter and returns a collection containing each section of the split
string:
use Illuminate\Support\Str;
$collection = Str::of('foo bar baz')->explode(' ');
// collect(['foo', 'bar', 'baz'])
finish
The finish
method adds a single instance of the given
value to a string if it does not already end with that value:
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->finish('/');
// this/string/
$adjusted = Str::of('this/string/')->finish('/');
// this/string/
is
The is
method determines if a given string matches a
given pattern. Asterisks may be used as wildcard values
use Illuminate\Support\Str;
$matches = Str::of('foobar')->is('foo*');
// true
$matches = Str::of('foobar')->is('baz*');
// false
isAscii
The isAscii
method determines if a given string is an
ASCII string:
use Illuminate\Support\Str;
$result = Str::of('Taylor')->isAscii();
// true
$result = Str::of('ü')->isAscii();
// false
isEmpty
The isEmpty
method determines if the given string is
empty:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isEmpty();
// true
$result = Str::of('Laravel')->trim()->isEmpty();
// false
isNotEmpty
The isNotEmpty
method determines if the given string is
not empty:
use Illuminate\Support\Str;
$result = Str::of(' ')->trim()->isNotEmpty();
// false
$result = Str::of('Laravel')->trim()->isNotEmpty();
// true
isUuid
The isUuid
method determines if a given string is a
UUID:
use Illuminate\Support\Str;
$result = Str::of('5ace9ab9-e9cf-4ec6-a19d-5881212a452c')->isUuid();
// true
$result = Str::of('Taylor')->isUuid();
// false
kebab
The kebab
method converts the given string to
kebab-case
:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->kebab();
// foo-bar
length
The length
method returns the length of the given
string:
use Illuminate\Support\Str;
$length = Str::of('Laravel')->length();
// 7
limit
The limit
method truncates the given string to the
specified length:
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20);
// The quick brown fox...
You may also pass a second argument to change the string that will be appended to the end of the truncated string:
use Illuminate\Support\Str;
$truncated = Str::of('The quick brown fox jumps over the lazy dog')->limit(20, ' (...)');
// The quick brown fox (...)
lower
The lower
method converts the given string to
lowercase:
use Illuminate\Support\Str;
$result = Str::of('LARAVEL')->lower();
// 'laravel'
ltrim
The ltrim
method trims the left side of the string:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->ltrim();
// 'Laravel '
$string = Str::of('/Laravel/')->ltrim('/');
// 'Laravel/'
markdown
The markdown
method converts GitHub flavored Markdown
into HTML:
use Illuminate\Support\Str;
$html = Str::of('# Laravel')->markdown();
// <h1>Laravel</h1>
$html = Str::of('# Taylor <b>Otwell</b>')->markdown([
'html_input' => 'strip',
]);
// <h1>Taylor Otwell</h1>
mask
The mask
method masks a portion of a string with a
repeated character, and may be used to obfuscate segments of strings
such as email addresses and phone numbers:
use Illuminate\Support\Str;
$string = Str::of('taylor@example.com')->mask('*', 3);
// tay***************
If needed, you provide a negative number as the third argument to the
mask
method, which will instruct the method to begin
masking at the given distance from the end of the string:
$string = Str::of('taylor@example.com')->mask('*', -15, 3);
// tay***@example.com
match
The match
method will return the portion of a string
that matches a given regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('foo bar')->match('/bar/');
// 'bar'
$result = Str::of('foo bar')->match('/foo (.*)/');
// 'bar'
matchAll
The matchAll
method will return a collection containing
the portions of a string that match a given regular expression
pattern:
use Illuminate\Support\Str;
$result = Str::of('bar foo bar')->matchAll('/bar/');
// collect(['bar', 'bar'])
If you specify a matching group within the expression, Laravel will return a collection of that group's matches:
use Illuminate\Support\Str;
$result = Str::of('bar fun bar fly')->matchAll('/f(\w*)/');
// collect(['un', 'ly']);
If no matches are found, an empty collection will be returned.
padBoth
The padBoth
method wraps PHP's str_pad
function, padding both sides of a string with another string until the
final string reaches the desired length:
use Illuminate\Support\Str;
$padded = Str::of('James')->padBoth(10, '_');
// '__James___'
$padded = Str::of('James')->padBoth(10);
// ' James '
padLeft
The padLeft
method wraps PHP's str_pad
function, padding the left side of a string with another string until
the final string reaches the desired length:
use Illuminate\Support\Str;
$padded = Str::of('James')->padLeft(10, '-=');
// '-=-=-James'
$padded = Str::of('James')->padLeft(10);
// ' James'
padRight
The padRight
method wraps PHP's str_pad
function, padding the right side of a string with another string until
the final string reaches the desired length:
use Illuminate\Support\Str;
$padded = Str::of('James')->padRight(10, '-');
// 'James-----'
$padded = Str::of('James')->padRight(10);
// 'James '
pipe
The pipe
method allows you to transform the string by
passing its current value to the given callable:
use Illuminate\Support\Str;
$hash = Str::of('Laravel')->pipe('md5')->prepend('Checksum: ');
// 'Checksum: a5c95b86291ea299fcbe64458ed12702'
$closure = Str::of('foo')->pipe(function ($str) {
return 'bar';
});
// 'bar'
plural
The plural
method converts a singular word string to its
plural form. This function currently only supports the English
language:
use Illuminate\Support\Str;
$plural = Str::of('car')->plural();
// cars
$plural = Str::of('child')->plural();
// children
You may provide an integer as a second argument to the function to retrieve the singular or plural form of the string:
use Illuminate\Support\Str;
$plural = Str::of('child')->plural(2);
// children
$plural = Str::of('child')->plural(1);
// child
prepend
The prepend
method prepends the given values onto the
string:
use Illuminate\Support\Str;
$string = Str::of('Framework')->prepend('Laravel ');
// Laravel Framework
remove
The remove
method removes the given value or array of
values from the string:
use Illuminate\Support\Str;
$string = Str::of('Arkansas is quite beautiful!')->remove('quite');
// Arkansas is beautiful!
You may also pass false
as a second parameter to ignore
case when removing strings.
replace
The replace
method replaces a given string within the
string:
use Illuminate\Support\Str;
$replaced = Str::of('Laravel 6.x')->replace('6.x', '7.x');
// Laravel 7.x
replaceArray
The replaceArray
method replaces a given value in the
string sequentially using an array:
use Illuminate\Support\Str;
$string = 'The event will take place between ? and ?';
$replaced = Str::of($string)->replaceArray('?', ['8:30', '9:00']);
// The event will take place between 8:30 and 9:00
replaceFirst
The replaceFirst
method replaces the first occurrence of
a given value in a string:
use Illuminate\Support\Str;
$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceFirst('the', 'a');
// a quick brown fox jumps over the lazy dog
replaceLast
The replaceLast
method replaces the last occurrence of a
given value in a string:
use Illuminate\Support\Str;
$replaced = Str::of('the quick brown fox jumps over the lazy dog')->replaceLast('the', 'a');
// the quick brown fox jumps over a lazy dog
replaceMatches
The replaceMatches
method replaces all portions of a
string matching a pattern with the given replacement string:
use Illuminate\Support\Str;
$replaced = Str::of('(+1) 501-555-1000')->replaceMatches('/[^A-Za-z0-9]++/', '')
// '15015551000'
The replaceMatches
method also accepts a closure that
will be invoked with each portion of the string matching the given
pattern, allowing you to perform the replacement logic within the
closure and return the replaced value:
use Illuminate\Support\Str;
$replaced = Str::of('123')->replaceMatches('/\d/', function ($match) {
return '['.$match[0].']';
});
// '[1][2][3]'
rtrim
The rtrim
method trims the right side of the given
string:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->rtrim();
// ' Laravel'
$string = Str::of('/Laravel/')->rtrim('/');
// '/Laravel'
scan
The scan
method parses input from a string into a
collection according to a format supported by the sscanf
PHP function:
use Illuminate\Support\Str;
$collection = Str::of('filename.jpg')->scan('%[^.].%s');
// collect(['filename', 'jpg'])
singular
The singular
method converts a string to its singular
form. This function currently only supports the English language:
use Illuminate\Support\Str;
$singular = Str::of('cars')->singular();
// car
$singular = Str::of('children')->singular();
// child
slug
The slug
method generates a URL friendly "slug" from the
given string:
use Illuminate\Support\Str;
$slug = Str::of('Laravel Framework')->slug('-');
// laravel-framework
snake
The snake
method converts the given string to
snake_case
:
use Illuminate\Support\Str;
$converted = Str::of('fooBar')->snake();
// foo_bar
split
The split
method splits a string into a collection using
a regular expression:
use Illuminate\Support\Str;
$segments = Str::of('one, two, three')->split('/[\s,]+/');
// collect(["one", "two", "three"])
start
The start
method adds a single instance of the given
value to a string if it does not already start with that value:
use Illuminate\Support\Str;
$adjusted = Str::of('this/string')->start('/');
// /this/string
$adjusted = Str::of('/this/string')->start('/');
// /this/string
startsWith
The startsWith
method determines if the given string
begins with the given value:
use Illuminate\Support\Str;
$result = Str::of('This is my name')->startsWith('This');
// true
studly
The studly
method converts the given string to
StudlyCase
:
use Illuminate\Support\Str;
$converted = Str::of('foo_bar')->studly();
// FooBar
substr
The substr
method returns the portion of the string
specified by the given start and length parameters:
use Illuminate\Support\Str;
$string = Str::of('Laravel Framework')->substr(8);
// Framework
$string = Str::of('Laravel Framework')->substr(8, 5);
// Frame
substrReplace
The substrReplace
method replaces text within a portion
of a string, starting at the position specified by the third argument
and replacing the number of characters specified by the fourth argument.
Passing 0
to the method's fourth argument will insert the
string at the specified position without replacing any of the existing
characters in the string:
use Illuminate\Support\Str;
$string = Str::of('1300')->substrReplace(':', 2);
// 13:
$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);
// The Laravel Framework
tap
The tap
method passes the string to the given closure,
allowing you to examine and interact with the string while not affecting
the string itself. The original string is returned by the
tap
method regardless of what is returned by the
closure:
use Illuminate\Support\Str;
$string = Str::of('Laravel')
->append(' Framework')
->tap(function ($string) {
dump('String after append: ' . $string);
})
->upper();
// LARAVEL FRAMEWORK
test
The test
method determines if a string matches the given
regular expression pattern:
use Illuminate\Support\Str;
$result = Str::of('Laravel Framework')->test('/Laravel/');
// true
title
The title
method converts the given string to
Title Case
:
use Illuminate\Support\Str;
$converted = Str::of('a nice title uses the correct case')->title();
// A Nice Title Uses The Correct Case
trim
The trim
method trims the given string:
use Illuminate\Support\Str;
$string = Str::of(' Laravel ')->trim();
// 'Laravel'
$string = Str::of('/Laravel/')->trim('/');
// 'Laravel'
ucfirst
The ucfirst
method returns the given string with the
first character capitalized:
use Illuminate\Support\Str;
$string = Str::of('foo bar')->ucfirst();
// Foo bar
upper
The upper
method converts the given string to
uppercase:
use Illuminate\Support\Str;
$adjusted = Str::of('laravel')->upper();
// LARAVEL
when
The when
method invokes the given closure if a given
condition is true
. The closure will receive the fluent
string instance:
use Illuminate\Support\Str;
$string = Str::of('Taylor')
->when(true, function ($string) {
return $string->append(' Otwell');
});
// 'Taylor Otwell'
If necessary, you may pass another closure as the third parameter to
the when
method. This closure will execute if the condition
parameter evaluates to false
.
whenContains
The whenContains
method invokes the given closure if the
string contains the given value. The closure will receive the fluent
string instance:
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContains('tony', function ($string) {
return $string->title();
});
// 'Tony Stark'
If necessary, you may pass another closure as the third parameter to
the when
method. This closure will execute if the string
does not contain the given value.
You may also pass an array of values to determine if the given string contains any of the values in the array:
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContains(['tony', 'hulk'], function ($string) {
return $string->title();
});
// Tony Stark
whenContainsAll
The whenContainsAll
method invokes the given closure if
the string contains all of the given sub-strings. The closure will
receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('tony stark')
->whenContainsAll(['tony', 'stark'], function ($string) {
return $string->title();
});
// 'Tony Stark'
If necessary, you may pass another closure as the third parameter to
the when
method. This closure will execute if the condition
parameter evaluates to false
.
whenEmpty
The whenEmpty
method invokes the given closure if the
string is empty. If the closure returns a value, that value will also be
returned by the whenEmpty
method. If the closure does not
return a value, the fluent string instance will be returned:
use Illuminate\Support\Str;
$string = Str::of(' ')->whenEmpty(function ($string) {
return $string->trim()->prepend('Laravel');
});
// 'Laravel'
whenNotEmpty
The whenNotEmpty
method invokes the given closure if the
string is not empty. If the closure returns a value, that value will
also be returned by the whenNotEmpty
method. If the closure
does not return a value, the fluent string instance will be
returned:
use Illuminate\Support\Str;
$string = Str::of('Framework')->whenNotEmpty(function ($string) {
return $string->prepend('Laravel ');
});
// 'Laravel Framework'
whenStartsWith
The whenStartsWith
method invokes the given closure if
the string starts with the given sub-string. The closure will receive
the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('disney world')->whenStartsWith('disney', function ($string) {
return $string->title();
});
// 'Disney World'
whenEndsWith
The whenEndsWith
method invokes the given closure if the
string ends with the given sub-string. The closure will receive the
fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('disney world')->whenEndsWith('world', function ($string) {
return $string->title();
});
// 'Disney World'
whenExactly
The whenExactly
method invokes the given closure if the
string exactly matches the given string. The closure will receive the
fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('laravel')->whenExactly('laravel', function ($string) {
return $string->title();
});
// 'Laravel'
whenIs
The whenIs
method invokes the given closure if the
string matches a given pattern. Asterisks may be used as wildcard
values. The closure will receive the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIs('foo/*', function ($string) {
return $string->append('/baz');
});
// 'foo/bar/baz'
whenIsAscii
The whenIsAscii
method invokes the given closure if the
string is 7 bit ASCII. The closure will receive the fluent string
instance:
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIsAscii('laravel', function ($string) {
return $string->title();
});
// 'Laravel'
whenIsUuid
The whenIsUuid
method invokes the given closure if the
string is a valid UUID. The closure will receive the fluent string
instance:
use Illuminate\Support\Str;
$string = Str::of('foo/bar')->whenIsUuid('a0a2a2d2-0b87-4a18-83f2-2529882be2de', function ($string) {
return $string->substr(0, 8);
});
// 'a0a2a2d2'
whenTest
The whenTest
method invokes the given closure if the
string matches the given regular expression. The closure will receive
the fluent string instance:
use Illuminate\Support\Str;
$string = Str::of('laravel framework')->whenTest('/laravel/', function ($string) {
return $string->title();
});
// 'Laravel Framework'
wordCount
The wordCount
method returns the number of words that a
string contains:
use Illuminate\Support\Str;
Str::of('Hello, world!')->wordCount(); // 2
words
The words
method limits the number of words in a string.
If necessary, you may specify an additional string that will be appended
to the truncated string:
use Illuminate\Support\Str;
$string = Str::of('Perfectly balanced, as all things should be.')->words(3, ' >>>');
// Perfectly balanced, as >>>
URLs
action()
The action
function generates a URL for the given
controller action:
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
If the method accepts route parameters, you may pass them as the second argument to the method:
$url = action([UserController::class, 'profile'], ['id' => 1]);
asset()
The asset
function generates a URL for an asset using
the current scheme of the request (HTTP or HTTPS):
$url = asset('img/photo.jpg');
You can configure the asset URL host by setting the
ASSET_URL
variable in your .env
file. This can
be useful if you host your assets on an external service like Amazon S3
or another CDN:
// ASSET_URL=http://example.com/assets
$url = asset('img/photo.jpg'); // http://example.com/assets/img/photo.jpg
route()
The route
function generates a URL for a given named route:
$url = route('route.name');
If the route accepts parameters, you may pass them as the second argument to the function:
$url = route('route.name', ['id' => 1]);
By default, the route
function generates an absolute
URL. If you wish to generate a relative URL, you may pass
false
as the third argument to the function:
$url = route('route.name', ['id' => 1], false);
secure_asset()
The secure_asset
function generates a URL for an asset
using HTTPS:
$url = secure_asset('img/photo.jpg');
secure_url()
The secure_url
function generates a fully qualified
HTTPS URL to the given path. Additional URL segments may be passed in
the function's second argument:
$url = secure_url('user/profile');
$url = secure_url('user/profile', [1]);
url()
The url
function generates a fully qualified URL to the
given path:
$url = url('user/profile');
$url = url('user/profile', [1]);
If no path is provided, an
Illuminate\Routing\UrlGenerator
instance is returned:
$current = url()->current();
$full = url()->full();
$previous = url()->previous();
Miscellaneous
abort()
The abort
function throws an HTTP exception which will be
rendered by the exception
handler:
abort(403);
You may also provide the exception's message and custom HTTP response headers that should be sent to the browser:
abort(403, 'Unauthorized.', $headers);
abort_if()
The abort_if
function throws an HTTP exception if a
given boolean expression evaluates to true
:
abort_if(! Auth::user()->isAdmin(), 403);
Like the abort
method, you may also provide the
exception's response text as the third argument and an array of custom
response headers as the fourth argument to the function.
abort_unless()
The abort_unless
function throws an HTTP exception if a
given boolean expression evaluates to false
:
abort_unless(Auth::user()->isAdmin(), 403);
Like the abort
method, you may also provide the
exception's response text as the third argument and an array of custom
response headers as the fourth argument to the function.
app()
The app
function returns the service container instance:
$container = app();
You may pass a class or interface name to resolve it from the container:
$api = app('HelpSpot\API');
auth()
The auth
function returns an authenticator instance. You may use it as
an alternative to the Auth
facade:
$user = auth()->user();
If needed, you may specify which guard instance you would like to access:
$user = auth('admin')->user();
back()
The back
function generates a redirect HTTP response to the user's
previous location:
return back($status = 302, $headers = [], $fallback = '/');
return back();
bcrypt()
The bcrypt
function hashes
the given value using Bcrypt. You may use this function as an
alternative to the Hash
facade:
$password = bcrypt('my-secret-password');
blank()
The blank
function determines whether the given value is
"blank":
blank('');
blank(' ');
blank(null);
blank(collect());
// true
blank(0);
blank(true);
blank(false);
// false
For the inverse of blank
, see the filled
method.
broadcast()
The broadcast
function broadcasts the given event to its listeners:
broadcast(new UserRegistered($user));
broadcast(new UserRegistered($user))->toOthers();
cache()
The cache
function may be used to get values from the cache. If the given key does not exist in the
cache, an optional default value will be returned:
$value = cache('key');
$value = cache('key', 'default');
You may add items to the cache by passing an array of key / value pairs to the function. You should also pass the number of seconds or duration the cached value should be considered valid:
cache(['key' => 'value'], 300);
cache(['key' => 'value'], now()->addSeconds(10));
class_uses_recursive()
The class_uses_recursive
function returns all traits
used by a class, including traits used by all of its parent classes:
$traits = class_uses_recursive(App\Models\User::class);
collect()
The collect
function creates a collection instance from the given
value:
$collection = collect(['taylor', 'abigail']);
config()
The config
function gets the value of a configuration variable. The configuration
values may be accessed using "dot" syntax, which includes the name of
the file and the option you wish to access. A default value may be
specified and is returned if the configuration option does not
exist:
$value = config('app.timezone');
$value = config('app.timezone', $default);
You may set configuration variables at runtime by passing an array of key / value pairs. However, note that this function only affects the configuration value for the current request and does not update your actual configuration values:
config(['app.debug' => true]);
cookie()
The cookie
function creates a new cookie instance:
$cookie = cookie('name', 'value', $minutes);
csrf_field()
The csrf_field
function generates an HTML
hidden
input field containing the value of the CSRF token.
For example, using Blade syntax:
{{ csrf_field() }}
csrf_token()
The csrf_token
function retrieves the value of the
current CSRF token:
$token = csrf_token();
dd()
The dd
function dumps the given variables and ends
execution of the script:
dd($value);
dd($value1, $value2, $value3, ...);
If you do not want to halt the execution of your script, use the dump
function instead.
dispatch()
The dispatch
function pushes the given job onto the Laravel job queue:
dispatch(new App\Jobs\SendEmails);
dump()
The dump
function dumps the given variables:
dump($value);
dump($value1, $value2, $value3, ...);
If you want to stop executing the script after dumping the variables,
use the dd
function instead.
env()
The env
function retrieves the value of an environment
variable or returns a default value:
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
Note: If you execute the
config:cache
command during your deployment process, you should be sure that you are only calling theenv
function from within your configuration files. Once the configuration has been cached, the.env
file will not be loaded and all calls to theenv
function will returnnull
.
event()
The event
function dispatches the given event to its listeners:
event(new UserRegistered($user));
filled()
The filled
function determines whether the given value
is not "blank":
filled(0);
filled(true);
filled(false);
// true
filled('');
filled(' ');
filled(null);
filled(collect());
// false
For the inverse of filled
, see the blank
method.
info()
The info
function will write information to your
application's log:
info('Some helpful information!');
An array of contextual data may also be passed to the function:
info('User login attempt failed.', ['id' => $user->id]);
logger()
The logger
function can be used to write a
debug
level message to the log:
logger('Debug message');
An array of contextual data may also be passed to the function:
logger('User has logged in.', ['id' => $user->id]);
A logger instance will be returned if no value is passed to the function:
logger()->error('You are not allowed here.');
method_field()
The method_field
function generates an HTML
hidden
input field containing the spoofed value of the
form's HTTP verb. For example, using Blade
syntax:
<form method="POST">
{{ method_field('DELETE') }}
</form>
now()
The now
function creates a new
Illuminate\Support\Carbon
instance for the current
time:
$now = now();
old()
The old
function retrieves an old input value flashed into the
session:
$value = old('value');
$value = old('value', 'default');
optional()
The optional
function accepts any argument and allows
you to access properties or call methods on that object. If the given
object is null
, properties and methods will return
null
instead of causing an error:
return optional($user->address)->street;
{!! old('name', optional($user)->name) !!}
The optional
function also accepts a closure as its
second argument. The closure will be invoked if the value provided as
the first argument is not null:
return optional(User::find($id), function ($user) {
return $user->name;
});
policy()
The policy
method retrieves a policy instance for a
given class:
$policy = policy(App\Models\User::class);
redirect()
The redirect
function returns a redirect HTTP response, or returns
the redirector instance if called with no arguments:
return redirect($to = null, $status = 302, $headers = [], $https = null);
return redirect('/home');
return redirect()->route('route.name');
report()
The report
function will report an exception using your
exception handler:
report($e);
The report
function also accepts a string as an
argument. When a string is given to the function, the function will
create an exception with the given string as its message:
report('Something went wrong.');
request()
The request
function returns the current request instance or obtains an input field's
value from the current request:
$request = request();
$value = request('key', $default);
rescue()
The rescue
function executes the given closure and
catches any exceptions that occur during its execution. All exceptions
that are caught will be sent to your exception handler; however,
the request will continue processing:
return rescue(function () {
return $this->method();
});
You may also pass a second argument to the rescue
function. This argument will be the "default" value that should be
returned if an exception occurs while executing the closure:
return rescue(function () {
return $this->method();
}, false);
return rescue(function () {
return $this->method();
}, function () {
return $this->failure();
});
resolve()
The resolve
function resolves a given class or interface
name to an instance using the service
container:
$api = resolve('HelpSpot\API');
response()
The response
function creates a response instance or obtains an instance of
the response factory:
return response('Hello World', 200, $headers);
return response()->json(['foo' => 'bar'], 200, $headers);
retry()
The retry
function attempts to execute the given
callback until the given maximum attempt threshold is met. If the
callback does not throw an exception, its return value will be returned.
If the callback throws an exception, it will automatically be retried.
If the maximum attempt count is exceeded, the exception will be
thrown:
return retry(5, function () {
// Attempt 5 times while resting 100ms in between attempts...
}, 100);
If you would like to manually calculate the number of milliseconds to
sleep in between attempts, you may pass a closure as the third argument
to the retry
function:
return retry(5, function () {
// ...
}, function ($attempt) {
return $attempt * 100;
});
To only retry under specific conditions, you may pass a closure as
the fourth argument to the retry
function:
return retry(5, function () {
// ...
}, 100, function ($exception) {
return $exception instanceof RetryException;
});
session()
The session
function may be used to get or set session values:
$value = session('key');
You may set values by passing an array of key / value pairs to the function:
session(['chairs' => 7, 'instruments' => 3]);
The session store will be returned if no value is passed to the function:
$value = session()->get('key');
session()->put('key', $value);
tap()
The tap
function accepts two arguments: an arbitrary
$value
and a closure. The $value
will be
passed to the closure and then be returned by the tap
function. The return value of the closure is irrelevant:
$user = tap(User::first(), function ($user) {
$user->name = 'taylor';
$user->save();
});
If no closure is passed to the tap
function, you may
call any method on the given $value
. The return value of
the method you call will always be $value
, regardless of
what the method actually returns in its definition. For example, the
Eloquent update
method typically returns an integer.
However, we can force the method to return the model itself by chaining
the update
method call through the tap
function:
$user = tap($user)->update([
'name' => $name,
'email' => $email,
]);
To add a tap
method to a class, you may add the
Illuminate\Support\Traits\Tappable
trait to the class. The
tap
method of this trait accepts a Closure as its only
argument. The object instance itself will be passed to the Closure and
then be returned by the tap
method:
return $user->tap(function ($user) {
//
});
throw_if()
The throw_if
function throws the given exception if a
given boolean expression evaluates to true
:
throw_if(! Auth::user()->isAdmin(), AuthorizationException::class);
throw_if(
! Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
throw_unless()
The throw_unless
function throws the given exception if
a given boolean expression evaluates to false
:
throw_unless(Auth::user()->isAdmin(), AuthorizationException::class);
throw_unless(
Auth::user()->isAdmin(),
AuthorizationException::class,
'You are not allowed to access this page.'
);
today()
The today
function creates a new
Illuminate\Support\Carbon
instance for the current
date:
$today = today();
trait_uses_recursive()
The trait_uses_recursive
function returns all traits
used by a trait:
$traits = trait_uses_recursive(\Illuminate\Notifications\Notifiable::class);
transform()
The transform
function executes a closure on a given
value if the value is not blank and then
returns the return value of the closure:
$callback = function ($value) {
return $value * 2;
};
$result = transform(5, $callback);
// 10
A default value or closure may be passed as the third argument to the function. This value will be returned if the given value is blank:
$result = transform(null, $callback, 'The value is blank');
// The value is blank
validator()
The validator
function creates a new validator instance with the given arguments.
You may use it as an alternative to the Validator
facade:
$validator = validator($data, $rules, $messages);
value()
The value
function returns the value it is given.
However, if you pass a closure to the function, the closure will be
executed and its returned value will be returned:
$result = value(true);
// true
$result = value(function () {
return false;
});
// false
view()
The view
function retrieves a view instance:
return view('auth.login');
with()
The with
function returns the value it is given. If a
closure is passed as the second argument to the function, the closure
will be executed and its returned value will be returned:
$callback = function ($value) {
return is_numeric($value) ? $value * 2 : 0;
};
$result = with(5, $callback);
// 10
$result = with(null, $callback);
// 0
$result = with(5, null);
// 5