class ContentModerationStateForm

Same name in other branches
  1. 9 core/modules/content_moderation/src/Form/ContentModerationStateForm.php \Drupal\content_moderation\Form\ContentModerationStateForm
  2. 8.9.x core/modules/content_moderation/src/Form/ContentModerationStateForm.php \Drupal\content_moderation\Form\ContentModerationStateForm
  3. 11.x core/modules/content_moderation/src/Form/ContentModerationStateForm.php \Drupal\content_moderation\Form\ContentModerationStateForm

The content moderation state form.

Hierarchy

Expanded class hierarchy of ContentModerationStateForm

See also

\Drupal\content_moderation\Plugin\WorkflowType\ContentModeration

File

core/modules/content_moderation/src/Form/ContentModerationStateForm.php, line 14

Namespace

Drupal\content_moderation\Form
View source 
class ContentModerationStateForm extends WorkflowTypeStateFormBase {
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state, ?StateInterface $state = NULL) {
        
        /** @var \Drupal\content_moderation\ContentModerationState $state */
        $state = $form_state->get('state');
        $is_required_state = isset($state) ? in_array($state->id(), $this->workflowType
            ->getRequiredStates(), TRUE) : FALSE;
        $form = [];
        $form['published'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Published'),
            '#description' => $this->t('When content reaches this state it should be published.'),
            '#default_value' => isset($state) ? $state->isPublishedState() : FALSE,
            '#disabled' => $is_required_state,
        ];
        $form['default_revision'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Default revision'),
            '#description' => $this->t('When content reaches this state it should be made the default revision; this is implied for published states.'),
            '#default_value' => isset($state) ? $state->isDefaultRevisionState() : FALSE,
            '#disabled' => $is_required_state,
        ];
        return $form;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ContentModerationStateForm::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
WorkflowTypeStateFormBase::$workflowType protected property The workflow type.
WorkflowTypeStateFormBase::setPlugin public function Sets the plugin for this object. Overrides PluginAwareInterface::setPlugin
WorkflowTypeStateFormBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
WorkflowTypeStateFormBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm

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