Helper Functions

Introduction
Available Methods

Introduction

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.

Available Methods

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:

1$array = array_add(['name' => 'Desk'], 'price', 100);
2 
3// ['name' => 'Desk', 'price' => 100]

$array = array_add(['name' => 'Desk'], 'price', 100);

// ['name' => 'Desk', 'price' => 100]

`array_collapse()`

The array_collapse function collapse an array of arrays into a single array:

1$array = array_collapse([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
2 
3// [1, 2, 3, 4, 5, 6, 7, 8, 9]

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

1list($keys, $values) = array_divide(['name' => 'Desk']);
2 
3// $keys: ['name']
4 
5// $values: ['Desk']

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:

1$array = array_dot(['foo' => ['bar' => 'baz']]);
2 
3// ['foo.bar' => 'baz'];

$array = array_dot(['foo' => ['bar' => 'baz']]);

// ['foo.bar' => 'baz'];

`array_except()`

The array_except function removes the given key / value pairs from the array:

1$array = ['name' => 'Desk', 'price' => 100];
2 
3$array = array_except($array, ['price']);
4 
5// ['name' => 'Desk']

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

1$array = [100, 200, 300];
2 
3$value = array_first($array, function ($key, $value) {
4    return $value >= 150;
5});
6 
7// 200

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

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

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

`array_flatten()`

The array_flatten function will flatten a multi-dimensional array into a single level.

1$array = ['name' => 'Joe', 'languages' => ['PHP', 'Ruby']];
2 
3$array = array_flatten($array);
4 
5// ['Joe', 'PHP', 'Ruby'];

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

1$array = ['products' => ['desk' => ['price' => 100]]];
2 
3array_forget($array, 'products.desk');
4 
5// ['products' => []]

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

1$array = ['products' => ['desk' => ['price' => 100]]];
2 
3$value = array_get($array, 'products.desk');
4 
5// ['price' => 100]

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

1$value = array_get($array, 'names.john', 'default');

$value = array_get($array, 'names.john', 'default');

`array_has()`

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

1$array = ['products' => ['desk' => ['price' => 100]]];
2 
3$hasDesk = array_has($array, 'products.desk');
4 
5// true

$array = ['products' => ['desk' => ['price' => 100]]];

$hasDesk = array_has($array, 'products.desk');

// true

`array_only()`

The array_only function will return only the specified key / value pairs from the given array:

1$array = ['name' => 'Desk', 'price' => 100, 'orders' => 10];
2 
3$array = array_only($array, ['name', 'price']);
4 
5// ['name' => 'Desk', 'price' => 100]

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

1$array = [
2    ['developer' => ['id' => 1, 'name' => 'Taylor']],
3    ['developer' => ['id' => 2, 'name' => 'Abigail']],
4];
5 
6$array = array_pluck($array, 'developer.name');
7 
8// ['Taylor', 'Abigail'];

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

1$array = array_pluck($array, 'developer.name', 'developer.id');
2 
3// [1 => 'Taylor', 2 => 'Abigail'];

$array = array_pluck($array, 'developer.name', 'developer.id');

// [1 => 'Taylor', 2 => 'Abigail'];

`array_pull()`

The array_pull function returns and removes a key / value pair from the array:

1$array = ['name' => 'Desk', 'price' => 100];
2 
3$name = array_pull($array, 'name');
4 
5// $name: Desk
6 
7// $array: ['price' => 100]

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

1$array = ['products' => ['desk' => ['price' => 100]]];
2 
3array_set($array, 'products.desk.price', 200);
4 
5// ['products' => ['desk' => ['price' => 200]]]

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

 1$array = [
 2    ['name' => 'Desk'],
 3    ['name' => 'Chair'],
 4];
 5 
 6$array = array_values(array_sort($array, function ($value) {
 7    return $value['name'];
 8}));
 9 
10/*
11    [
12        ['name' => 'Chair'],
13        ['name' => 'Desk'],
14    ]
15*/

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

 1$array = [
 2    [
 3        'Roman',
 4        'Taylor',
 5        'Li',
 6    ],
 7    [
 8        'PHP',
 9        'Ruby',
10        'JavaScript',
11    ],
12];
13 
14$array = array_sort_recursive($array);
15 
16/*
17    [
18        [
19            'Li',
20            'Roman',
21            'Taylor',
22        ],
23        [
24            'JavaScript',
25            'PHP',
26            'Ruby',
27        ]
28    ];
29*/

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

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

$array = [100, '200', 300, '400', 500];

$array = array_where($array, function ($key, $value) {
    return is_string($value);
});

// [1 => 200, 3 => 400]

`head()`

The head function simply returns the first element in the given array:

1$array = [100, 200, 300];
2 
3$first = head($array);
4 
5// 100

$array = [100, 200, 300];

$first = head($array);

// 100

`last()`

The last function returns the last element in the given array:

1$array = [100, 200, 300];
2 
3$last = last($array);
4 
5// 300

$array = [100, 200, 300];

$last = last($array);

// 300

Paths

`app_path()`

The app_path function returns the fully qualified path to the app directory:

1$path = app_path();

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

1$path = app_path('Http/Controllers/Controller.php');

$path = app_path('Http/Controllers/Controller.php');

`base_path()`

The base_path function returns the fully qualified path to the project root:

1$path = base_path();

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

1$path = base_path('vendor/bin');

$path = base_path('vendor/bin');

`config_path()`

The config_path function returns the fully qualified path to the application configuration directory:

1$path = config_path();

$path = config_path();

`database_path()`

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

1$path = database_path();

$path = database_path();

`elixir()`

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

1elixir($file);

elixir($file);

`public_path()`

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

1$path = public_path();

$path = public_path();

`storage_path()`

The storage_path function returns the fully qualified path to the storage directory:

1$path = storage_path();

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

1$path = storage_path('app/file.txt');

$path = storage_path('app/file.txt');

Strings

`camel_case()`

The camel_case function converts the given string to camelCase:

1$camel = camel_case('foo_bar');
2 
3// fooBar

$camel = camel_case('foo_bar');

// fooBar

`class_basename()`

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

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

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

// Baz

`e()`

The e function runs htmlentities over the given string:

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

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:

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

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

// true

`snake_case()`

The snake_case function converts the given string to snake_case:

1$snake = snake_case('fooBar');
2 
3// foo_bar

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

1$value = str_limit('The PHP framework for web artisans.', 7);
2 
3// The PHP...

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

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

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

// true

`str_contains()`

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

1$value = str_contains('This is my name', 'my');
2 
3// true

$value = str_contains('This is my name', 'my');

// true

`str_finish()`

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

1$string = str_finish('this/string', '/');
2 
3// this/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:

1$value = str_is('foo*', 'foobar');
2 
3// true
4 
5$value = str_is('baz*', 'foobar');
6 
7// false

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

1$plural = str_plural('car');
2 
3// cars
4 
5$plural = str_plural('child');
6 
7// children

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

1$plural = str_plural('child', 2);
2 
3// children
4 
5$plural = str_plural('child', 1);
6 
7// child

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

1$string = str_random(40);

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

1$singular = str_singular('cars');
2 
3// car

$singular = str_singular('cars');

// car

`str_slug()`

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

1$title = str_slug("Laravel 5 Framework", "-");
2 
3// laravel-5-framework

$title = str_slug("Laravel 5 Framework", "-");

// laravel-5-framework

`studly_case()`

The studly_case function converts the given string to StudlyCase:

1$value = studly_case('foo_bar');
2 
3// FooBar

$value = studly_case('foo_bar');

// FooBar

`trans()`

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

1echo trans('validation.required'):

echo trans('validation.required'):

`trans_choice()`

The trans_choice function translates the given language line with inflection:

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

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

1$url = action('HomeController@getIndex');

$url = action('HomeController@getIndex');

If the method accepts route parameters, you may pass them as the second argument to the method:

1$url = action('UserController@profile', ['id' => 1]);

$url = action('UserController@profile', ['id' => 1]);

`asset()`

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

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

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

`secure_asset()`

Generate a URL for an asset using HTTPS:

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

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

`route()`

The route function generates a URL for the given named route:

1$url = route('routeName');

$url = route('routeName');

If the route accepts parameters, you may pass them as the second argument to the method:

1$url = route('routeName', ['id' => 1]);

$url = route('routeName', ['id' => 1]);

`url()`

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

1echo url('user/profile');
2 
3echo url('user/profile', [1]);

echo url('user/profile');

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

Miscellaneous

`auth()`

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

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

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

`back()`

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

1return back();

return back();

`bcrypt()`

The bcrypt function hashes the given value using Bcrypt. You may use it as an alternative to the Hash facade:

1$password = bcrypt('my-secret-password');

$password = bcrypt('my-secret-password');

`collect()`

The collect function creates a collection instance from the supplied items:

1$collection = collect(['taylor', 'abigail']);

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

1$value = config('app.timezone');
2 
3$value = config('app.timezone', $default);

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

1config(['app.debug' => true]);

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:

1{!! csrf_field() !!}

{!! csrf_field() !!}

`csrf_token()`

The csrf_token function retrieves the value of the current CSRF token:

1$token = csrf_token();

$token = csrf_token();

`dd()`

The dd function dumps the given variable and ends execution of the script:

1dd($value);

dd($value);

`env()`

The env function gets the value of an environment variable or returns a default value:

1$env = env('APP_ENV');
2 
3// Return a default value if the variable doesn't exist...
4$env = env('APP_ENV', 'production');

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

1event(new UserRegistered($user));

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:

1$user = factory(App\User::class)->make();

$user = factory(App\User::class)->make();

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

1<form method="POST">
2    {!! method_field('delete') !!}
3</form>

<form method="POST">
    {!! method_field('delete') !!}
</form>

`old()`

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

1$value = old('value');

$value = old('value');

`redirect()`

The redirect function returns an instance of the redirector to do redirects:

1return redirect('/home');

return redirect('/home');

`request()`

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

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

$request = request();

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

`response()`

The response function creates a response instance or obtains an instance of the response factory:

1return response('Hello World', 200, $headers);
2 
3return response()->json(['foo' => 'bar'], 200, $headers);

return response('Hello World', 200, $headers);

return response()->json(['foo' => 'bar'], 200, $headers);

`session()`

The session function may be used to get / set a session value:

1$value = session('key');

$value = session('key');

You may set values by passing an array of key / value pairs to the function:

1session(['chairs' => 7, 'instruments' => 3]);

session(['chairs' => 7, 'instruments' => 3]);

The session store will be returned if no value is passed to the function:

1$value = session()->get('key');
2 
3session()->put('key', $value);

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

1$value = value(function() { return 'bar'; });

$value = value(function() { return 'bar'; });

`view()`

The view function retrieves a view instance:

1return view('auth.login');

return view('auth.login');

`with()`

The with function returns the value it is given. This function is primarily useful for method chaining where it would otherwise be impossible:

1$value = with(new Foo)->work();

$value = with(new Foo)->work();

Prologue

Setup

Tutorials

The Basics

Architecture Foundations

Services

Database

Eloquent ORM

Helper Functions

Arrays

Paths

Strings

URLs

Miscellaneous

Products

Packages

Resources