File: README.md

Recommend this page to a friend!
  Classes of Zacchaeus Bolaji  >  Laravel PUT Helper  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Laravel PUT Helper
Process HTTP PUT requests to get files and values
Author: By
Last change:
Date: 5 months ago
Size: 3,252 bytes
 

Contents

Class file image Download

Laravel PUT Helper

CircleCI Latest Stable Version Total Downloads License Build Status Scrutinizer Code Quality Code Coverage

Laravel PUT helper is a package that helps you get input data, as well as uploaded files for PUT requests

Installation

You can install the package via composer:

composer require djunehor/laravel-put-helper

Laravel 5.5 and above

The package will automatically register itself, so you can start using it immediately.

Laravel 5.4 and older

In Laravel version 5.4 and older, you have to add the service provider in config/app.php file manually:

'providers' => [
    // ...
    Djunehor\PutHelper\PutHelperServiceProvider::class,
];

Lumen

After installing the package, you will have to register it in bootstrap/app.php file manually:

// Register Service Providers
    // ...
    $app->register(Djunehor\PutHelper\PutHelperServiceProvider::class);
];

Usage

After following the above installation instructions, no further action is required. Input data (string and files) will be available for all your PUT requests

In order to validate if a param is file, use put_file in your validation. For example:

$request->validate([
'my_file' => 'required|put_file'
]);

How it Works

The package registers a global middleware that intercepts all PUT request and tries to get the input payload via php raw input stream. It then merges the parsed input data to the request object so the inputs are available normally from wherever you're accessing the request object. That is, if a file with field my_file is sent from the form, you can access via $request->file.

At the moment, $request->file('file_key') doesn't work. Use other methods instead e.g $request->file_key,$request['file_key].

Contributing

  • Fork this project
  • Clone to your repo
  • Make your changes and run tests `composer test`
  • Push and create Pull request

For more information send a message to info at phpclasses dot org.