class Dropzone extends ClientSideUploader (View source)

Constants

protected CONFIGKEY_PARALLELUPLOADS

protected CONFIGKEY_CHUNK_ENABLED

protected CONFIGKEY_CHUNK_SIZE

Properties

protected Repository $config from  ClientSideUploader
protected BitmapFormat $bitmapFormat from  ClientSideUploader
protected Number $numberService from  ClientSideUploader

Methods

__construct(Repository $config, BitmapFormat $bitmapFormat, Number $numberService)

No description

bool
supportClientSizeImageResizing()

Can big images be resized on the client side before they are uploaded to the server?

int
getTimeout()

Get the maximum time (in seconds) before PHP aborts uploads.

int
getParallelUploads()

Get the number of parallel uploads.

setParallelUploads(int $value)

Set the number of parallel uploads.

bool
isChunkingEnabled()

Should the client send files in chunks if they exceed a configured size?

setChunkingEnabled(bool $value)

Should the client send files in chunks if they exceed a configured size?

int
getChunkSize()

Get the size of the uploaded file chunks (in bytes), by considering both the configured value and the PHP settings.

int|null
getConfiguredChunkSize()

Get the configured size (in bytes) of the uploaded file chunks.

setConfiguredChunkSize(int|null $value)

Set the configured size (in bytes) of the uploaded file chunks.

int|null
getPHPMaxFileSize()

Get the maximim size (in bytes) allowed by PHP for a single uploaded file.

array
getLocalizationOptions()

Get the Dropzone localization options.

array
getConfigurationOptions()

Get the Dropzone configuration options.

Details

__construct(Repository $config, BitmapFormat $bitmapFormat, Number $numberService)

No description

Parameters

Repository $config
BitmapFormat $bitmapFormat
Number $numberService

bool supportClientSizeImageResizing()

Can big images be resized on the client side before they are uploaded to the server?

int getTimeout()

Get the maximum time (in seconds) before PHP aborts uploads.

Return Value

int

int getParallelUploads()

Get the number of parallel uploads.

Return Value

int

returns 1 for no parallel uploads

ClientSideUploader setParallelUploads(int $value)

Set the number of parallel uploads.

Parameters

int $value

set to 1 for no parallel uploads.

Return Value

ClientSideUploader

bool isChunkingEnabled()

Should the client send files in chunks if they exceed a configured size?

Return Value

bool

ClientSideUploader setChunkingEnabled(bool $value)

Should the client send files in chunks if they exceed a configured size?

Parameters

bool $value

Return Value

ClientSideUploader

int getChunkSize()

Get the size of the uploaded file chunks (in bytes), by considering both the configured value and the PHP settings.

Return Value

int

int|null getConfiguredChunkSize()

Get the configured size (in bytes) of the uploaded file chunks.

Return Value

int|null

return NULL if it's not configured

ClientSideUploader setConfiguredChunkSize(int|null $value)

Set the configured size (in bytes) of the uploaded file chunks.

Parameters

int|null $value

Return Value

ClientSideUploader

int|null getPHPMaxFileSize()

Get the maximim size (in bytes) allowed by PHP for a single uploaded file.

Return Value

int|null

return NULL if there's no limit

array getLocalizationOptions()

Get the Dropzone localization options.

Return Value

array

array keys are the Dropzone configuration key, values are the configuration values

See also

https://github.com/dropzone/dropzone/blob/main/src/options.js

array getConfigurationOptions()

Get the Dropzone configuration options.

Return Value

array

array keys are the Dropzone configuration key, values are the configuration values

See also

https://docs.dropzone.dev/configuration/basics/configuration-options
https://github.com/dropzone/dropzone/blob/main/src/options.js