CoolCMS API

UploaderDropzone extends BaseComponent

in package

• Application

Table of Contents

Constants

CLIENT_RESIZE_MAX_DEFAULT  : int = 2560

Browser-side image downscale before upload: a longer side above this limit is redrawn by `dropzone.js` on a canvas to fit it. `0` disables it (attachments must not be modified).

CLIENT_RESIZE_QUALITY_DEFAULT  : float = 0.85

JPEG quality after browser-side downscale (PNG stays PNG and ignores it).

DEFAULT_MAX_PENDING_TOKENS  : int = 20

Default maximum of in-progress upload folders per session (several tabs/forms).

DEFAULT_MAX_SESSION_MB  : int = 300

Default cap, in MB, on the total size of uploaded but not yet submitted files of one session.

SETTING_MAX_PENDING_FORMS  : string = 'upload.dropzone.maxPendingForms'

SETTING_MAX_SESSION_MB  : string = 'upload.dropzone.maxSessionMb'

PENDING_INDEX_KEY  : string = 'pendingTokens'

Session key holding the list of in-progress tokens (oldest first).

Properties

$container  : Container

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$appContext  : AppContext

$componentParameters  : array<string, mixed>

$currencyContext  : CurrencyContext|null

$deviceDetector  : DeviceDetector|null

$languageContext  : LanguageContext|null

$localizationContext  : LocalizationContext|null

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string|null

$allowedExtensions  : array<int, string>

Extensions without a dot, case-insensitive. Empty means MIME check only. A non-empty list is authoritative and the MIME from the upload header is not checked, like the admin {@see \App\UI\Admin\Base\Components\UploaderDropzoneComponent\UploaderDropzone}.

$allowedMimeTypes  : array<string|int, string>

$clientResizeMax  : int

Longer image side after browser-side downscale; `0` means no downscale, see `disableClientResize()`.

$clientResizeQuality  : float

$existingAssets  : array<string|int, mixed>

$fieldName  : string

$hint  : string|null

Hint text under the zone. `null` is the default `dropzone.hint` built from accepted formats and the limit (same configuration as the upload check, see `UploadFormats`), `''` hides it for forms with other limits/types that print their own hint (complaint).

$maxFiles  : int

$maxFileSize  : int

$session  : Session

$sessionSection  : SessionSection

$subDir  : string

$token  : string|null

Methods

__call()  : mixed

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

__construct()  : mixed

cleanup()  : void

Deletes the temp folder and removes the session record.

configure()  : self

createComponent()  : IComponent|null

disableClientResize()  : self

getAppContext()  : AppContext

getClientResizeMax()  : int

getClientResizeQuality()  : float

getComponentParameter()  : mixed

Returns a component parameter, or null when it is not set.

getContainer()  : Container

getCurrencyContext()  : CurrencyContext|null

getEffectiveMaxFileSize()  : int

App limit narrowed by the PHP limits (`upload_max_filesize`, `post_max_size`).

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

getSettings()  : array<int, array<string, mixed>>

getTempDir()  : string|null

Returns the temp folder path from the session.

getThemeContext()  : ThemeContext|null

getToken()  : string|null

getUploadedFiles()  : array<int, array{name: string, path: string}>

Returns uploaded files as references `[name, path]`; the content is not read. The Api reads each file itself when it processes it (see {@see \App\Core\Security\Upload\UploadedItem}), so the files never sit in memory together (base64 of all files at once would exceed `memory_limit`).

handleRemove()  : void

AJAX signal: deletes one file from the temp folder.

handleUpload()  : void

AJAX signal: uploads one file. The token comes from the URL (signal parameter) and says which session/folder the file belongs to.

hasServiceByType()  : bool

Returns whether the container has a service of the given type.

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

prepareTempDir()  : string

Prepares the temp folder for uploaded files and returns the token that identifies it.

render()  : void

resolveMaxPendingTokens()  : int

Returns the in-progress forms cap from the setting value; empty, non-numeric or below 1 means the default.

resolveMaxSessionBytes()  : int

Returns the session in-progress files cap in bytes from the setting value in MB; empty, non-numeric or below 1 means the default.

setAppContext()  : $this

setClientResize()  : self

The caller sets browser-side downscale because it knows what the uploader carries.

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setExistingAssets()  : self

Sets existing images (for display in the list).

setHint()  : self

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setToken()  : self

setup()  : void

setupAppContext()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

frontPresenter()  : BasePresenter|null

Returns the front presenter the component is attached to (null outside the front end or when detached).

getTranslator()  : ITranslator

setTemplateFile()  : void

setTranslator()  : self

computePendingBytes()  : int

Sums the bytes of files in all in-progress folders of the session.

createMultiplierComponent()  : Multiplier<string|int, IComponent>

Creates a multiplier for the component.

createNewComponentInstance()  : IComponent|null

Creates a new component instance without adding it to the presenter; used by the multiplier.

createStandardComponent()  : IComponent|null

Creates a standard component (not a multiplier).

getPendingTokens()  : array<int, string>

getSessionKey()  : string

The session key contains the token, so forms open in parallel (several tabs) have their own record and do not wipe each other's temp folder.

isInsideDropzoneRoot()  : bool

Safety check before deleting: the path must lie under the dropzone root (see `DropzoneTempRoot`).

registerPendingToken()  : void

Registers the session key in the list of in-progress tokens; above `upload.dropzone.maxPendingForms` the oldest is cleaned up (folder and record). The list is shared by all uploaders in the session.

sendJsonResponse()  : void

unregisterPendingToken()  : void