You are here

Home » API reference » Workbench Moderation 8 » BundleModerationConfigurationForm.php

class BundleModerationConfigurationForm in Workbench Moderation 8

Same name and namespace in other branches
  1. 8.2 src/Form/BundleModerationConfigurationForm.php \Drupal\workbench_moderation\Form\BundleModerationConfigurationForm

Form for configuring moderation usage on a given entity bundle.

Hierarchy

Expanded class hierarchy of BundleModerationConfigurationForm

1 file declares its use of BundleModerationConfigurationForm
EntityTypeInfo.php in src/EntityTypeInfo.php

File

src/Form/BundleModerationConfigurationForm.php, line 16

Namespace

Drupal\workbench_moderation\Form
View source 
class BundleModerationConfigurationForm extends EntityForm {

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

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   *
   * We need to blank out the base form ID so that poorly written form alters
   * that use the base form ID to target both add and edit forms don't pick
   * up our form. This should be fixed in core.
   */
  public function getBaseFormId() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {

    /* @var ConfigEntityTypeInterface $bundle */
    $bundle = $form_state
      ->getFormObject()
      ->getEntity();
    $form['enable_moderation_state'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable moderation states.'),
      '#description' => $this
        ->t('Content of this type must transition through moderation states in order to be published.'),
      '#default_value' => $bundle
        ->getThirdPartySetting('workbench_moderation', 'enabled', FALSE),
    ];

    // Add a special message when moderation is being disabled.
    if ($bundle
      ->getThirdPartySetting('workbench_moderation', 'enabled', FALSE)) {
      $form['enable_moderation_state_note'] = [
        '#type' => 'item',
        '#description' => $this
          ->t('After disabling moderation, any existing forward drafts will be accessible via the "Revisions" tab.'),
        '#states' => [
          'visible' => [
            ':input[name=enable_moderation_state]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
    }
    $states = $this->entityTypeManager
      ->getStorage('moderation_state')
      ->loadMultiple();
    $label = function (ModerationState $state) {
      return $state
        ->label();
    };
    $options_published = array_map($label, array_filter($states, function (ModerationState $state) {
      return $state
        ->isPublishedState();
    }));
    $options_unpublished = array_map($label, array_filter($states, function (ModerationState $state) {
      return !$state
        ->isPublishedState();
    }));
    $form['allowed_moderation_states_unpublished'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Allowed moderation states (Unpublished)'),
      '#description' => $this
        ->t('The allowed unpublished moderation states this content-type can be assigned.'),
      '#default_value' => $bundle
        ->getThirdPartySetting('workbench_moderation', 'allowed_moderation_states', array_keys($options_unpublished)),
      '#options' => $options_unpublished,
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name=enable_moderation_state]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['allowed_moderation_states_published'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Allowed moderation states (Published)'),
      '#description' => $this
        ->t('The allowed published moderation states this content-type can be assigned.'),
      '#default_value' => $bundle
        ->getThirdPartySetting('workbench_moderation', 'allowed_moderation_states', array_keys($options_published)),
      '#options' => $options_published,
      '#required' => TRUE,
      '#states' => [
        'visible' => [
          ':input[name=enable_moderation_state]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // This is screwy, but the key of the array needs to be a user-facing string
    // so we have to fully render the translatable string to a real string, or
    // else PHP chokes on an object used as an array key.
    $options = [
      $this
        ->t('Unpublished')
        ->render() => $options_unpublished,
      $this
        ->t('Published')
        ->render() => $options_published,
    ];
    $form['default_moderation_state'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default moderation state'),
      '#options' => $options,
      '#description' => $this
        ->t('Select the moderation state for new content'),
      '#default_value' => $bundle
        ->getThirdPartySetting('workbench_moderation', 'default_moderation_state', 'draft'),
      '#states' => [
        'visible' => [
          ':input[name=enable_moderation_state]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['#entity_builders'][] = [
      $this,
      'formBuilderCallback',
    ];
    return parent::form($form, $form_state);
  }

  /**
   * Form builder callback.
   *
   * @todo I don't know why this needs to be separate from the form() method.
   * It was in the form_alter version but we should see if we can just fold
   * it into the method above.
   *
   * @param string $entity_type
   *   Entity type.
   * @param \Drupal\Core\Config\Entity\ConfigEntityInterface $bundle
   *   Entity bundle.
   * @param array $form
   *   Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public function formBuilderCallback($entity_type, ConfigEntityInterface $bundle, array &$form, FormStateInterface $form_state) {

    // @todo write a test for this.
    $bundle
      ->setThirdPartySetting('workbench_moderation', 'enabled', $form_state
      ->getValue('enable_moderation_state'));
    $bundle
      ->setThirdPartySetting('workbench_moderation', 'allowed_moderation_states', array_keys(array_filter($form_state
      ->getValue('allowed_moderation_states_published') + $form_state
      ->getValue('allowed_moderation_states_unpublished'))));
    $bundle
      ->setThirdPartySetting('workbench_moderation', 'default_moderation_state', $form_state
      ->getValue('default_moderation_state'));
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('enable_moderation_state')) {
      $allowed = array_keys(array_filter($form_state
        ->getValue('allowed_moderation_states_published') + $form_state
        ->getValue('allowed_moderation_states_unpublished')));
      if (($default = $form_state
        ->getValue('default_moderation_state')) && !in_array($default, $allowed, TRUE)) {
        $form_state
          ->setErrorByName('default_moderation_state', $this
          ->t('The default moderation state must be one of the allowed states.'));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // If moderation is enabled, revisions MUST be enabled as well.
    // Otherwise we can't have forward revisions.
    if ($form_state
      ->getValue('enable_moderation_state')) {

      /* @var $bundle ConfigEntityTypeInterface */
      $bundle = $form_state
        ->getFormObject()
        ->getEntity();
      $this->entityTypeManager
        ->getHandler($bundle
        ->getEntityType()
        ->getBundleOf(), 'moderation')
        ->onBundleModerationConfigurationFormSubmit($bundle);
    }
    parent::submitForm($form, $form_state);
    $this
      ->messenger()
      ->addMessage($this
      ->t('Your settings have been saved.'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BundleModerationConfigurationForm::$entityTypeManager protected property An entity type manager. Overrides EntityForm::$entityTypeManager
BundleModerationConfigurationForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
BundleModerationConfigurationForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
BundleModerationConfigurationForm::formBuilderCallback public function Form builder callback.
BundleModerationConfigurationForm::getBaseFormId public function We need to blank out the base form ID so that poorly written form alters that use the base form ID to target both add and edit forms don't pick up our form. This should be fixed in core. Overrides EntityForm::getBaseFormId
BundleModerationConfigurationForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
BundleModerationConfigurationForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
BundleModerationConfigurationForm::__construct public function
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
EntityForm::$entity protected property The entity being used by this form. 7
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$privateEntityManager private property The entity manager.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 29
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 10
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties 7
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 10
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::save public function Form submission handler for the 'save' action. Overrides EntityFormInterface::save 41
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get public function
EntityForm::__set public function
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.