Laravel

https://laravel.com/docs/5.3
Admin
Laravel is a PHP web application framework that provides an elegant syntax for building robust,...
Tokens:201,233
Snippets:2,976
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install MariaDB

Source: https://laravel.com/docs/5.3/valet

Install MariaDB using Homebrew. After installation, start the MariaDB service using 'brew services start mariadb'.

```bash
brew install mariadb
```

--------------------------------

### Install Valet

Source: https://laravel.com/docs/5.3/valet

Run the valet install command to configure and install Valet, DnsMasq, and register Valet's daemon to launch on system startup.

```bash
valet install
```

--------------------------------

### Install Project Dependencies

Source: https://laravel.com/docs/5.3/elixir

Installs all Node dependencies defined in the package.json file for the project. Use --no-bin-links on Windows or with certain VM setups.

```bash
npm install
```

```bash
npm install --no-bin-links
```

--------------------------------

### Install Passport and Generate Keys

Source: https://laravel.com/docs/5.3/passport

Run the passport:install command to generate encryption keys and create initial clients.

```bash
php artisan passport:install
```

--------------------------------

### Example Homestead.yaml Configuration

Source: https://laravel.com/docs/5.3/homestead

An example configuration for Homestead.yaml showing how to specify the box, version, IP, memory, CPUs, and provider.

```yaml
box: laravel/homestead
version: 0.6.0
ip: "192.168.20.20"
memory: 2048
cpus: 4
provider: virtualbox
```

--------------------------------

### Create New Laravel Project with Installer

Source: https://laravel.com/docs/5.3/installation

Use the Laravel installer to create a new project. This command generates a fresh Laravel installation with dependencies pre-installed.

```bash
laravel new blog
```

--------------------------------

### Install Algolia SDK

Source: https://laravel.com/docs/5.3/scout

Install the Algolia PHP SDK if you are using the Algolia driver.

```bash
composer require algolia/algoliasearch-client-php
```

--------------------------------

### Install Frontend Dependencies with NPM

Source: https://laravel.com/docs/5.3/frontend

Install project's frontend dependencies using NPM. This command should be run before compiling CSS or JavaScript.

```bash
npm install
```

--------------------------------

### Install Laravel Scout

Source: https://laravel.com/docs/5.3/scout

Install the Scout package using Composer.

```bash
composer require laravel/scout
```

--------------------------------

### Install Laravel Installer with Composer

Source: https://laravel.com/docs/5.3/installation

Install the Laravel installer globally using Composer. Ensure the Composer vendor bin directory is in your system's PATH.

```bash
composer global require "laravel/installer"
```

--------------------------------

### Install or Reinstall Valet

Source: https://laravel.com/docs/5.3/valet

After upgrading Valet, run the install command to apply any necessary configuration file updates. This command ensures Valet is properly set up for your environment.

```bash
valet install
valet restart
```

--------------------------------

### Install Valet with Composer

Source: https://laravel.com/docs/5.3/valet

Install Valet globally using Composer. Ensure that the Composer vendor bin directory is in your system's PATH.

```bash
composer global require laravel/valet
```

--------------------------------

### Start Local Development Server

Source: https://laravel.com/docs/5.3/installation

Use the Artisan serve command to start PHP's built-in development server. This command serves the application at http://localhost:8000.

```bash
php artisan serve
```

--------------------------------

### Install Envoy using Composer

Source: https://laravel.com/docs/5.3/envoy

Install Envoy globally using the Composer require command. Ensure the vendor/bin directory is in your PATH.

```bash
composer global require "laravel/envoy=~1.0"
```

--------------------------------

### Install Laravel Echo and Pusher JS

Source: https://laravel.com/docs/5.3/broadcasting

Install Laravel Echo and the Pusher JS SDK using NPM.

```bash
npm install --save laravel-echo pusher-js
```

--------------------------------

### Start MariaDB Service

Source: https://laravel.com/docs/5.3/valet

Start the MariaDB service if it's not already running. You can then connect to the database at 127.0.0.1 with username 'root' and an empty password.

```bash
brew services start mariadb
```

--------------------------------

### Update and Start Supervisor Processes

Source: https://laravel.com/docs/5.3/queues

After creating or modifying Supervisor configuration files, use these commands to make Supervisor aware of the changes and start the defined processes.

```bash
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start laravel-worker:*
```

--------------------------------

### Setup Variables and Include Files in Envoy

Source: https://laravel.com/docs/5.3/envoy

Use the @setup directive for PHP code like variable declaration. Use @include to load other PHP files, such as autoloaders.

```php
@setup
    $now = new DateTime();

    $environment = isset($env) ? $env : "testing";
@endsetup

@include('vendor/autoload.php')

@task('foo')
    # ...
@endtask
```

--------------------------------

### Install dompdf for PDF Generation

Source: https://laravel.com/docs/5.3/billing

Before generating invoice PDFs, install the `dompdf` PHP library using Composer.

```bash
composer require dompdf/dompdf
```

--------------------------------

### FTP Driver Configuration Example

Source: https://laravel.com/docs/5.3/filesystem

Provides a sample configuration array for setting up an FTP filesystem disk in Laravel's filesystems.php configuration file.

```php
'ftp' => [
    'driver'   => 'ftp',
    'host'     => 'ftp.example.com',
    'username' => 'your-username',
    'password' => 'your-password',

    // Optional FTP Settings...
    // 'port'     => 21,
    // 'root'     => '',
    // 'passive'  => true,
    // 'ssl'      => true,
    // 'timeout'  => 30,
]
```

--------------------------------

### Install AWS SDK for PHP

Source: https://laravel.com/docs/5.3/mail

Install the Amazon AWS SDK for PHP using Composer for the SES driver.

```json
"aws/aws-sdk-php": "~3.0"
```

--------------------------------

### Install Pusher PHP SDK

Source: https://laravel.com/docs/5.3/broadcasting

Install the Pusher Channels PHP SDK using Composer if you are broadcasting events over Pusher Channels.

```bash
composer require pusher/pusher-php-server
```

--------------------------------

### Install Laravel Passport

Source: https://laravel.com/docs/5.3/passport

Use Composer to install the Passport package. Ensure you specify the version constraint.

```bash
composer require laravel/passport=~1.0
```

--------------------------------

### Install Predis Package

Source: https://laravel.com/docs/5.3/redis

Use Composer to install the Predis package for Redis support.

```bash
composer require predis/predis
```

--------------------------------

### Install Global Gulp CLI

Source: https://laravel.com/docs/5.3/elixir

Installs the Gulp command-line interface globally using NPM. This is a prerequisite for running Elixir tasks.

```bash
npm install --global gulp-cli
```

--------------------------------

### Install Supervisor on Ubuntu

Source: https://laravel.com/docs/5.3/queues

Use this command to install Supervisor on Ubuntu systems. Supervisor is a process control system that can automatically restart your queue worker if it fails.

```bash
sudo apt-get install supervisor
```

--------------------------------

### Write Application Tests in PHP

Source: https://laravel.com/docs/5.3/releases

Use fluent methods to interact with your application and assert responses. This example demonstrates a new user registration test.

```php
public function testNewUserRegistration()
{
    $this->visit('/register')
         ->type('Taylor', 'name')
         ->check('terms')
         ->press('Register')
         ->seePageIs('/dashboard');
}
```

--------------------------------

### Generate Homestead Configuration Files

Source: https://laravel.com/docs/5.3/homestead

Use the 'make' command to generate the Vagrantfile and Homestead.yaml for a per-project Homestead installation.

```bash
php vendor/bin/homestead make
```

```bash
vendor\bin\homestead make
```

--------------------------------

### Install New Laravel 5.0 Application

Source: https://laravel.com/docs/5.3/upgrade

Recommended method for upgrading from 4.2 to 5.0 involves creating a fresh Laravel 5.0 installation and migrating unique application files.

```bash
[install a new Laravel 5.0 application](/docs/5.0/installation)
```

--------------------------------

### Define Routes for Post Creation

Source: https://laravel.com/docs/5.3/validation

Define GET and POST routes for creating and storing blog posts.

```PHP
Route::get('post/create', 'PostController@create');

Route::post('post', 'PostController@store');
```

--------------------------------

### Create New Laravel Project with Composer

Source: https://laravel.com/docs/5.3/installation

Alternatively, install Laravel by issuing the Composer create-project command. Specify the desired Laravel version.

```bash
composer create-project --prefer-dist laravel/laravel blog "5.3.*"
```

--------------------------------

### Install Guzzle HTTP Library

Source: https://laravel.com/docs/5.3/mail

Install the Guzzle HTTP library using Composer, required for API-based mail drivers like Mailgun and SparkPost.

```bash
composer require guzzlehttp/guzzle
```

--------------------------------

### Define a Basic GET Route

Source: https://laravel.com/docs/5.3/routing

Use the `Route::get` method to define a route that responds to GET requests. This is suitable for simple page loads.

```PHP
Route::get('foo', function () {
    return 'Hello World';
});
```

--------------------------------

### Using the Cache Facade in a Controller

Source: https://laravel.com/docs/5.3/facades

This example demonstrates how to use the Cache facade to retrieve data within a controller. Ensure the Cache facade is imported.

```php
<?php

namespace App\Http\Controllers;

use Cache;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function showProfile($id)
    {
        $user = Cache::get('user:'.$id);

        return view('profile', ['user' => $user]);
    }
}
```

--------------------------------

### Scaffold Authentication

Source: https://laravel.com/docs/5.3/authentication

Run this command on fresh applications to install authentication routes, views, and controllers. It also generates a basic home controller.

```bash
php artisan make:auth
```

--------------------------------

### config()

Source: https://laravel.com/docs/5.3/helpers

Gets or sets configuration variable values.

```APIDOC
## config()

### Description
Gets the value of a configuration variable using dot syntax. A default value may be specified and is returned if the configuration option does not exist. Configuration variables can also be set at runtime.

### Parameters
#### Path Parameters
- **key** (string) - Required - The configuration key (e.g., 'app.timezone').
- **default** (mixed) - Optional - The default value to return if the key is not found.
- **values** (array) - Required when setting values - An array of key/value pairs to set.

### Example
```php
// Get a configuration value
$value = config('app.timezone');
$value = config('app.timezone', $default);

// Set a configuration value
config(['app.debug' => true]);
```
```

--------------------------------

### Listen for Server-Sent Events with Laravel Echo

Source: https://laravel.com/docs/5.3/releases

Example of using Laravel Echo to listen for a 'ShippingStatusUpdated' event on a channel. Requires Laravel Echo to be installed and configured on the client-side.

```javascript
Echo.channel('orders.' + orderId)
    .listen('ShippingStatusUpdated', (e) => {
        console.log(e.description);
    });
```

--------------------------------

### Get Unique Items by Key

Source: https://laravel.com/docs/5.3/collections

When dealing with nested data, `unique` can filter based on a specific key. This example finds unique items based on the 'brand' key.

```php
$collection = collect([
    ['name' => 'iPhone 6', 'brand' => 'Apple', 'type' => 'phone'],
    ['name' => 'iPhone 5', 'brand' => 'Apple', 'type' => 'phone'],
    ['name' => 'Apple Watch', 'brand' => 'Apple', 'type' => 'watch'],
    ['name' => 'Galaxy S6', 'brand' => 'Samsung', 'type' => 'phone'],
    ['name' => 'Galaxy Gear', 'brand' => 'Samsung', 'type' => 'watch'],
]);

$unique = $collection->unique('brand');

$unique->values()->all();
```

--------------------------------

### Rackspace Driver Configuration Example

Source: https://laravel.com/docs/5.3/filesystem

Provides a sample configuration array for setting up a Rackspace Cloud Storage filesystem disk in Laravel's filesystems.php configuration file.

```php
'rackspace' => [
    'driver'    => 'rackspace',
    'username'  => 'your-username',
    'key'       => 'your-key',
    'container' => 'your-container',
    'endpoint'  => 'https://identity.api.rackspacecloud.com/v2.0/',
    'region'    => 'IAD',
    'url_type'  => 'publicURL',
]
```

--------------------------------

### Initialize Homestead Configuration

Source: https://laravel.com/docs/5.3/homestead

Create the Homestead.yaml configuration file by running the init script. The configuration file will be placed in ~/.homestead.

```bash
// Mac / Linux...
bash init.sh

// Windows...
init.bat
```

--------------------------------

### Obtaining Cache Instance with Facade

Source: https://laravel.com/docs/5.3/cache

Demonstrates how to obtain a cache instance using the Cache facade and retrieve an item by its key. Requires importing the facade.

```php
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * Show a list of all users of the application.
     *
     * @return Response
     */
    public function index()
    {
        $value = Cache::get('key');

        //
    }
}
```

--------------------------------

### Role Middleware Example

Source: https://laravel.com/docs/5.3/releases

Define middleware that accepts custom parameters, such as a role name, to control access.

```php
<?php

namespace App\Http\Middleware;

use Closure;

class RoleMiddleware
{
    /**
     * Run the request filter.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @param  string  $role
     * @return mixed
     */
    public function handle($request, Closure $next, $role)
    {
        if (! $request->user()->hasRole($role)) {
            // Redirect...
        }

        return $next($request);
    }

}
```

--------------------------------

### Register a Directory for Site Serving

Source: https://laravel.com/docs/5.3/valet

Use the `park` command to register your current working directory as a path Valet should search for sites. Any Laravel projects within this directory will be automatically served.

```bash
mkdir ~/Sites
cd ~/Sites
valet park
```

--------------------------------

### Registering a GET Logout Route

Source: https://laravel.com/docs/5.3/upgrade

Convert logout requests to POST or register a GET route for '/logout' if you need to maintain GET requests. The Auth::routes method now registers a POST route.

```php
Route::get('/logout', 'Auth\LoginController@logout');
```

--------------------------------

### Create Subscription with Trial Days (Credit Card Up Front)

Source: https://laravel.com/docs/5.3/billing

Use the `trialDays` method before creating a subscription to offer a trial period while collecting payment information upfront. This sets the trial end date and instructs the payment gateway not to bill until after the trial expires.

```php
$user = User::find(1);

$user->newSubscription('main', 'monthly')
            ->trialDays(10)
            ->create($creditCardToken);
```

--------------------------------

### Controller Dependency Injection

Source: https://laravel.com/docs/5.3/container

Example of injecting a UserRepository implementation into a UserController's constructor for dependency injection.

```php
<?php

namespace App\Http\Controllers;

use App\User;
use App\Repositories\UserRepository;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * The user repository implementation.
     *
     * @var UserRepository
     */
    protected $users;

    /**
     * Create a new controller instance.
     *
     * @param  UserRepository  $users
     * @return void
     */
    public function __construct(UserRepository $users)
    {
        $this->users = $users;
    }

    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function show($id)
    {
        $user = $this->users->find($id);

        return view('user.profile', ['user' => $user]);
    }
}
```

--------------------------------

### Retrieve All Options as Array

Source: https://laravel.com/docs/5.3/artisan

Get all options passed to the command as an associative array by calling the `options` method.

```php
$options = $this->options();
```

--------------------------------

### Testing Cache Facade

Source: https://laravel.com/docs/5.3/facades

Shows how to test the Cache facade by mocking its 'get' method using shouldReceive. This allows verification of method calls and their arguments during testing.

```php
use Illuminate\Support\Facades\Cache;

public function testBasicExample()
{
    Cache::shouldReceive('get')
         ->with('key')
         ->andReturn('value');

    $this->visit('/cache')
         ->see('value');
}
```

--------------------------------

### Create Subscription with Coupon

Source: https://laravel.com/docs/5.3/billing

Apply a coupon to a subscription during creation using the `withCoupon` method.

```php
$user->newSubscription('main', 'monthly')
     ->withCoupon('code')
     ->create($creditCardToken);
```

--------------------------------

### Add Item to Beginning of Collection

Source: https://laravel.com/docs/5.3/collections

Use the `prepend` method to add an item to the start of the collection. You can optionally specify a key for the prepended item.

```php
$collection = collect([1, 2, 3, 4, 5]);

$collection->prepend(0);

$collection->all();

// [0, 1, 2, 3, 4, 5]
```

```php
$collection = collect(['one' => 1, 'two' => 2]);

$collection->prepend(0, 'zero');

$collection->all();

// ['zero' => 0, 'one' => 1, 'two' => 2]
```

--------------------------------

### Get Elixir File Path - elixir

Source: https://laravel.com/docs/5.3/helpers

Gets the path to a versioned Elixir file. Requires the file name as an argument.

```php
elixir($file);
```

--------------------------------

### Share a Local Site

Source: https://laravel.com/docs/5.3/valet

Navigate to your site's directory and run the `share` command to generate a publicly accessible URL. The URL will be copied to your clipboard.

```bash
valet share
```

--------------------------------

### Link a Single Project Directory

Source: https://laravel.com/docs/5.3/valet

Use the `link` command to serve a single project from its directory. This creates a symbolic link in `~/.valet/Sites` pointing to your project.

```bash
valet link app-name
```

--------------------------------

### Migrate Authentication Tables

Source: https://laravel.com/docs/5.3/authentication

After scaffolding authentication, run this command to create the necessary database tables for users and authentication.

```bash
php artisan migrate
```

--------------------------------

### Remove 'get' Prefix from Pagination Methods

Source: https://laravel.com/docs/5.3/upgrade

Remove the 'get' prefix from pagination methods like `getPerPage()`, `getCurrentPage()`, `getLastPage()`, and `getTotal()`.

```php
$paginator->perPage()
```

```php
$paginator->currentPage()
```

```php
$paginator->lastPage()
```

```php
$paginator->total()
```

--------------------------------

### Registering View Composers in the Boot Method

Source: https://laravel.com/docs/5.3/providers

Use the `boot` method to register application services like view composers. This method is called after all other service providers have been registered.

```php
<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class ComposerServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        view()->composer('view', function () {
            //
        });
    }
}
```

--------------------------------

### Making HTTP Request and Handling Response

Source: https://laravel.com/docs/5.3/broadcasting

Example of making a POST request and pushing the response data to a local array. Ensure the `X-Socket-ID` header is sent if using `toOthers`.

```javascript
this.$http.post('/task', task)
    .then((response) => {
        this.tasks.push(response.data);
    });
```

--------------------------------

### Initialize Braintree SDK Configuration

Source: https://laravel.com/docs/5.3/billing

Configure the Braintree SDK with your API keys in the AppServiceProvider's boot method.

```php
\Braintree_Configuration::environment(config('services.braintree.environment'));
    \Braintree_Configuration::merchantId(config('services.braintree.merchant_id'));
    \Braintree_Configuration::publicKey(config('services.braintree.public_key'));
    \Braintree_Configuration::privateKey(config('services.braintree.private_key'));
```

--------------------------------

### Get All Personal Access Tokens (Vue.js)

Source: https://laravel.com/docs/5.3/passport

Retrieve all personal access tokens created by the authenticated user by making a GET request to the `/oauth/personal-access-tokens` endpoint.

```javascript
this.$http.get('/oauth/personal-access-tokens')
    .then(response => {
        console.log(response.data);
    });
```

--------------------------------

### Memcached Configuration Example

Source: https://laravel.com/docs/5.3/cache

Configuration for the Memcached cache driver, specifying host, port, and weight for cache servers. Supports UNIX socket paths.

```php
'memcached' => [
    [
        'host' => '127.0.0.1',
        'port' => 11211,
        'weight' => 100
    ],
],
```

```php
'memcached' => [
    [
        'host' => '/var/run/memcached/memcached.sock',
        'port' => 0,
        'weight' => 100
    ],
],
```

--------------------------------

### Accessing Cache Facade

Source: https://laravel.com/docs/5.3/facades

Demonstrates how to use the Cache facade to retrieve a value from the cache. Ensure the Cache facade is imported before use.

```php
use Illuminate\Support\Facades\Cache;

Route::get('/cache', function () {
    return Cache::get('key');
});
```

--------------------------------

### Basic PHPUnit Test Example

Source: https://laravel.com/docs/5.3/testing

This is a basic example of a test method within a Laravel application using PHPUnit. Ensure you extend the `TestCase` class provided by Laravel.

```php
<?php

use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

class UserTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testExample()
    {
        $this->assertTrue(true);
    }
}
```

--------------------------------

### Publish Package Configuration File

Source: https://laravel.com/docs/5.3/packages

Allow users to publish your package's configuration file to the application's `config` directory using the `publishes` method in your service provider's `boot` method. Avoid using Closures in configuration files as they cannot be cached.

```php
/**
 * Perform post-registration booting of services.
 *
 * @return void
 */
public function boot()
{
    $this->publishes([
        __DIR__.'/path/to/config/courier.php' => config_path('courier.php'),
    ]);
}
```

--------------------------------

### Use Vue Component in Blade Template

Source: https://laravel.com/docs/5.3/frontend

Include a registered Vue component within a Blade template. This example shows how to use the 'example' component in a Blade view.

