Helper Functions

Introduction
Available Methods

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

Method Listing

Arrays

`array_add()`

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]

`array_collapse()`

The array_collapse function collapses 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]

`array_divide()`

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']

`array_dot()`

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'];

`array_except()`

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']

`array_first()`

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 ($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:

$value = array_first($array, $callback, $default);

`array_flatten()`

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'];

`array_forget()`

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' => []]

`array_get()`

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');

`array_has()`

The array_has function checks that a given item or items exists in an array using "dot" notation:

$array = ['product' => ['name' => 'desk', 'price' => 100]];
 
$hasItem = array_has($array, 'product.name');
 
// true
 
$hasItems = array_has($array, ['product.price', 'product.discount']);
 
// false

`array_last()`

The array_last function returns the last element of an array passing a given truth test:

$array = [100, 200, 300, 110];
 
$value = array_last($array, function ($value, $key) {
    return $value >= 150;
});
 
// 300

`array_only()`

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]

`array_pluck()`

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'];

`array_prepend()`

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']

`array_pull()`

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]

`array_set()`

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]]]

`array_sort()`

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'],
    ]
*/

`array_sort_recursive()`

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',
        ]
    ];
*/

`array_where()`

The array_where function filters the array using the given Closure:

$array = [100, '200', 300, '400', 500];
 
$array = array_where($array, function ($value, $key) {
    return is_string($value);
});
 
// [1 => 200, 3 => 400]

`head()`

The head function simply 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 the 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 the project root. 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 the application configuration directory:

$path = config_path();

`database_path()`

The database_path function returns the fully qualified path to the application's database directory:

$path = database_path();

`elixir()`

The elixir function gets the path to a versioned Elixir file:

elixir($file);

`public_path()`

The public_path function returns the fully qualified path to the public directory:

$path = public_path();

`resource_path()`

The resource_path function returns the fully qualified path to the resources directory. You may also use the resource_path function to generate a fully qualified path to a given file relative to the storage directory:

$path = resource_path();
 
$path = resource_path('assets/sass/app.scss');

`storage_path()`

The storage_path function returns the fully qualified path to the storage directory. 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();
 
$path = storage_path('app/file.txt');

Strings

`camel_case()`

The camel_case function converts the given string to camelCase:

$camel = camel_case('foo_bar');
 
// fooBar

`class_basename()`

The class_basename returns the class name of the given class with the class' namespace removed:

$class = class_basename('Foo\Bar\Baz');
 
// Baz

`e()`

The e function runs htmlspecialchars over the given string:

echo e('<html>foo</html>');
 
// &lt;html&gt;foo&lt;/html&gt;

`ends_with()`

The ends_with function determines if the given string ends with the given value:

$value = ends_with('This is my name', 'name');
 
// true

`snake_case()`

The snake_case function converts the given string to snake_case:

$snake = snake_case('fooBar');
 
// foo_bar

`str_limit()`

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...

`starts_with()`

The starts_with function determines if the given string begins with the given value:

$value = starts_with('This is my name', 'This');
 
// true

`str_contains()`

The str_contains function determines if the given string contains the given value:

$value = 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:

$value = str_contains('This is my name', ['my', 'foo']);
 
// true

`str_finish()`

The str_finish function adds a single instance of the given value to a string:

$string = str_finish('this/string', '/');
 
// this/string/

`str_is()`

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

`str_plural()`

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

`str_random()`

The str_random function generates a random string of the specified length. This function uses PHP's random_bytes function:

$string = str_random(40);

`str_singular()`

The str_singular function converts a string to its singular form. This function currently only supports the English language:

$singular = str_singular('cars');
 
// car

`str_slug()`

The str_slug function generates a URL friendly "slug" from the given string:

$title = str_slug('Laravel 5 Framework', '-');
 
// laravel-5-framework

`studly_case()`

The studly_case function converts the given string to StudlyCase:

$value = studly_case('foo_bar');
 
// FooBar

`title_case()`

The title_case function converts the given string to Title Case:

$title = title_case('a nice title uses the correct case');
 
// A Nice Title Uses The Correct Case

`trans()`

The trans function translates the given language line using your localization files:

echo trans('validation.required'):

`trans_choice()`

The trans_choice function translates the given language line with inflection:

$value = trans_choice('foo.bar', $count);

URLs

`action()`

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]);

`asset()`

Generate a URL for an asset using the current scheme of the request (HTTP or HTTPS):

$url = asset('img/photo.jpg');

`secure_asset()`

Generate a URL for an asset using HTTPS:

echo secure_asset('foo/bar.zip', $title, $attributes = []);

`route()`

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]);

`secure_url()`

The secure_url function generates a fully qualified HTTPS URL to the given path:

echo secure_url('user/profile');
 
echo secure_url('user/profile', [1]);

`url()`

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();

Miscellaneous

`abort()`

The abort function throws a HTTP exception which will be rendered by the exception handler:

abort(401);

You may also provide the exception's response text:

abort(401, 'Unauthorized.');

`abort_if()`

The abort_if function throws an HTTP exception if a given boolean expression evaluates to true:

abort_if(! Auth::user()->isAdmin(), 403);

`abort_unless()`

The abort_unless function throws an HTTP exception if a given boolean expression evaluates to false:

abort_unless(Auth::user()->isAdmin(), 403);

`auth()`

The auth function returns an authenticator instance. You may use it instead of the Auth facade for convenience:

$user = auth()->user();

`back()`

The back() function generates a redirect response to the user's previous location:

return back();

`bcrypt()`

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');

`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 minutes or duration the cached value should be considered valid:

cache(['key' => 'value'], 5);
 
cache(['key' => 'value'], Carbon::now()->addSeconds(10));

`collect()`

The collect function creates a collection instance from the given array:

$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);

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]);

`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:

dump($value);

`dispatch()`

The dispatch function pushes a new job onto the Laravel job queue:

dispatch(new App\Jobs\SendEmails);

`env()`

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');

`event()`

The event function dispatches the given event to its listeners:

event(new UserRegistered($user));

`factory()`

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();

`info()`

The info function will write information to the 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>

`old()`

The old function retrieves an old input value flashed into the session:

$value = old('value');
 
$value = old('value', 'default');

`redirect()`

The redirect function returns a redirect HTTP response, or returns the redirector instance if called with no arguments:

return redirect('/home');
 
return redirect()->route('route.name');

`request()`

The request function returns the current request instance or obtains an input item:

$request = request();
 
$value = request('key', $default = null)

`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);

`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);

`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';
});

`view()`

The view function retrieves a view instance:

return view('auth.login');