UploadGuard

A helper for dealing with file upload validation.

class UploadGuard

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`finfo $finfo`) Creates a new UploadGuard.

Public
Returns	Signature and Description
`string`	`getMimeType`(`UploadedFileInterface $file`, `string $field`, `?ConstSet<string> $mimeTypes = null`) Validates the uploaded files in a request.
`ConstVector`<`UploadedFileInterface`>	`getUploadedFiles`(`ServerRequestInterface $request`, `string $field`, `?int $maxSize = null`) Gets the list of uploaded files, validating file size.

public function __construct(finfo $finfo)

Creates a new UploadGuard.

Parameters
Name	Type	Description
`$finfo`	`finfo`	The MIME detector

public function getMimeType(UploadedFileInterface $file, string $field, ?ConstSet<string> $mimeTypes = null)

Validates the uploaded files in a request.

Parameters
Name	Type	Description
`$file`	`UploadedFileInterface`	The uploaded file
`$field`	`string`
`$mimeTypes`	`?ConstSet`<`string`>	A set of allowed MIME types (e.g. `image/svg+xml`, 'video/*')

Returns
Type	Description
`string`	The MIME type

Throws
Type	Conditions
`Invalid`	if the file aren't valid

public function getUploadedFiles(ServerRequestInterface $request, string $field, ?int $maxSize = null)

Gets the list of uploaded files, validating file size.

Parameters
Name	Type	Description
`$request`	`ServerRequestInterface`	The PSR HTTP Request
`$field`	`string`	The request field containing the files
`$maxSize`	`?int`	The maximum allowed file size

Returns
Type	Description
`ConstVector`<`UploadedFileInterface`>	The uploaded files

Throws
Type	Conditions
`Invalid`	if any files aren't valid