```blade
@extends('layouts.app')

@section('content')
    <example></example>
@endsection
```

--------------------------------

### Boot Method Dependency Injection

Source: https://laravel.com/docs/5.3/providers

Type-hint dependencies in your service provider's `boot` method to have them automatically injected by the service container.

```php
use Illuminate\Contracts\Routing\ResponseFactory;

public function boot(ResponseFactory $response)
{
    $response->macro('caps', function ($value) {
        //
    });
}
```

--------------------------------

### Accessing Different Cache Stores

Source: https://laravel.com/docs/5.3/cache

Shows how to access and interact with different cache stores (e.g., 'file', 'redis') using the Cache facade's `store` method.

```php
$value = Cache::store('file')->get('foo');

Cache::store('redis')->put('bar', 'baz', 10);
```

--------------------------------

### Get Last Array Element Passing Truth Test with array_last()

Source: https://laravel.com/docs/5.3/helpers

Use `array_last` to get the last element that satisfies a condition. A callback function is used for the truth test.

```php
$array = [100, 200, 300, 110];

$value = array_last($array, function ($value, $key) {
    return $value >= 150;
});

// 300
```

--------------------------------

### Create bootstrap/cache Directory and .gitignore

Source: https://laravel.com/docs/5.3/upgrade

Create the `bootstrap/cache` directory and add a `.gitignore` file to prevent compiled files from being committed to version control. Ensure this directory is writable.

```bash
*
!.gitignore
```

--------------------------------

### Get or Set Session Values

Source: https://laravel.com/docs/5.3/helpers

The `session()` function can be used to get or set session values. Passing an array sets multiple values. The session store is returned if no value is passed.

```php
$value = session('key');
```

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

```php
$value = session()->get('key');
```

```php
session()->put('key', $value);
```

--------------------------------

### Get First Array Element Passing Truth Test with array_first()

Source: https://laravel.com/docs/5.3/helpers

Use `array_first` to get the first element that satisfies a condition. A callback function is used for the truth test. A default value can be provided if no element passes.

```php
$array = [100, 200, 300];

$value = array_first($array, function ($value, $key) {
    return $value >= 150;
});

// 200
```

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

--------------------------------

### Log in an Existing User Instance

Source: https://laravel.com/docs/5.3/authentication

Use the `login` method to log in an existing user instance. The user object must implement the `Authenticatable` contract. You can optionally "remember" the user by passing `true` as the second argument.

```php
Auth::login($user);
```

```php
Auth::login($user, true);
```

--------------------------------

### Create Directory

Source: https://laravel.com/docs/5.3/filesystem

The `makeDirectory` method creates a specified directory, including any necessary parent directories.

```PHP
Storage::makeDirectory($directory);
```

--------------------------------

### elixir()

Source: https://laravel.com/docs/5.3/helpers

Gets the path to a versioned Elixir file.

```APIDOC
## `elixir()`

### Description
The `elixir` function gets the path to a [versioned Elixir file](/docs/5.3/elixir).

### Example
```php
elixir($file);
```
```

--------------------------------

### session()

Source: https://laravel.com/docs/5.3/helpers

May be used to get or set session values.

```APIDOC
## session()

### Description
May be used to get or set session values. The session store will be returned if no value is passed.

### Usage
```php
$value = session('key');

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

$value = session()->get('key');
session()->put('key', $value);
```
```

--------------------------------

### env()

Source: https://laravel.com/docs/5.3/helpers

Gets the value of an environment variable or returns a default value.

```APIDOC
## env()

### Description
Gets the value of an environment variable or returns a default value if the variable does not exist.

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the environment variable.
- **default** (mixed) - Optional - The default value to return if the variable is not set.

### Example
```php
$env = env('APP_ENV');
$env = env('APP_ENV', 'production');
```
```

--------------------------------

### File URLs

Source: https://laravel.com/docs/5.3/filesystem

Get the URL for a given file when using the 'local' or 's3' drivers.

```APIDOC
### File URLs

### Description
Get the URL for a given file when using the 'local' or 's3' drivers. For the 'local' driver, this typically prepends `/storage` to the path. For the 's3' driver, the fully qualified remote URL is returned.

### Method
`Storage::url(string $path)`

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to the file.

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
use Illuminate\Support\Facades\Storage;

$url = Storage::url('file1.jpg');
```

### Response
#### Success Response (200)
- **string** - The URL of the file.
```

--------------------------------

### Generate a New Service Provider with Artisan

Source: https://laravel.com/docs/5.3/providers

Use the `make:provider` Artisan command to generate a new service provider class.

```bash
php artisan make:provider RiakServiceProvider
```

--------------------------------

### Creating Collections

Source: https://laravel.com/docs/5.3/collections

Demonstrates how to create a new Collection instance using the 'collect' helper function.

```APIDOC
## Creating Collections

As mentioned above, the `collect` helper returns a new `Illuminate\Support\Collection` instance for the given array. So, creating a collection is as simple as:

```php
$collection = collect([1, 2, 3]);
```

> {tip} The results of [Eloquent](/docs/5.3/eloquent) queries are always returned as `Collection` instances.
```

--------------------------------

### Get File Size

Source: https://laravel.com/docs/5.3/filesystem

Retrieve the size of a file in bytes using the `size` method.

```php
use Illuminate\Support\Facades\Storage;

