You are here

Home » API reference » S3 File System CORS Upload 8 » S3fsCorsFileWidget.php

class S3fsCorsFileWidget in S3 File System CORS Upload 8

Plugin implementation of the 's3fs_cors_widget' widget.

Plugin annotation


@FieldWidget(
  id = "s3fs_cors_file_widget",
  label = @Translation("S3fs Cors File Upload"),
  field_types = {
    "file",
    "s3fs_cors_file"
  }
)

Hierarchy

Expanded class hierarchy of S3fsCorsFileWidget

File

src/Plugin/Field/FieldWidget/S3fsCorsFileWidget.php, line 24

Namespace

Drupal\s3fs_cors\Plugin\Field\FieldWidget
View source 
class S3fsCorsFileWidget extends FileWidget {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = parent::defaultSettings();
    $settings['max_filesize'] = '';
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['max_filesize'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Maximum upload size'),
      '#description' => $this
        ->t('Enter a value like "512" (bytes), "80 KB" (kilobytes), "50 MB" (megabytes) or "2 GB" (gigabytes) in order to restrict the allowed file size. This value will override any value specified in the field configuration settings.'),
      '#default_value' => $this
        ->getSetting('max_filesize'),
      '#size' => 10,
      '#weight' => 5,
      '#element_validate' => [
        [
          $this,
          'settingsMaxFilesizeValidate',
        ],
      ],
    ];
    return $elements;
  }

  /**
   * Validate the submiited value for max filesize.
   */
  public function settingsMaxFilesizeValidate($element, FormStateInterface $form_state) {
    $submitted_value = $form_state
      ->getValue($element['#parents']);
    if ($submitted_value) {
      $matches = [];
      if (preg_match('/(\\d+)(.*)/', $submitted_value, $matches)) {
        $suffix = strtoupper(trim($matches[2]));
        if ($suffix && !in_array($suffix, [
          'B',
          'KB',
          'MB',
          'GB',
        ])) {
          $form_state
            ->setError($element, $this
            ->t('Invalid numeric value or size suffix. Specify an integer followed by "KB", "MB" or "GB".'));
          return;
        }
      }
      $max_filesize = Bytes::toInt($submitted_value);
      if (!$max_filesize) {
        $form_state
          ->setError($element, $this
          ->t('Invalid max filesize. Enter a value like "512" (bytes), "80 KB" (kilobytes), "50 MB" (megabytes) or "2 GB" (gigabytes).'));
      }
      if ($max_filesize > Bytes::toInt('5 GB')) {
        $form_state
          ->setError($element, $this
          ->t('Invalid max filesize. 5 GB is largest file size current supported.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($this
      ->getSetting('max_filesize')) {
      $summary[] = $this
        ->t('Max upload filesize: @max_filesize (override field configuration value).', [
        '@max_filesize' => $this
          ->getSetting('max_filesize'),
      ]);
    }
    else {
      $summary[] = $this
        ->t('Max upload filesize not specified (use field configuration value).');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $element_info = $this->elementInfo
      ->getInfo('s3fs_cors_file');

    // Use specified max filesize override or the default value for this field.
    $max_filesize = $this
      ->getSetting('max_filesize') ?: $element['#upload_validators']['file_validate_size'][0];

    // Specify custom element validation.
    $element['#element_validate'] = [
      [
        '\\Drupal\\s3fs_cors\\Element\\S3fsCorsFile',
        'validateManagedFile',
      ],
    ];
    $element['#type'] = 's3fs_cors_file';
    $element['#process'][] = $element_info['#process'][0];
    $element['#process'][] = $element['#process'][1];
    $element['#max_filesize'] = $max_filesize;
    $element['#upload_validators']['file_validate_size'] = [
      $max_filesize,
    ];
    $element['#attributes'] = [
      'class' => [
        's3fs-cors-file',
      ],
    ];
    return $element;
  }

  /**
   * Form API callback. Retrieves the value for the file_generic field element.
   *
   * This method is assigned as a #value_callback in formElement() method.
   */
  public static function value($element, $input = FALSE, FormStateInterface $form_state = NULL) {
    if ($input) {

      // Checkboxes lose their value when empty.
      // If the display field is present make sure its unchecked value is saved.
      if (empty($input['display'])) {
        $input['display'] = $element['#display_field'] ? 0 : 1;
      }

      // Suppress processing of multiple uploads at the same time to force each
      // uploaded file to be processed separately.
      // Refer https://www.drupal.org/project/s3fs_cors/issues/2980155
      if (in_array('upload', array_keys($input)) && is_null($input['upload'])) {
        $input = FALSE;
      }
    }

    // We depend on the managed file element to handle uploads.
    $return = S3fsCorsFile::valueCallback($element, $input, $form_state);

    // Ensure that all the required properties are returned even if empty.
    $return += [
      'fids' => [],
      'display' => 1,
      'description' => '',
    ];
    return $return;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
FileWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
FileWidget::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
FileWidget::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBase::flagErrors
FileWidget::formMultipleElements protected function Overrides \Drupal\Core\Field\WidgetBase::formMultipleElements(). Overrides WidgetBase::formMultipleElements 1
FileWidget::getDescriptionFromElement protected static function Retrieves the file description from a field field element.
FileWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
FileWidget::process public static function Form API callback: Processes a file_generic field element. 1
FileWidget::processMultiple public static function Form API callback: Processes a group of file_generic field elements.
FileWidget::submit public static function Form submission handler for upload/remove button of formElement().
FileWidget::validateMultipleCount public static function Form element validation callback for upload element on file widget. Checks if user has uploaded more files than allowed.
FileWidget::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct 1
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
S3fsCorsFileWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides FileWidget::defaultSettings
S3fsCorsFileWidget::formElement public function Returns the form for a single field widget. Overrides FileWidget::formElement
S3fsCorsFileWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides FileWidget::settingsForm
S3fsCorsFileWidget::settingsMaxFilesizeValidate public function Validate the submiited value for max filesize.
S3fsCorsFileWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides FileWidget::settingsSummary
S3fsCorsFileWidget::value public static function Form API callback. Retrieves the value for the file_generic field element. Overrides FileWidget::value
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState