class ModerationStateWidget

Same name in other branches
  1. 8.9.x core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php \Drupal\content_moderation\Plugin\Field\FieldWidget\ModerationStateWidget
  2. 10 core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php \Drupal\content_moderation\Plugin\Field\FieldWidget\ModerationStateWidget
  3. 11.x core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php \Drupal\content_moderation\Plugin\Field\FieldWidget\ModerationStateWidget

Plugin implementation of the 'moderation_state_default' widget.

Plugin annotation


@FieldWidget(
  id = "moderation_state_default",
  label = @Translation("Moderation state"),
  field_types = {
    "string"
  }
)

Hierarchy

Expanded class hierarchy of ModerationStateWidget

1 file declares its use of ModerationStateWidget
ModerationStateWidgetTest.php in core/modules/content_moderation/tests/src/Kernel/ModerationStateWidgetTest.php

File

core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php, line 27

Namespace

Drupal\content_moderation\Plugin\Field\FieldWidget
View source
class ModerationStateWidget extends OptionsSelectWidget {
    
    /**
     * Current user service.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $currentUser;
    
    /**
     * Moderation information service.
     *
     * @var \Drupal\content_moderation\ModerationInformation
     */
    protected $moderationInformation;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Moderation state transition validation service.
     *
     * @var \Drupal\content_moderation\StateTransitionValidationInterface
     */
    protected $validator;
    
    /**
     * Constructs a new ModerationStateWidget object.
     *
     * @param string $plugin_id
     *   Plugin id.
     * @param mixed $plugin_definition
     *   Plugin definition.
     * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
     *   Field definition.
     * @param array $settings
     *   Field settings.
     * @param array $third_party_settings
     *   Third party settings.
     * @param \Drupal\Core\Session\AccountInterface $current_user
     *   Current user service.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   Entity type manager.
     * @param \Drupal\content_moderation\ModerationInformation $moderation_information
     *   Moderation information service.
     * @param \Drupal\content_moderation\StateTransitionValidationInterface $validator
     *   Moderation state transition validation service.
     */
    public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, ModerationInformation $moderation_information, StateTransitionValidationInterface $validator) {
        parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
        $this->entityTypeManager = $entity_type_manager;
        $this->currentUser = $current_user;
        $this->moderationInformation = $moderation_information;
        $this->validator = $validator;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container->get('current_user'), $container->get('entity_type.manager'), $container->get('content_moderation.moderation_information'), $container->get('content_moderation.state_transition_validation'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(FieldItemListInterface $items, array &$form, FormStateInterface $form_state, $get_delta = NULL) {
        $entity = $items->getEntity();
        if (!$this->moderationInformation
            ->isModeratedEntity($entity)) {
            return [];
        }
        return parent::form($items, $form, $form_state, $get_delta);
    }
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
        $entity = $original_entity = $items->getEntity();
        $default = $this->moderationInformation
            ->getOriginalState($entity);
        // If the entity already exists, grab the most recent revision and load it.
        // The moderation state of the saved revision will be used to display the
        // current state as well determine the appropriate transitions.
        if (!$entity->isNew()) {
            
            /** @var \Drupal\Core\Entity\ContentEntityInterface $original_entity */
            $original_entity = $this->entityTypeManager
                ->getStorage($entity->getEntityTypeId())
                ->loadRevision($entity->getLoadedRevisionId());
            if (!$entity->isDefaultTranslation() && $original_entity->hasTranslation($entity->language()
                ->getId())) {
                $original_entity = $original_entity->getTranslation($entity->language()
                    ->getId());
            }
        }
        else {
            $original_entity->set('moderation_state', $default->id());
        }
        
        /** @var \Drupal\workflows\Transition[] $transitions */
        $transitions = $this->validator
            ->getValidTransitions($original_entity, $this->currentUser);
        $transition_labels = [];
        $default_value = $items->value;
        foreach ($transitions as $transition) {
            $transition_to_state = $transition->to();
            $transition_labels[$transition_to_state->id()] = $transition_to_state->label();
            if ($default->id() === $transition_to_state->id()) {
                $default_value = $default->id();
            }
        }
        $element += [
            '#type' => 'container',
            'current' => [
                '#type' => 'item',
                '#title' => $this->t('Current state'),
                '#markup' => $default->label(),
                '#access' => !$entity->isNew(),
                '#wrapper_attributes' => [
                    'class' => [
                        'container-inline',
                    ],
                ],
            ],
            'state' => [
                '#type' => 'select',
                '#title' => $entity->isNew() ? $this->t('Save as') : $this->t('Change to'),
                '#key_column' => $this->column,
                '#options' => $transition_labels,
                '#default_value' => $default_value,
                '#access' => !empty($transition_labels),
                '#wrapper_attributes' => [
                    'class' => [
                        'container-inline',
                    ],
                ],
            ],
        ];
        $element['#element_validate'][] = [
            static::class,
            'validateElement',
        ];
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function validateElement(array $element, FormStateInterface $form_state) {
        $form_state->setValueForElement($element, [
            $element['state']['#key_column'] => $element['state']['#value'],
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function isApplicable(FieldDefinitionInterface $field_definition) {
        return is_a($field_definition->getClass(), ModerationStateFieldItemList::class, TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        $dependencies = parent::calculateDependencies();
        if ($workflow = $this->moderationInformation
            ->getWorkflowForEntityTypeAndBundle($this->fieldDefinition
            ->getTargetEntityTypeId(), $this->fieldDefinition
            ->getTargetBundle())) {
            $dependencies[$workflow->getConfigDependencyKey()][] = $workflow->getConfigDependencyName();
        }
        return $dependencies;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ModerationStateWidget::$currentUser protected property Current user service.
ModerationStateWidget::$entityTypeManager protected property The entity type manager.
ModerationStateWidget::$moderationInformation protected property Moderation information service.
ModerationStateWidget::$validator protected property Moderation state transition validation service.
ModerationStateWidget::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ModerationStateWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
ModerationStateWidget::form public function Creates a form element for a field. Overrides WidgetBase::form
ModerationStateWidget::formElement public function Returns the form for a single field widget. Overrides OptionsSelectWidget::formElement
ModerationStateWidget::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
ModerationStateWidget::validateElement public static function Form validation handler for widget elements. Overrides OptionsWidgetBase::validateElement
ModerationStateWidget::__construct public function Constructs a new ModerationStateWidget object. Overrides OptionsWidgetBase::__construct
OptionsSelectWidget::getEmptyLabel protected function Returns the empty option label to add to the list of options, if any. Overrides OptionsWidgetBase::getEmptyLabel
OptionsSelectWidget::sanitizeLabel protected function Sanitizes a string label to display as an option. Overrides OptionsWidgetBase::sanitizeLabel
OptionsSelectWidget::supportsGroups protected function Indicates whether the widgets support optgroups. Overrides OptionsWidgetBase::supportsGroups
OptionsWidgetBase::$column protected property Abstract over the actual field columns.
OptionsWidgetBase::$has_value protected property Tracks whether the field has a value.
OptionsWidgetBase::$multiple protected property Tracks whether the data is multi-valued.
OptionsWidgetBase::$options protected property The array of options for the widget.
OptionsWidgetBase::$required protected property Tracks whether the field is required.
OptionsWidgetBase::getOptions protected function Returns the array of options for the widget.
OptionsWidgetBase::getSelectedOptions protected function Determines selected options from the incoming field values.
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 43
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
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::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 3
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::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
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.