class InteractiveUpload in Lightning Media 8.4
Same name and namespace in other branches
- 8 src/Element/InteractiveUpload.php \Drupal\lightning_media\Element\InteractiveUpload
- 8.2 src/Element/InteractiveUpload.php \Drupal\lightning_media\Element\InteractiveUpload
- 8.3 src/Element/InteractiveUpload.php \Drupal\lightning_media\Element\InteractiveUpload
A form element for uploading or deleting files interactively.
Plugin annotation
@FormElement("interactive_upload");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\lightning_media\Element\InteractiveUpload
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of InteractiveUpload
File
- src/
Element/ InteractiveUpload.php, line 15
Namespace
Drupal\lightning_media\ElementView source
class InteractiveUpload extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#tree' => TRUE,
'#input' => TRUE,
'#title' => NULL,
'#default_value' => NULL,
'#process' => [
[
static::class,
'process',
],
],
'#required' => FALSE,
'#upload_location' => 'public://',
'#upload_validators' => [],
];
}
/**
* Processes the element.
*
* @param array $element
* The unprocessed element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @return array
* The processed element.
*/
public static function process(array $element, FormStateInterface $form_state) {
$element['fid'] = [
'#type' => 'hidden',
];
// This must be called upload_button in order to account for a leaky
// abstraction in Drupal core as of 8.7.x.
// @see https://www.drupal.org/project/lightning_media/issues/3056908
$element['upload_button'] = $element['remove'] = [
'#type' => 'submit',
'#is_button' => TRUE,
'#limit_validation_errors' => [
$element['#parents'],
],
'#weight' => 100,
];
$element['upload_button']['#value'] = t('Upload');
$element['upload_button']['#submit'][] = [
static::class,
'upload',
];
$element['remove']['#value'] = t('Remove');
$element['remove']['#submit'][] = [
static::class,
'remove',
];
$key = array_merge($element['#parents'], [
'fid',
]);
// Don't use $form_state->hasValue(), because it will return TRUE if the
// value exists and is falsy. Valid file IDs will always be truthy.
$fid = $form_state
->getValue($key);
if ($fid) {
$element['fid']['#value'] = $fid;
$element['file'] = [
'#theme' => 'file_link',
'#file' => File::load($fid),
];
$element['upload_button']['#access'] = FALSE;
}
else {
$element['file'] = [
'#type' => 'upload',
'#title' => $element['#title'],
'#required' => $element['#required'],
'#upload_location' => $element['#upload_location'],
'#upload_validators' => $element['#upload_validators'],
];
$element['remove']['#access'] = FALSE;
}
return $element;
}
/**
* Returns the root element for a triggering element.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @return array
* The root element that contains the triggering element.
*/
public static function el(array &$form, FormStateInterface $form_state) {
$trigger = $form_state
->getTriggeringElement();
return NestedArray::getValue($form, array_slice($trigger['#array_parents'], 0, -1));
}
/**
* Handles form submission when the Upload button is clicked.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*/
public static function upload(array &$form, FormStateInterface $form_state) {
$el = static::el($form, $form_state);
$form_state
->setValueForElement($el['fid'], $el['file']['#value']);
NestedArray::setValue($form_state
->getUserInput(), $el['fid']['#parents'], $el['file']['#value']);
$form_state
->setRebuild();
}
/**
* Handles form submission when the Remove button is clicked.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*/
public static function remove(array &$form, FormStateInterface $form_state) {
$el = static::el($form, $form_state);
Upload::delete($el['fid']);
$form_state
->setValueForElement($el['fid'], NULL);
NestedArray::setValue($form_state
->getUserInput(), $el['fid']['#parents'], NULL);
$form_state
->setRebuild();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
FormElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementInterface:: |
15 |
InteractiveUpload:: |
public static | function | Returns the root element for a triggering element. | |
InteractiveUpload:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
InteractiveUpload:: |
public static | function | Processes the element. | 1 |
InteractiveUpload:: |
public static | function | Handles form submission when the Remove button is clicked. | |
InteractiveUpload:: |
public static | function | Handles form submission when the Upload button is clicked. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |