class ContentModerationConfigureForm in Drupal 9

The content moderation WorkflowType configuration form.

Hierarchy

• class \Drupal\workflows\Plugin\WorkflowTypeConfigureFormBase implements PluginAwareInterface, PluginFormInterface uses StringTranslationTrait
  • class \Drupal\content_moderation\Form\ContentModerationConfigureForm implements ContainerInjectionInterface

See also

\Drupal\content_moderation\Plugin\WorkflowType\ContentModeration

File

core/modules/content_moderation/src/Form/ContentModerationConfigureForm.php, line 21

Namespace

Drupal\content_moderation\Form

class ContentModerationConfigureForm extends WorkflowTypeConfigureFormBase implements ContainerInjectionInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The moderation info service.
   *
   * @var \Drupal\content_moderation\ModerationInformationInterface
   */
  protected $moderationInfo;

  /**
   * The entity type type bundle info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * Create an instance of ContentModerationConfigureForm.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, ModerationInformationInterface $moderationInformation, EntityTypeBundleInfoInterface $entityTypeBundleInfo) {
    $this->entityTypeManager = $entityTypeManager;
    $this->moderationInfo = $moderationInformation;
    $this->entityTypeBundleInfo = $entityTypeBundleInfo;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('content_moderation.moderation_information'), $container
      ->get('entity_type.bundle.info'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $workflow = $form_state
      ->getFormObject()
      ->getEntity();
    $header = [
      'type' => $this
        ->t('Items'),
      'operations' => $this
        ->t('Operations'),
    ];
    $form['entity_types_container'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('This workflow applies to:'),
      '#open' => TRUE,
    ];
    $form['entity_types_container']['entity_types'] = [
      '#type' => 'table',
      '#header' => $header,
      '#empty' => $this
        ->t('There are no entity types.'),
    ];
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    foreach ($entity_types as $entity_type) {
      if (!$this->moderationInfo
        ->canModerateEntitiesOfEntityType($entity_type)) {
        continue;
      }
      $selected_bundles = [];
      foreach ($this->entityTypeBundleInfo
        ->getBundleInfo($entity_type
        ->id()) as $bundle_id => $bundle) {
        if ($this->workflowType
          ->appliesToEntityTypeAndBundle($entity_type
          ->id(), $bundle_id)) {
          $selected_bundles[$bundle_id] = $bundle['label'];
        }
      }
      $selected_bundles_list = [
        '#theme' => 'item_list',
        '#items' => $selected_bundles,
        '#context' => [
          'list_style' => 'comma-list',
        ],
        '#empty' => $this
          ->t('none'),
      ];
      $form['entity_types_container']['entity_types'][$entity_type
        ->id()] = [
        'type' => [
          '#type' => 'inline_template',
          '#template' => '<strong>{{ label }}</strong></br><span id="selected-{{ entity_type_id }}">{{ selected_bundles }}</span>',
          '#context' => [
            'label' => $this
              ->t('@bundle types', [
              '@bundle' => $entity_type
                ->getLabel(),
            ]),
            'entity_type_id' => $entity_type
              ->id(),
            'selected_bundles' => $selected_bundles_list,
          ],
        ],
        'operations' => [
          '#type' => 'operations',
          '#links' => [
            'select' => [
              'title' => $this
                ->t('Select'),
              'url' => Url::fromRoute('content_moderation.workflow_type_edit_form', [
                'workflow' => $workflow
                  ->id(),
                'entity_type_id' => $entity_type
                  ->id(),
              ]),
              'attributes' => [
                'class' => [
                  'use-ajax',
                ],
                'data-dialog-type' => 'modal',
                'data-dialog-options' => Json::encode([
                  'width' => 700,
                ]),
              ],
            ],
          ],
        ],
      ];
    }
    $workflow_type_configuration = $this->workflowType
      ->getConfiguration();
    $form['workflow_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Workflow Settings'),
      '#open' => TRUE,
    ];
    $form['workflow_settings']['default_moderation_state'] = [
      '#title' => $this
        ->t('Default moderation state'),
      '#type' => 'select',
      '#required' => TRUE,
      '#options' => array_map([
        State::class,
        'labelCallback',
      ], $this->workflowType
        ->getStates()),
      '#description' => $this
        ->t('Select the state that new content will be assigned. This state will appear as the default in content forms and the available target states will be based on the transitions available from this state.'),
      '#default_value' => isset($workflow_type_configuration['default_moderation_state']) ? $workflow_type_configuration['default_moderation_state'] : 'draft',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $configuration = $this->workflowType
      ->getConfiguration();
    $configuration['default_moderation_state'] = $form_state
      ->getValue([
      'workflow_settings',
      'default_moderation_state',
    ]);
    $this->workflowType
      ->setConfiguration($configuration);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentModerationConfigureForm::$entityTypeBundleInfo	protected	property	The entity type type bundle info service.
ContentModerationConfigureForm::$entityTypeManager	protected	property	The entity type manager.
ContentModerationConfigureForm::$moderationInfo	protected	property	The moderation info service.
ContentModerationConfigureForm::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ContentModerationConfigureForm::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
ContentModerationConfigureForm::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ContentModerationConfigureForm::__construct	public	function	Create an instance of ContentModerationConfigureForm.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
WorkflowTypeConfigureFormBase::$workflowType	protected	property	The workflow type.
WorkflowTypeConfigureFormBase::setPlugin	public	function	Sets the plugin for this object. Overrides PluginAwareInterface::setPlugin
WorkflowTypeConfigureFormBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm