ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ILIAS\UI\Component\Dropzone\File\Factory Interface Reference

Describes a factory for file dropzones. More...

+ Inheritance diagram for ILIAS\UI\Component\Dropzone\File\Factory:
+ Collaboration diagram for ILIAS\UI\Component\Dropzone\File\Factory:

Public Member Functions

 standard (string $title, string $message, string $post_url, FileInput $file_input, ?FormInput $additional_input=null,)
 

description: purpose: > The standard dropzone is used to drop files dragged from outside the browser window. More...

 
 wrapper (string $title, string $post_url, $content, FileInput $file_input, ?FormInput $additional_input=null,)
 

description: purpose: > A wrapper dropzone is used to display other ILIAS UI components inside it. More...

 

Detailed Description

Describes a factory for file dropzones.

Author
nmaerchy nm@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch
Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 31 of file Factory.php.

Member Function Documentation

◆ standard()

ILIAS\UI\Component\Dropzone\File\Factory::standard ( string  $title,
string  $message,
string  $post_url,
FileInput  $file_input,
?FormInput  $additional_input = null 
)


description: purpose: > The standard dropzone is used to drop files dragged from outside the browser window.

The dropped files are presented to the user and can be uploaded to the server. composition: > Standard dropzones consist of a visible area where files can be dropped. They MUST contain a message explaining that it is possible to drop files inside. The dropped files are presented to the user in a roundtrip modal, which contains a file input. effect: > A standard dropzone is highlighted when the user is dragging files over the dropzone. After dropping, the dropped files are presented to the user with some meta information of the files such the file name and file size. rivals: Rival 1: > A wrapper dropzone can hold other ILIAS UI components instead of a message. Rival 2: > A file-input can be used instead of this component if other values have to be submitted at the same time. rules: accessibility: 1: > Standard dropzones MUST offer the possibility to select files

manually from the computer.

Parameters
string$title
string$message
string$post_url
FileInput$file_input
FormInput$additional_input
Returns

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\Factory.

◆ wrapper()

ILIAS\UI\Component\Dropzone\File\Factory::wrapper ( string  $title,
string  $post_url,
  $content,
FileInput  $file_input,
?FormInput  $additional_input = null 
)


description: purpose: > A wrapper dropzone is used to display other ILIAS UI components inside it.

In contrast to the standard dropzone, the wrapper dropzone is not visible by default. Only the wrapped components are visible. Any wrapper dropzone gets highlighted once the user is dragging files over the browser window. Thus, a user needs to have the knowledge that there are wrapper dropzones present. They can be introduced to offer additional approaches to complete some workflow more conveniently. Especially in situation where space is scarce such as appointments in the calendar. composition: > A wrapper dropzone contains one or multiple ILIAS UI components. A roundtrip modal is used to present the dropped files and to initialize the upload process with a file input. effect: > All wrapper dropzones on the page are highlighted when the user dragging files over the browser window. After dropping the files, the roundtrip modal is opened showing all files. The modal contains a button to start the upload process. rivals: Rival 1: > A standard dropzone displays a message instead of other ILIAS UI components. rules: usage: 1: > Most pages SHOULD NOT contain a wrapper dropzone. Whenever you want to introduce a new usage of the Wrapper-Dropzone, propose it to the Jour Fixe. 2: Wrapper dropzones MUST contain one or more ILIAS UI components. 3: Wrapper dropzones MUST NOT contain any other file dropzones.

4: Wrapper dropzones MUST NOT be used in modals.

Parameters
string$title
string$post_url
Component|Component[]$content
FileInput$file_input
FormInput$additional_input
Returns

Implemented in ILIAS\UI\Implementation\Component\Dropzone\File\Factory.


The documentation for this interface was generated from the following file: