final class ConfiguredFileUploader (View source)

Executes generic uploads against one immutable resolved policy.

Methods

__construct(UploadService $service, FileUploadOptions $options, UploadedFileResolver $uploadedFileResolver = new UploadedFileResolver())

Couples the upload workflow to one policy without owning request state.

upload(UploadedFileInterface|null $file)

Validates and publishes one supplied upload using this uploader's policy.

uploadFromRequest(ServerRequestInterface $request, string $inputName)

Resolves a nested request input and validates and publishes its uploaded file.

Exposes the immutable policy used by subsequent upload operations.

array
rules()

Exports server-enforced rules for consumers that need to describe this uploader without changing validation.

array

Details

__construct

__construct(UploadService $service, FileUploadOptions $options, UploadedFileResolver $uploadedFileResolver = new UploadedFileResolver())

Couples the upload workflow to one policy without owning request state.

Parameters

UploadService $service
FileUploadOptions $options
UploadedFileResolver $uploadedFileResolver

upload

UploadedFile upload(UploadedFileInterface|null $file)

Validates and publishes one supplied upload using this uploader's policy.

Parameters

UploadedFileInterface|null $file

Return Value

UploadedFile

uploadFromRequest

UploadedFile uploadFromRequest(ServerRequestInterface $request, string $inputName)

Resolves a nested request input and validates and publishes its uploaded file.

Parameters

ServerRequestInterface $request
string $inputName

Return Value

UploadedFile

options

Exposes the immutable policy used by subsequent upload operations.

Return Value

FileUploadOptions

rules

array rules()

Exports server-enforced rules for consumers that need to describe this uploader without changing validation.

Return Value

array