ContentModerationConfigureEntityTypesForm.php

<?php

namespace Drupal\content_moderation\Form;

use Drupal\Component\Plugin\Exception\PluginNotFoundException;
use Drupal\content_moderation\ModerationInformationInterface;
use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\CloseDialogCommand;
use Drupal\Core\Ajax\HtmlCommand;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\EventSubscriber\MainContentViewSubscriber;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\workflows\WorkflowInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * The form for editing entity types associated with a workflow.
 *
 * @internal
 */
class ContentModerationConfigureEntityTypesForm extends FormBase {
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The entity type bundle information service.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $bundleInfo;
    
    /**
     * The moderation information service.
     *
     * @var \Drupal\content_moderation\ModerationInformationInterface
     */
    protected $moderationInformation;
    
    /**
     * The workflow entity object.
     *
     * @var \Drupal\workflows\WorkflowInterface
     */
    protected $workflow;
    
    /**
     * The entity type definition object.
     *
     * @var \Drupal\Core\Entity\EntityTypeInterface
     */
    protected $entityType;
    
    /**
     * The Messenger service.
     *
     * @var \Drupal\Core\Messenger\MessengerInterface
     */
    protected $messenger;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager'), $container->get('entity_type.bundle.info'), $container->get('content_moderation.moderation_information'), $container->get('messenger'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $bundle_info, ModerationInformationInterface $moderation_information, MessengerInterface $messenger) {
        $this->entityTypeManager = $entity_type_manager;
        $this->bundleInfo = $bundle_info;
        $this->moderationInformation = $moderation_information;
        $this->messenger = $messenger;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'workflow_type_edit_form';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?WorkflowInterface $workflow = NULL, $entity_type_id = NULL) {
        $this->workflow = $workflow;
        try {
            $this->entityType = $this->entityTypeManager
                ->getDefinition($entity_type_id);
        } catch (PluginNotFoundException $e) {
            throw new NotFoundHttpException();
        }
        $options = $defaults = [];
        foreach ($this->bundleInfo
            ->getBundleInfo($this->entityType
            ->id()) as $bundle_id => $bundle) {
            // Check if moderation is enabled for this bundle on any workflow.
            $moderation_enabled = $this->moderationInformation
                ->shouldModerateEntitiesOfBundle($this->entityType, $bundle_id);
            // Check if moderation is enabled for this bundle on this workflow.
            $workflow_moderation_enabled = $this->workflow
                ->getTypePlugin()
                ->appliesToEntityTypeAndBundle($this->entityType
                ->id(), $bundle_id);
            // Only show bundles that are not enabled anywhere, or enabled on this
            // workflow.
            if (!$moderation_enabled || $workflow_moderation_enabled) {
                // Add the bundle to the options if it's not enabled on a workflow,
                // unless the workflow it's enabled on is this one.
                $options[$bundle_id] = [
                    'title' => [
                        'data' => [
                            '#title' => $bundle['label'],
                        ],
                    ],
                    'type' => $bundle['label'],
                ];
                // Add the bundle to the list of default values if it's enabled on this
                // workflow.
                $defaults[$bundle_id] = $workflow_moderation_enabled;
            }
        }
        if (!empty($options)) {
            $bundles_header = $this->t('All @entity_type types', [
                '@entity_type' => $this->entityType
                    ->getLabel(),
            ]);
            if ($bundle_entity_type_id = $this->entityType
                ->getBundleEntityType()) {
                $bundles_header = $this->t('All @entity_type_plural_label', [
                    '@entity_type_plural_label' => $this->entityTypeManager
                        ->getDefinition($bundle_entity_type_id)
                        ->getPluralLabel(),
                ]);
            }
            $form['bundles'] = [
                '#type' => 'tableselect',
                '#header' => [
                    'type' => $bundles_header,
                ],
                '#options' => $options,
                '#default_value' => $defaults,
                '#attributes' => [
                    'class' => [
                        'no-highlight',
                    ],
                ],
            ];
        }
        // Get unsupported features for this entity type.
        $warnings = $this->moderationInformation
            ->getUnsupportedFeatures($this->entityType);
        // Display message into the Ajax form returned.
        if ($this->getRequest()
            ->get(MainContentViewSubscriber::WRAPPER_FORMAT) == 'drupal_modal' && !empty($warnings)) {
            $form['warnings'] = [
                '#type' => 'status_messages',
                '#weight' => -1,
            ];
        }
        // Set warning message.
        foreach ($warnings as $warning) {
            $this->messenger
                ->addWarning($warning);
        }
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#button_type' => 'primary',
            '#value' => $this->t('Save'),
            '#ajax' => [
                'callback' => [
                    $this,
                    'ajaxCallback',
                ],
            ],
        ];
        $form['actions']['cancel'] = [
            '#type' => 'button',
            '#value' => $this->t('Cancel'),
            '#ajax' => [
                'callback' => [
                    $this,
                    'ajaxCallback',
                ],
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        foreach ($form_state->getValue('bundles') as $bundle_id => $checked) {
            if ($checked) {
                $this->workflow
                    ->getTypePlugin()
                    ->addEntityTypeAndBundle($this->entityType
                    ->id(), $bundle_id);
            }
            else {
                $this->workflow
                    ->getTypePlugin()
                    ->removeEntityTypeAndBundle($this->entityType
                    ->id(), $bundle_id);
            }
        }
        $this->workflow
            ->save();
    }
    
    /**
     * Ajax callback to close the modal and update the selected text.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An ajax response object.
     */
    public function ajaxCallback() {
        $selected_bundles = [];
        foreach ($this->bundleInfo
            ->getBundleInfo($this->entityType
            ->id()) as $bundle_id => $bundle) {
            if ($this->workflow
                ->getTypePlugin()
                ->appliesToEntityTypeAndBundle($this->entityType
                ->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'),
        ];
        $response = new AjaxResponse();
        $response->addCommand(new CloseDialogCommand());
        $response->addCommand(new HtmlCommand('#selected-' . $this->entityType
            ->id(), $selected_bundles_list));
        return $response;
    }
    
    /**
     * Route title callback.
     */
    public function getTitle(WorkflowInterface $workflow, $entity_type_id) {
        $this->entityType = $this->entityTypeManager
            ->getDefinition($entity_type_id);
        $title = $this->t('Select the @entity_type types for the @workflow workflow', [
            '@entity_type' => $this->entityType
                ->getLabel(),
            '@workflow' => $workflow->label(),
        ]);
        if ($bundle_entity_type_id = $this->entityType
            ->getBundleEntityType()) {
            $title = $this->t('Select the @entity_type_plural_label for the @workflow workflow', [
                '@entity_type_plural_label' => $this->entityTypeManager
                    ->getDefinition($bundle_entity_type_id)
                    ->getPluralLabel(),
                '@workflow' => $workflow->label(),
            ]);
        }
        return $title;
    }

}