Laravel includes a variety of "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.
<style> .collection-method-list > p { column-count: 3; -moz-column-count: 3; -webkit-column-count: 3; column-gap: 2em; -moz-column-gap: 2em; -webkit-column-gap: 2em; } .collection-method-list a { display: block; } </style>The array_add function adds a given key / value pair to the array if the given key doesn't already exist in the array:
$array = array_add(['name' => 'Desk'], 'price', 100);
// ['name' => 'Desk', 'price' => 100]
The array_collapse function collapse an array of arrays into a single array:
$array = array_collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
// [1, 2, 3, 4, 5, 6, 7, 8, 9]
The array_divide function returns two arrays, one containing the keys, and the other containing the values of the original array:
list($keys, $values) = array_divide(['name' => 'Desk']);
// $keys: ['name']
// $values: ['Desk']
The array_dot function flattens a multi-dimensional array into a single level array that uses "dot" notation to indicate depth:
$array = array_dot(['foo' => ['bar' => 'baz']]);
// ['foo.bar' => 'baz'];
The array_except function removes the given key / value pairs from the array:
$array = ['name' => 'Desk', 'price' => 100];
$array = array_except($array, ['price']);
// ['name' => 'Desk']
The array_first function returns the first element of an array passing a given truth test:
$array = [100, 200, 300];
$value = array_first($array, function ($key, $value) {
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:
$value = array_first($array, $callback, $default);
The array_flatten function will flatten a multi-dimensional array into a single level.
$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
$array = array_flatten($array);
// ['Joe', 'PHP', 'Ruby'];
The array_forget function removes a given key / value pair from a deeply nested array using "dot" notation:
$array = ['products' => ['desk' => ['price' => 100]]];
array_forget($array, 'products.desk');
// ['products' => []]
The array_get function retrieves a value from a deeply nested array using "dot" notation:
$array = ['products' => ['desk' => ['price' => 100]]];
$value = array_get($array, 'products.desk');
// ['price' => 100]
The array_get function also accepts a default value, which will be returned if the specific key is not found:
$value = array_get($array, 'names.john', 'default');
The array_has function checks that a given item exists in an array using "dot" notation:
$array = ['products' => ['desk' => ['price' => 100]]];
$hasDesk = array_has($array, 'products.desk');
// true
The array_only function will return only the specified key / value pairs from the given array:
$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
$array = array_only($array, ['name', 'price']);
// ['name' => 'Desk', 'price' => 100]
The array_pluck function will pluck a list of the given key / value pairs from the array:
$array = [
['developer' => ['id' => 1, 'name' => 'Taylor']],
['developer' => ['id' => 2, 'name' => 'Abigail']],
];
$array = array_pluck($array, 'developer.name');
// ['Taylor', 'Abigail'];
You may also specify how you wish the resulting list to be keyed:
$array = array_pluck($array, 'developer.name', 'developer.id');
// [1 => 'Taylor', 2 => 'Abigail'];
The array_prepend function will push an item onto the beginning of an array:
$array = ['one', 'two', 'three', 'four'];
$array = array_prepend($array, 'zero');
// $array: ['zero', 'one', 'two', 'three', 'four']
The array_pull function returns and removes a key / value pair from the array:
$array = ['name' => 'Desk', 'price' => 100];
$name = array_pull($array, 'name');
// $name: Desk
// $array: ['price' => 100]
The array_set function sets a value within a deeply nested array using "dot" notation:
$array = ['products' => ['desk' => ['price' => 100]]];
array_set($array, 'products.desk.price', 200);
// ['products' => ['desk' => ['price' => 200]]]
The array_sort function sorts the array by the results of the given Closure:
$array = [
['name' => 'Desk'],
['name' => 'Chair'],
];
$array = array_values(array_sort($array, function ($value) {
return $value['name'];
}));
/*
[
['name' => 'Chair'],
['name' => 'Desk'],
]
*/
The array_sort_recursive function recursively sorts the array using the sort function:
$array = [
[
'Roman',
'Taylor',
'Li',
],
[
'PHP',
'Ruby',
'JavaScript',
],
];
$array = array_sort_recursive($array);
/*
[
[
'Li',
'Roman',
'Taylor',
],
[
'JavaScript',
'PHP',
'Ruby',
]
];
*/
The array_where function filters the array using the given Closure:
$array = [100, '200', 300, '400', 500];
$array = array_where($array, function ($key, $value) {
return is_string($value);
});
// [1 => 200, 3 => 400]
The head function simply returns the first element in the given array:
$array = [100, 200, 300];
$first = head($array);
// 100
The last function returns the last element in the given array:
$array = [100, 200, 300];
$last = last($array);
// 300
The app_path function returns the fully qualified path to the app directory:
$path = app_path();
You may also use the app_path function to generate a fully qualified path to a given file relative to the application directory:
$path = app_path('Http/Controllers/Controller.php');
The base_path function returns the fully qualified path to the project root:
$path = base_path();
You may also use the base_path function to generate a fully qualified path to a given file relative to the application directory:
$path = base_path('vendor/bin');
The config_path function returns the fully qualified path to the application configuration directory:
$path = config_path();
The database_path function returns the fully qualified path to the application's database directory:
$path = database_path();
The elixir function gets the path to the versioned Elixir file:
elixir($file);
The public_path function returns the fully qualified path to the public directory:
$path = public_path();
The storage_path function returns the fully qualified path to the storage directory:
$path = storage_path();
You may also use the storage_path function to generate a fully qualified path to a given file relative to the storage directory:
$path = storage_path('app/file.txt');
The camel_case function converts the given string to camelCase:
$camel = camel_case('foo_bar');
// fooBar
The class_basename returns the class name of the given class with the class' namespace removed:
$class = class_basename('Foo\Bar\Baz');
// Baz
The e function runs htmlentities over the given string:
echo e('<html>foo</html>');
// <html>foo</html>
The ends_with function determines if the given string ends with the given value:
$value = ends_with('This is my name', 'name');
// true
The snake_case function converts the given string to snake_case:
$snake = snake_case('fooBar');
// foo_bar
The str_limit function limits the number of characters in a string. The function accepts a string as its first argument and the maximum number of resulting characters as its second argument:
$value = str_limit('The PHP framework for web artisans.', 7);
// The PHP...
The starts_with function determines if the given string begins with the given value:
$value = starts_with('This is my name', 'This');
// true
The str_contains function determines if the given string contains the given value:
$value = str_contains('This is my name', 'my');
// true
The str_finish function adds a single instance of the given value to a string:
$string = str_finish('this/string', '/');
// this/string/
The str_is function determines if a given string matches a given pattern. Asterisks may be used to indicate wildcards:
$value = str_is('foo*', 'foobar');
// true
$value = str_is('baz*', 'foobar');
// false
The str_plural function converts a string to its plural form. This function currently only supports the English language:
$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:
$plural = str_plural('child', 2);
// children
$plural = str_plural('child', 1);
// child
The str_random function generates a random string of the specified length:
$string = str_random(40);
The str_singular function converts a string to its singular form. This function currently only supports the English language:
$singular = str_singular('cars');
// car
The str_slug function generates a URL friendly "slug" from the given string:
$title = str_slug("Laravel 5 Framework", "-");
// laravel-5-framework
The studly_case function converts the given string to StudlyCase:
$value = studly_case('foo_bar');
// FooBar
The trans function translates the given language line using your localization files:
echo trans('validation.required'):
The trans_choice function translates the given language line with inflection:
$value = trans_choice('foo.bar', $count);
The action function generates a URL for the given controller action. You do not need to pass the full namespace to the controller. Instead, pass the controller class name relative to the App\Http\Controllers namespace:
$url = action('HomeController@getIndex');
If the method accepts route parameters, you may pass them as the second argument to the method:
$url = action('UserController@profile', ['id' => 1]);
Generate a URL for an asset using the current scheme of the request (HTTP or HTTPS):
$url = asset('img/photo.jpg');
Generate a URL for an asset using HTTPS:
echo secure_asset('foo/bar.zip', $title, $attributes = []);
The route function generates a URL for the given named route:
$url = route('routeName');
If the route accepts parameters, you may pass them as the second argument to the method:
$url = route('routeName', ['id' => 1]);
The url function generates a fully qualified URL to the given path:
echo url('user/profile');
echo url('user/profile', [1]);
If no path is provided, a Illuminate\Routing\UrlGenerator instance is returned:
echo url()->current();
echo url()->full();
echo url()->previous();
The auth function returns an authenticator instance. You may use it instead of the Auth facade for convenience:
$user = auth()->user();
The back() function generates a redirect response to the user's previous location:
return back();
The bcrypt function hashes the given value using Bcrypt. You may use it as an alternative to the Hash facade:
$password = bcrypt('my-secret-password');
The collect function creates a collection instance from the supplied items:
$collection = collect(['taylor', 'abigail']);
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);
The config helper may also be used to set configuration variables at runtime by passing an array of key / value pairs:
config(['app.debug' => true]);
The csrf_field function generates an HTML hidden input field containing the value of the CSRF token. For example, using Blade syntax:
{!! csrf_field() !!}
The csrf_token function retrieves the value of the current CSRF token:
$token = csrf_token();
The dd function dumps the given variable and ends execution of the script:
dd($value);
If you do not want to halt the execution of your script, use the dump function instead:
dump($value);
The dispatch function pushes a new job onto the Laravel job queue:
dispatch(new App\Jobs\SendEmails);
The env function gets the value of an environment variable or returns a default value:
$env = env('APP_ENV');
// Return a default value if the variable doesn't exist...
$env = env('APP_ENV', 'production');
The event function dispatches the given event to its listeners:
event(new UserRegistered($user));
The factory function creates a model factory builder for a given class, name, and amount. It can be used while testing or seeding:
$user = factory(App\User::class)->make();
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>
The old function retrieves an old input value flashed into the session:
$value = old('value');
$value = old('value', 'default');
The redirect function returns an instance of the redirector to do redirects:
return redirect('/home');
The request function returns the current request instance or obtains an input item:
$request = request();
$value = request('key', $default = null)
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);
The session function may be used to get / set a session value:
$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);
The value function's behavior will simply return the value it is given. However, if you pass a Closure to the function, the Closure will be executed then its result will be returned:
$value = value(function() { return 'bar'; });
The view function retrieves a view instance:
return view('auth.login');
The with function returns the value it is given. This function is primarily useful for method chaining where it would otherwise be impossible:
$value = with(new Foo)->work();