$size = Storage::size('file1.jpg');
```

--------------------------------

### values()

Source: https://laravel.com/docs/5.3/collections

Returns a new collection with the keys reset to consecutive integers, starting from 0.

```APIDOC
## values()

### Description
Returns a new collection with the keys reset to consecutive integers.

### Method
`values()`

### Example
```php
$collection = collect([
    10 => ['product' => 'Desk', 'price' => 200],
    11 => ['product' => 'Desk', 'price' => 200]
]);

$values = $collection->values();

// $values is [0 => ['product' => 'Desk', 'price' => 200], 1 => ['product' => 'Desk', 'price' => 200]]
$values->all();
```
```

--------------------------------

### slice()

Source: https://laravel.com/docs/5.3/collections

Returns a slice of the collection starting at a given index, optionally limiting the size.

```APIDOC
## slice()

### Description
Returns a slice of the collection starting at the given index. Optionally, a size can be specified to limit the slice.

### Method
`slice(start, count = null)`

### Parameters
- **start** - The starting index for the slice.
- **count** - (Optional) The desired size of the returned slice.

### Request Example
```php
$collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);

$slice = $collection->slice(4);

// $slice == [5, 6, 7, 8, 9, 10]

$slice = $collection->slice(4, 2);

// $slice == [5, 6]
```

### Note
The returned slice preserves keys by default. Use the [`values`](#method-values) method to reindex them if needed.
```

--------------------------------

### Rename a Column

Source: https://laravel.com/docs/5.3/migrations

Rename an existing column using the `renameColumn` method. Ensure `doctrine/dbal` is installed.

```php
Schema::table('users', function (Blueprint $table) {
    $table->renameColumn('from', 'to');
});
```

--------------------------------

### Prepend and Append to Files

Source: https://laravel.com/docs/5.3/filesystem

Add content to the beginning of a file using `prepend` or to the end using `append`.

```php
Storage::prepend('file.log', 'Prepended Text');

Storage::append('file.log', 'Appended Text');
```

--------------------------------

### Get Authenticator Instance with auth()

Source: https://laravel.com/docs/5.3/helpers

Returns an authenticator instance. Can be used as an alternative to the Auth facade.

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

--------------------------------

### Request All Scopes with Password Grant

Source: https://laravel.com/docs/5.3/passport

This example shows how to request all available scopes using the '*' scope with the password grant. This is only applicable for tokens issued via the password grant.

```php
$response = $http->post('http://your-app.com/oauth/token', [
    'form_params' => [
        'grant_type' => 'password',
        'client_id' => 'client-id',
        'client_secret' => 'client-secret',
        'username' => 'taylor@laravel.com',
        'password' => 'my-password',
        'scope' => '*',
    ],
]);
```

--------------------------------

### Get Public Directory Path - public_path

Source: https://laravel.com/docs/5.3/helpers

Returns the fully qualified path to the public directory.

```php
$path = public_path();
```

--------------------------------

### Using PSR-7 Requests

Source: https://laravel.com/docs/5.3/requests

Install `symfony/psr-http-message-bridge` and `zendframework/zend-diactoros` to use PSR-7 compatible requests by type-hinting `Psr\Http\Message\ServerRequestInterface`.

```php
composer require symfony/psr-http-message-bridge
composer require zendframework/zend-diactoros
```

```php
use Psr\Http\Message\ServerRequestInterface;

Route::get('/', function (ServerRequestInterface $request) {
    //
});
```

--------------------------------

### Create Response Instance

Source: https://laravel.com/docs/5.3/helpers

The `response()` function creates a response instance or obtains an instance of the response factory.

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

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

--------------------------------

### Registering a Custom Dropbox Filesystem Driver

Source: https://laravel.com/docs/5.3/filesystem

Use the Storage::extend method within a service provider's boot method to register a custom filesystem driver. The closure receives the application instance and configuration, and must return a League\Flysystem\Filesystem instance.

```php
<?php

namespace App\Providers;

use Storage;
use League\Flysystem\Filesystem;
use Dropbox\Client as DropboxClient;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Dropbox\DropboxAdapter;

class DropboxServiceProvider extends ServiceProvider
{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        Storage::extend('dropbox', function ($app, $config) {
            $client = new DropboxClient(
                $config['accessToken'], $config['clientIdentifier']
            );

            return new Filesystem(new DropboxAdapter($client));
        });
    }

    /**
     * Register bindings in the container.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}
```

--------------------------------

### Get Underlying Array from Collection

Source: https://laravel.com/docs/5.3/collections

The `all` method returns the raw PHP array that the collection is currently holding.

```php
collect([1, 2, 3])->all();
```

--------------------------------

### Migrate Route Filters

Source: https://laravel.com/docs/5.3/upgrade

Copy filter bindings from app/filters.php to the boot() method of app/Providers/RouteServiceProvider.php.

```php
public function boot()
{
    Route::get('foo/bar', 'FooBarController@method');

    Route::group(['middleware' => ['web']], function () {
        //
    });

    // Copy filter bindings here
    Route::filter('old_filter_name', function() {
        // ...
    });
}
```

--------------------------------

### Retrieve All Arguments as Array

Source: https://laravel.com/docs/5.3/artisan

Get all arguments passed to the command as an associative array by calling the `arguments` method.

```php
$arguments = $this->arguments();
```

--------------------------------

### Set and retrieve Redis values

Source: https://laravel.com/docs/5.3/redis

Demonstrates setting a string value with `Redis::set` and retrieving a range of list elements with `Redis::lrange`.

```PHP
Redis::set('name', 'Taylor');
```

```PHP
$values = Redis::lrange('names', 5, 10);
```

--------------------------------

### Create a New Model Instance with create

Source: https://laravel.com/docs/5.3/eloquent

Use the `create` method to insert a new record and retrieve the saved model instance. Ensure mass assignable attributes are defined.

```php
$flight = App\Flight::create(['name' => 'Flight 10']);
```

--------------------------------

### Load Package Routes in Service Provider

Source: https://laravel.com/docs/5.3/packages

Use the `loadRoutesFrom` method in your service provider's `boot` method to register routes defined in a separate file for your package.

```php
/**
 * Perform post-registration booting of services.
 *
 * @return void
 */
public function boot()
{
    $this->loadRoutesFrom(__DIR__.'/path/to/routes.php');
}
```

--------------------------------

### Get Environment Variable with env()

Source: https://laravel.com/docs/5.3/helpers

Retrieves the value of an environment variable or returns a default value if the variable does not exist.

```php
$env = env('APP_ENV');
```

```php
$env = env('APP_ENV', 'production');
```

--------------------------------

### Get Database Directory Path - database_path

Source: https://laravel.com/docs/5.3/helpers

Returns the fully qualified path to the application's database directory.

```php
$path = database_path();
```

--------------------------------

### Get Config Directory Path - config_path

Source: https://laravel.com/docs/5.3/helpers

Returns the fully qualified path to the application's configuration directory.

```php
$path = config_path();
```

--------------------------------

### Create Post Controller

Source: https://laravel.com/docs/5.3/validation

A basic controller with methods for displaying the creation form and storing a new blog post.

```PHP
<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class PostController extends Controller
{
    /**
     * Show the form to create a new blog post.
     *
     * @return Response
     */
    public function create()
    {
        return view('post.create');
    }

    /**
     * Store a new blog post.
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        // Validate and store the blog post...
    }
}
```

--------------------------------

### Count Collection Items

Source: https://laravel.com/docs/5.3/collections

Returns the total number of items in the collection. A simple way to get the size of the collection.

```php
$collection = collect([1, 2, 3, 4]);

$collection->count();

// 4
```

--------------------------------

### Chain Connection and Queue Methods

Source: https://laravel.com/docs/5.3/queues

You can chain `onConnection` and `onQueue` methods to specify both the connection and the queue for a job.

```php
$job = (new ProcessPodcast($podcast))
            ->onConnection('sqs')
            ->onQueue('processing');
```

--------------------------------

### Retrieving Request Method

Source: https://laravel.com/docs/5.3/requests

Get the HTTP verb using the `method` method, or verify it against a string using `isMethod`.

```php
$method = $request->method();
```

```php
if ($request->isMethod('post')) {
    //
}
```

--------------------------------

### Using View Helper Function

Source: https://laravel.com/docs/5.3/facades

Illustrates the use of the 'view' helper function as an alternative to the View facade for creating views. This helper function is equivalent to using the View facade.

```php
return View::make('profile');
```

```php
return view('profile');
```

--------------------------------

### Get Last Modified Timestamp

Source: https://laravel.com/docs/5.3/filesystem

The `lastModified` method returns the UNIX timestamp indicating when the file was last modified.

```php
$time = Storage::lastModified('file1.jpg');
```

--------------------------------

### Bail Validation Rule Example

Source: https://laravel.com/docs/5.3/releases

Use the 'bail' rule to stop validation after the first failure for a given rule.

```php
$this->validate($request, [
    'user_id' => 'bail|integer|unique:users'
]);
```

--------------------------------

### Registering a Service Provider in config/app.php

Source: https://laravel.com/docs/5.3/providers

Add your custom service provider's class name to the `providers` array in the `config/app.php` configuration file.

```php
'providers' => [
    // Other Service Providers

    App\Providers\ComposerServiceProvider::class,
],
```

--------------------------------

### Subscription Trials - With Credit Card Up Front

Source: https://laravel.com/docs/5.3/billing

Offer trial periods with payment information collected upfront using the `trialDays` method when creating subscriptions. Users will be charged after the trial ends unless they cancel beforehand.

```APIDOC
## Subscription Trials - With Credit Card Up Front

If you would like to offer trial periods to your customers while still collecting payment method information up front, You should use the `trialDays` method when creating your subscriptions:

```php
$user = User::find(1);

$user->newSubscription('main', 'monthly')
            ->trialDays(10)
            ->create($creditCardToken);
```

This method will set the trial period ending date on the subscription record within the database, as well as instruct Stripe / Braintree to not begin billing the customer until after this date.

> **Note**: If the customer's subscription is not cancelled before the trial ending date they will be charged as soon as the trial expires, so you should be sure to notify your users of their trial ending date.

You may determine if the user is within their trial period using either the `onTrial` method of the user instance, or the `onTrial` method of the subscription instance. The two examples below are identical:

```php
if ($user->onTrial('main')) {
    // ...
}

if ($user->subscription('main')->onTrial()) {
    // ...
}
```
```

--------------------------------

### Check if String Starts With Value using starts_with()

Source: https://laravel.com/docs/5.3/helpers

Determines if a string begins with a specified value. Returns a boolean.

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

--------------------------------

### Create and Persist Models to Database

Source: https://laravel.com/docs/5.3/database-testing

Use the `factory` function with the `create` method to generate model instances and save them directly to the database. This is ideal for setting up test environments.

```php
public function testDatabase()
{
    // Create a single App\User instance...
    $user = factory(App\User::class)->create();

    // Create three App\User instances...
    $users = factory(App\User::class, 3)->create();

    // Use model in tests...
}
```

--------------------------------

### Install Homestead Per Project with Composer

Source: https://laravel.com/docs/5.3/homestead

Require the Laravel Homestead package as a development dependency in your project using Composer.

```bash
composer require laravel/homestead --dev
```

--------------------------------

### Get Current Request Instance or Input

Source: https://laravel.com/docs/5.3/helpers

The `request()` function returns the current request instance or obtains an input item.

```php
$request = request();
```

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

--------------------------------

### response()

Source: https://laravel.com/docs/5.3/helpers

Creates a response instance or obtains an instance of the response factory.

```APIDOC
## response()

### Description
Creates a response instance or obtains an instance of the response factory.

### Usage
```php
return response('Hello World', 200, $headers);

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

--------------------------------

### Get Last Array Element - last

Source: https://laravel.com/docs/5.3/helpers

Returns the last element of an array. Useful for quickly accessing the final item.

```php
$array = [100, 200, 300];

$last = last($array);

// 300
```

--------------------------------

### Implement `serves` Method for Custom Valet Driver

Source: https://laravel.com/docs/5.3/valet

The `serves` method should return `true` if the driver should handle the incoming request. This is determined by checking if the site path contains project-specific indicators, like a `wp-admin` directory for WordPress.

```php
/**
 * Determine if the driver serves the request.
 *
 * @param  string  $sitePath
 * @param  string  $siteName
 * @param  string  $uri
 * @return bool
 */
public function serves($sitePath, $siteName, $uri)
{
    return is_dir($sitePath.'/wp-admin');
}
```

--------------------------------

### Run an Insert Statement

Source: https://laravel.com/docs/5.3/database

Use the `insert` method to execute SQL insert statements. Provide the raw SQL query and an array of bindings.

```php
DB::insert('insert into users (id, name) values (?, ?)', [1, 'Dayle']);
```

--------------------------------

### Get First Array Element - head

Source: https://laravel.com/docs/5.3/helpers

Returns the first element of an array. Useful for quickly accessing the initial item.

```php
$array = [100, 200, 300];

$first = head($array);

// 100
```

--------------------------------

### Retrieve or Create a Model Instance

Source: https://laravel.com/docs/5.3/eloquent

Use `firstOrCreate` to find a record by attributes or create it if it doesn't exist. Use `firstOrNew` to find or instantiate a new model without persisting it.

```php
// Retrieve the flight by the attributes, or create it if it doesn't exist...
$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);
```

```php
// Retrieve the flight by the attributes, or instantiate a new instance...
$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);
```

--------------------------------

### Get All Collection Keys - `keys()`

Source: https://laravel.com/docs/5.3/collections

Retrieves all the keys from a collection. This is useful when you need to work with the identifiers of the collection's items.

```php
$collection = collect([
    'prod-100' => ['product_id' => 'prod-100', 'name' => 'Desk'],
    'prod-200' => ['product_id' => 'prod-200', 'name' => 'Chair'],
]);

$keys = $collection->keys();

$keys->all();

// ['prod-100', 'prod-200']
```

--------------------------------

### get()

Source: https://laravel.com/docs/5.3/collections

Retrieves an item from the collection by its key. Returns null if the key does not exist. An optional default value or callback can be provided.

```APIDOC
## get()

### Description
Returns the item at a given key. If the key does not exist, `null` is returned. Optionally, a default value or a callback returning a default value can be provided.

### Method
`get(key, defaultValue = null)`

### Parameters
#### Path Parameters
- **key** (string | int) - Required - The key of the item to retrieve.
- **defaultValue** (mixed | callable) - Optional - The default value to return if the key is not found.

### Request Example
```php
$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$value = $collection->get('name');
// taylor

$value = $collection->get('foo', 'default-value');
// default-value

$value = $collection->get('email', function () { return 'default-value'; });
// default-value
```

### Response
#### Success Response (200)
- **value** (mixed) - The value associated with the key, or the default value if the key is not found.
```

--------------------------------

### Create Subscriptions Table

Source: https://laravel.com/docs/5.3/billing

Create the subscriptions table to store customer subscription details.

```php
Schema::create('subscriptions', function ($table) {
    $table->increments('id');
    $table->integer('user_id');
    $table->string('name');
    $table->string('braintree_id');
    $table->string('braintree_plan');
    $table->integer('quantity');
    $table->timestamp('trial_ends_at')->nullable();
    $table->timestamp('ends_at')->nullable();
    $table->timestamps();
});
```

--------------------------------

### Place Column First (MySQL)

Source: https://laravel.com/docs/5.3/migrations

Use the `first` method to position a new column at the beginning of a table. This is specific to MySQL.

```php
$table->string('remember_token')->first();
```

--------------------------------

### Visit Named Route

Source: https://laravel.com/docs/5.3/application-testing

Make a GET request to your application using a named route. You can also pass parameters to the route.

```PHP
$this->visitRoute('profile');
```

```PHP
$this->visitRoute('profile', ['user' => 1]);
```
Tokens:
Raw