class AjaxUpload in Lightning Media 8

An interactive, AJAX-ey file upload form element.

Plugin annotation

@FormElement("ajax_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\lightning_media\Element\AjaxUpload

1 file declares its use of AjaxUpload

FileUpload.php in src/Plugin/EntityBrowser/Widget/FileUpload.php

1 #type use of AjaxUpload

FileUpload::getForm in src/Plugin/EntityBrowser/Widget/FileUpload.php

File

src/Element/AjaxUpload.php, line 13

Namespace

Drupal\lightning_media\Element

class AjaxUpload extends InteractiveUpload {

  /**
   * {@inheritdoc}
   */
  public static function process(array $element, FormStateInterface $form_state) {
    $element = parent::process($element, $form_state);

    // Generate a CSS ID for the wrapping DIV.
    $wrapper_id = implode('-', $element['#parents']);
    $wrapper_id = Html::cleanCssIdentifier($wrapper_id);

    // The element being processed is just a wrapper, and does not accept input
    // or support AJAX directly. Still, store the wrapping DIV ID in a spot
    // where other elements can access it if they need to refer to it.
    $element['#ajax']['wrapper'] = $wrapper_id;

    // Bring in the File module's slick auto-uploading stuff.
    $element['#attached']['library'][] = 'file/drupal.file';

    // The js-form-managed-file class is needed for the File module's
    // auto-upload JavaScript to target this element.
    $element['#prefix'] = '<div class="js-form-managed-file" id="' . $wrapper_id . '">';
    $element['#suffix'] = '</div>';

    // Hide the upload button. It will be triggered by the auto-upload JS.
    $element['upload']['#attributes']['class'][] = 'js-hide';

    // As far as AJAX is concerned, the Upload and Remove buttons do the same
    // thing (return their parent element). The differences lie in their
    // respective submit functions.
    $element['upload']['#ajax'] = $element['remove']['#ajax'] = [
      'callback' => [
        static::class,
        'el',
      ],
      'wrapper' => $wrapper_id,
    ];
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AjaxUpload::process	public static	function	Processes the element. Overrides InteractiveUpload::process
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
InteractiveUpload::el	public static	function	Returns the root element for a triggering element.
InteractiveUpload::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
InteractiveUpload::remove	public static	function	Handles form submission when the Remove button is clicked.
InteractiveUpload::upload	public static	function	Handles form submission when the Upload button is clicked.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.