class MediaLibraryInceptionWidget

Same name and namespace in other branches
  1. 9 core/modules/media_library/tests/modules/media_library_test_widget/src/Plugin/Field/FieldWidget/MediaLibraryInceptionWidget.php \Drupal\media_library_test_widget\Plugin\Field\FieldWidget\MediaLibraryInceptionWidget
  2. 10 core/modules/media_library/tests/modules/media_library_test_widget/src/Plugin/Field/FieldWidget/MediaLibraryInceptionWidget.php \Drupal\media_library_test_widget\Plugin\Field\FieldWidget\MediaLibraryInceptionWidget
  3. 11.x core/modules/media_library/tests/modules/media_library_test_widget/src/Plugin/Field/FieldWidget/MediaLibraryInceptionWidget.php \Drupal\media_library_test_widget\Plugin\Field\FieldWidget\MediaLibraryInceptionWidget

Plugin implementation of the 'media_library_inception_widget' widget.

This widget is used to simulate the media library widget nested inside another widget that performs validation of required fields before there is an opportunity to add media.

Plugin annotation


@FieldWidget(
  id = "media_library_inception_widget",
  label = @Translation("Media library inception widget"),
  description = @Translation("Puts a widget in a widget for testing purposes."),
  field_types = {
    "entity_reference"
  },
  multiple_values = TRUE,
)

Hierarchy

Expanded class hierarchy of MediaLibraryInceptionWidget

File

core/modules/media_library/tests/modules/media_library_test_widget/src/Plugin/Field/FieldWidget/MediaLibraryInceptionWidget.php, line 27

Namespace

Drupal\media_library_test_widget\Plugin\Field\FieldWidget
View source 
class MediaLibraryInceptionWidget extends MediaLibraryWidget {
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        if (empty($element['#element_validate'])) {
            $element['#element_validate'] = [];
        }
        $element['#element_validate'][] = [
            $this,
            'elementValidate',
        ];
        return parent::formElement($items, $delta, $element, $form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function elementValidate($element, FormStateInterface $form_state, $form) {
        $field_name = $element['#field_name'];
        $entity = $form_state->getFormObject()
            ->getEntity();
        $input = $form_state->getUserInput();
        if (!empty($input['_triggering_element_name']) && strpos($input['_triggering_element_name'], 'media-library-update') !== FALSE) {
            // This will validate a required field before an upload is completed.
            $display = EntityFormDisplay::collectRenderDisplay($entity, 'edit');
            $display->extractFormValues($entity, $form, $form_state);
            $display->validateFormValues($entity, $form, $form_state);
        }
        $form_value = $form_state->getValue($field_name);
        if (!empty($form_value['media_library_selection'])) {
            $entity->set($field_name, $form_value['media_library_selection']);
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title 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.
MediaLibraryInceptionWidget::elementValidate public function
MediaLibraryInceptionWidget::formElement public function Returns the form for a single field widget. Overrides MediaLibraryWidget::formElement
MediaLibraryWidget::$currentUser protected property The current active user.
MediaLibraryWidget::$entityTypeManager protected property Entity type manager service.
MediaLibraryWidget::$moduleHandler protected property The module handler.
MediaLibraryWidget::addItems public static function Updates the field state and flags the form for rebuild.
MediaLibraryWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
MediaLibraryWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
MediaLibraryWidget::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
MediaLibraryWidget::form public function Creates a form element for a field. Overrides WidgetBase::form
MediaLibraryWidget::getAllowedMediaTypeIdsSorted protected function Gets the enabled media type IDs sorted by weight.
MediaLibraryWidget::getFieldState protected static function Gets the field state for the widget.
MediaLibraryWidget::getNewMediaItems protected static function Gets newly selected media items.
MediaLibraryWidget::getNoMediaTypesAvailableMessage protected function Gets the message to display when there are no allowed media types.
MediaLibraryWidget::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
MediaLibraryWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
MediaLibraryWidget::openMediaLibrary public static function AJAX callback to open the library modal.
MediaLibraryWidget::preRenderWidget public function Prepares the widget's render element for rendering.
MediaLibraryWidget::removeItem public static function Submit callback for remove buttons.
MediaLibraryWidget::setFieldState protected static function Sets the field state for the widget.
MediaLibraryWidget::setMediaTypesValue public static function Value callback to optimize the way the media type weights are stored.
MediaLibraryWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
MediaLibraryWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
MediaLibraryWidget::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
MediaLibraryWidget::updateWidget public static function AJAX callback to update the widget when the selection changes.
MediaLibraryWidget::validateItems public static function Validates that newly selected items can be added to the widget.
MediaLibraryWidget::__construct public function Constructs a MediaLibraryWidget widget. Overrides WidgetBase::__construct
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.
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::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
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::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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.