namest/drive

Getting Started

Provide an elegant way to interact with upload & process uploaded file feature., _(*1)

Note: The package is only support Laravel 5, _(*2)

Installation

Step 1: Install package, _(*3)

composer require namest/drive

Step 2: Register service provider in your config/app.php, _(*4)

return [
    ...
    'providers' => [
        ...
        'Namest\Drive\DriveServiceProvider',
    ],
    ...
];

Step 3: Publish package configs. Open your terminal and type:, _(*5)

php artisan vendor:publish --provider="Namest\Drive\DriveServiceProvider"

Step 4: Edit your appropriate configurations in config/drive.php:, _(*6)

Step 6: Read API below and start happy, _(*7)

API

Accept file upload (validate,...)

$file = Drive::accept($input_name);

Validation

// Set up validation rules in config file use laravel validation rules
return [
    ...
    'rules' => [
        'max:2048', // Kilobytes
        // Whatever you want
    ],
    ...
];

Throws ValidationException when failed validation., _(*8)

Save file (without editing)

$nomal = $file->save();
$large = $file->save('-large'); // With file name suffix

Edit image file via method chaining

// Recipe: $file-><intervention/image method>($parameters)
$small = $file->crop($width, $height, $x, $y)
              ->blur($percent)
              ->save('-small');

Edit image use profile declare in drive.profiles config

$avatar = $file->profile('avatar')->save();

Auto edit file by profile for particular upload type

// For example: apply `avatar` profile with every uploaded images.
// Edit in `drive` config
return [
    ...
    'default_profiles' => [
        'image' => ['avatar'],
        'video' => [],
    ],
    ...
];