ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ILIAS\UI\Implementation\Component\Dropzone\File\Standard Class Reference
+ Inheritance diagram for ILIAS\UI\Implementation\Component\Dropzone\File\Standard:
+ Collaboration diagram for ILIAS\UI\Implementation\Component\Dropzone\File\Standard:

Public Member Functions

 __construct (SignalGeneratorInterface $signal_generator, FieldFactory $field_factory, NameSource $name_source, string $title, string $message, string $post_url, FileInput $file_input, ?FormInput $additional_input)
 
 getMessage ()
 Get the message of this dropzone. More...
 
 withUploadButton (Button $button)
 Get a dropzone like this, using the given button to upload the files to the server. More...
 
 getUploadButton ()
 Get the button to upload the files to the server. More...
 
 withBulky (bool $bulky)
 Makes a dropzone bulky, this to ensure better visibility when the dropzone is to be displayed standalone. More...
 
 isBulky ()
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Component\Dropzone\File\File
 __construct (SignalGeneratorInterface $signal_generator, FieldFactory $field_factory, NameSource $name_source, string $title, string $post_url, FileInput $file_input, ?FormInput $additional_input)
 
 getModal ()
 
 getClearSignal ()
 Returns a signal that can be used to clear the current file queue. More...
 
 getTitle ()
 Get the custom title if set. More...
 
 withOnClose (Signal $signal)
 Get a component like this, triggering a signal of another component on close. More...
 
 appendOnClose (Signal $signal)
 Get a component like this, triggering a signal of another component on close. More...
 
 getAsyncRenderUrl ()
 Get the url returning the rendered modal, if the modals content should be rendered via ajax. More...
 
 withAsyncRenderUrl (string $url)
 Get a modal like this who's content is rendered via ajax by the given $url before the modal is shown. More...
 
 withCloseWithKeyboard (bool $state)
 Get a modal like this which can or cannot be closed by keyboard (ESC), depending on the given $state. More...
 
 getCloseWithKeyboard ()
 Returns if this modal can be closed with the keyboard (ESC key) More...
 
 getShowSignal ()
 Get the signal to show this modal in the frontend. More...
 
 getCloseSignal ()
 Get the signal to close this modal in the frontend. More...
 
 withOnLoad (Signal $signal)
 Trigger a signal of another component on load. More...
 
 appendOnLoad (Signal $signal)
 Get a component like this, triggering a signal of another component on load. More...
 
 getContent ()
 Get the components representing the content of the modal. More...
 
 getActionButtons ()
 Get all action buttons in the footer of the modal. More...
 
 getCancelButtonLabel ()
 Get the custom label of the cancel button in the footer. More...
 
 withActionButtons (array $buttons)
 Get a modal like this with the provided action buttons in the footer. More...
 
 withCancelButtonLabel (string $label)
 Get the modal like this with the provided cancel button string. More...
 
 getReplaceSignal ()
 Get the signal to replace the content of this modal. More...
 
 getPostURL ()
 
 withSubmitLabel (string $caption)
 
 getSubmitLabel ()
 
 getInputs ()
 
 withRequest (ServerRequestInterface $request)
 
 withAdditionalTransformation (Transformation $trafo)
 
 getData ()
 
 getError ()
 
 withOnDrop (Signal $signal)
 Get a component like this, triggering a signal of another component when files have been dropped. More...
 
 withAdditionalDrop (Signal $signal)
 Get a component like this, triggering a signal of another component when files have been dropped. More...
 
 withResetSignals ()
 Get a component like this but reset (regenerate) its signals. More...
 
 initSignals ()
 Init the default signals plus extra signals like Replace. More...
 
 withDedicatedName (string $dedicated_name)
 No dedicated name can be set for this subform. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
 withOnLoadCode (Closure $binder)
 
 withAdditionalOnLoadCode (Closure $binder)
 Add some onload-code to the component instead of replacing the existing one. More...
 
 getOnLoadCode ()
 Get the currently bound on load code. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Triggerer
 withResetTriggeredSignals ()
 Get a component like this but reset any triggered signals of other components. More...
 
 getTriggeredSignals ()
 Get all triggered signals of this component. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Button\Button
 getLabel ()
 Get the label on the button. More...
 
 withLabel (string $label)
 Get a button like this, but with an additional/replaced label. More...
 
 getAction ()
 Get the action of the button, i.e. More...
 
 isActive ()
 Get to know if the button is activated. More...
 
 withUnavailableAction (bool $flag=true)
 Get a button like this, but action should be unavailable atm. More...
 
 withAriaLabel (string $aria_label)
 Get a button like this, but with an additional/replaced aria-label. More...
 
 getAriaLabel ()
 Get the aria-label on the button. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Clickable
 withOnClick (Signal $signal)
 Get a component like this, triggering a signal of another component on click. More...
 
 appendOnClick (Signal $signal)
 Get a component like this, triggering a signal of another component on click. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Hoverable
 withOnHover (Signal $signal)
 Get a component like this, triggering a signal of another component on hover. More...
 
 appendOnHover (Signal $signal)
 Get a component like this, triggering a signal of another component on hover. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Button\Engageable
 isEngageable ()
 Returns whether the button is stateful or not. More...
 
 withEngagedState (bool $state)
 Get a copy of the Engageable Button with engaged state for $state=true and with disengaged state for $state=false. More...
 
 isEngaged ()
 Returns whether the button is currently engaged or not. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\HasHelpTopics
 withHelpTopics (Topic ... $topics)
 Let this component have the given topics. More...
 
 withAdditionalHelpTopics (Topic ... $topics)
 Let this component also have the given topics. More...
 
 getHelpTopics ()
 
