infinityloop-dev/graphpinator-upload

Module to handle multipart formdata requests.

v1.1 2023-11-10 18:00 UTC

Requires

• php: >=8.1
• infinityloop-dev/graphpinator: ^1.6
• infinityloop-dev/utils: ^2.3
• psr/http-message: ^2.0

Requires (Dev)

• infection/infection: ^0.27
• infinityloop-dev/coding-standard: ^0.2
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.4

MIT

• Václav Pelíšek

README

⚡🌐⚡ Module to handle multipart formdata requests.

Introduction

This Module allows GraPHPinator to handle uploads using multipart-formdata requests. This module hooks into Graphpinator workflow before parsing the request, reads the map and places uploaded files into according variable.

Installation

Install package using composer

composer require infinityloop-dev/graphpinator-upload

How to use

1. Implement FileProvider

FileProvider is a service that extracts files from a multipart request by their key. Each HTTP framework provides its own implementation and FileProvider serves as an adapter. Framework specific implementations can be found in Graphpinator packages for according framework, eg infinityloop-dev/graphpinator-nette contains FileProvider implementation for Nette's HTTP abstraction.

1. Register UploadModule as GraPHPinator module:

$uploadModule = new \Graphpinator\Upload\UploadModule($fileProvider);
$graphpinator = new \Graphpinator\Graphpinator(
    $schema,
    $catchExceptions,
    new \Graphpinator\Module\ModuleSet([$uploadModule, /* possibly other modules */]),
    $logger,
);

1. Register UploadType to your Container:

This step is probably done by registering UploadType as service to your DI solution.

1. Optional step: Use infinityloop-dev/graphpinator-constraint-directives to validate uploaded files.

For more information visit constraint directives package.

Known limitations

• Currently, this Module can place files only to variable values and not to arguments directly.
  • This is done to ensure implementation simplicity & compatibility with other modules.
  • There is probably no benefit in placing the files directly to arguments. If you stumble upon some important edge scenario, please open an issue and we can discuss possible solution here.