- Public Member Functions inherited from ILIAS\UI\Component\Button\LoadingAnimationOnClick
 withLoadingAnimationOnClick (bool $loading_animation_on_click)
 If clicked the button will display a spinner wheel to show that a request is being processed in the background. More...
 
 hasLoadingAnimationOnClick ()
 Return whether loading animation has been activated. More...
 

Protected Attributes

Button $upload_button = null
 
string $message
 
bool $bulky = false
 
- Protected Attributes inherited from ILIAS\UI\Implementation\Component\Dropzone\File\File
SignalGeneratorInterface $signal_generator
 
Signal $clear_signal
 
RoundTrip $modal
 

Detailed Description

Author
Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

Definition at line 34 of file Standard.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\UI\Implementation\Component\Dropzone\File\Standard::__construct ( SignalGeneratorInterface  $signal_generator,
FieldFactory  $field_factory,
NameSource  $name_source,
string  $title,
string  $message,
string  $post_url,
FileInput  $file_input,
?FormInput  $additional_input 
)

Definition at line 40 of file Standard.php.

References ILIAS\UI\Implementation\Component\Dropzone\File\Standard\$message, and ILIAS\GlobalScreen\Provider\__construct().

49  {
52  $field_factory,
53  $name_source,
54  $title,
55  $post_url,
56  $file_input,
57  $additional_input,
58  );
59  $this->message = $message;
60  }
SignalGeneratorInterface $signal_generator
Definition: File.php:46
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ getMessage()

ILIAS\UI\Implementation\Component\Dropzone\File\Standard::getMessage ( )

Get the message of this dropzone.

Implements ILIAS\UI\Component\Dropzone\File\Standard.

Definition at line 62 of file Standard.php.

References ILIAS\UI\Implementation\Component\Dropzone\File\Standard\$message.

Referenced by ILIAS\UI\Implementation\Component\Dropzone\File\Renderer\renderStandard().

62  : string
63  {
64  return $this->message;
65  }
+ Here is the caller graph for this function:

◆ getUploadButton()

ILIAS\UI\Implementation\Component\Dropzone\File\Standard::getUploadButton ( )

Get the button to upload the files to the server.

Implements ILIAS\UI\Component\Dropzone\File\Standard.

Definition at line 74 of file Standard.php.

References ILIAS\UI\Implementation\Component\Dropzone\File\Standard\$upload_button.

Referenced by ILIAS\UI\Implementation\Component\Dropzone\File\Renderer\renderStandard().

74  : ?Button
75  {
76  return $this->upload_button;
77  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Bulky.php:21
+ Here is the caller graph for this function:

◆ isBulky()

ILIAS\UI\Implementation\Component\Dropzone\File\Standard::isBulky ( )

Definition at line 86 of file Standard.php.

References ILIAS\UI\Implementation\Component\Dropzone\File\Standard\$bulky.

Referenced by ILIAS\UI\Implementation\Component\Dropzone\File\Renderer\renderStandard().

86  : bool
87  {
88  return $this->bulky;
89  }
+ Here is the caller graph for this function:

◆ withBulky()

ILIAS\UI\Implementation\Component\Dropzone\File\Standard::withBulky ( bool  $bulky)

Makes a dropzone bulky, this to ensure better visibility when the dropzone is to be displayed standalone.

Implements ILIAS\UI\Component\Dropzone\File\Standard.

Definition at line 79 of file Standard.php.

References ILIAS\UI\Implementation\Component\Dropzone\File\Standard\$bulky.

79  : StandardDropzone
80  {
81  $clone = clone $this;
82  $clone->bulky = $bulky;
83  return $clone;
84  }

◆ withUploadButton()

ILIAS\UI\Implementation\Component\Dropzone\File\Standard::withUploadButton ( Button  $button)

Get a dropzone like this, using the given button to upload the files to the server.

Implements ILIAS\UI\Component\Dropzone\File\Standard.

Definition at line 67 of file Standard.php.

67  : self
68  {
69  $clone = clone $this;
70  $clone->upload_button = $button;
71  return $clone;
72  }

Field Documentation

◆ $bulky

bool ILIAS\UI\Implementation\Component\Dropzone\File\Standard::$bulky = false
protected

◆ $message

string ILIAS\UI\Implementation\Component\Dropzone\File\Standard::$message
protected

◆ $upload_button

Button ILIAS\UI\Implementation\Component\Dropzone\File\Standard::$upload_button = null
protected

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