class CommentTypeForm

Same name in other branches
  1. 8.9.x core/modules/comment/src/CommentTypeForm.php \Drupal\comment\CommentTypeForm
  2. 10 core/modules/comment/src/CommentTypeForm.php \Drupal\comment\CommentTypeForm
  3. 11.x core/modules/comment/src/CommentTypeForm.php \Drupal\comment\CommentTypeForm

Base form handler for comment type edit forms.

@internal

Hierarchy

Expanded class hierarchy of CommentTypeForm

File

core/modules/comment/src/CommentTypeForm.php, line 19

Namespace

Drupal\comment
View source
class CommentTypeForm extends EntityForm {
    
    /**
     * Entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * A logger instance.
     *
     * @var \Psr\Log\LoggerInterface
     */
    protected $logger;
    
    /**
     * The comment manager.
     *
     * @var \Drupal\comment\CommentManagerInterface
     */
    protected $commentManager;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager'), $container->get('logger.factory')
            ->get('comment'), $container->get('comment.manager'));
    }
    
    /**
     * Constructs a CommentTypeFormController.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager service.
     * @param \Psr\Log\LoggerInterface $logger
     *   A logger instance.
     * @param \Drupal\comment\CommentManagerInterface $comment_manager
     *   The comment manager.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, LoggerInterface $logger, CommentManagerInterface $comment_manager) {
        $this->entityTypeManager = $entity_type_manager;
        $this->logger = $logger;
        $this->commentManager = $comment_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $form = parent::form($form, $form_state);
        $comment_type = $this->entity;
        $form['label'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Label'),
            '#maxlength' => 255,
            '#default_value' => $comment_type->label(),
            '#required' => TRUE,
        ];
        $form['id'] = [
            '#type' => 'machine_name',
            '#default_value' => $comment_type->id(),
            '#machine_name' => [
                'exists' => '\\Drupal\\comment\\Entity\\CommentType::load',
            ],
            '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
            '#disabled' => !$comment_type->isNew(),
        ];
        $form['description'] = [
            '#type' => 'textarea',
            '#default_value' => $comment_type->getDescription(),
            '#description' => $this->t('Describe this comment type. The text will be displayed on the <em>Comment types</em> administration overview page.'),
            '#title' => $this->t('Description'),
        ];
        if ($comment_type->isNew()) {
            $options = [];
            // Only expose entities that have field UI enabled, only those can
            // get comment fields added in the UI. Also, ensure to include only
            // entities that have integer id.
            foreach ($this->entityTypeManager
                ->getDefinitions() as $entity_type) {
                if ($this->entityTypeSupportsComments($entity_type)) {
                    if ($entity_type->get('field_ui_base_route')) {
                        $options[$entity_type->id()] = $entity_type->getLabel();
                    }
                }
            }
            $form['target_entity_type_id'] = [
                '#type' => 'select',
                '#default_value' => $comment_type->getTargetEntityTypeId(),
                '#title' => $this->t('Target entity type'),
                '#options' => $options,
                '#description' => $this->t('The target entity type can not be changed after the comment type has been created.'),
            ];
        }
        else {
            $form['target_entity_type_id_display'] = [
                '#type' => 'item',
                '#markup' => $this->entityTypeManager
                    ->getDefinition($comment_type->getTargetEntityTypeId())
                    ->getLabel(),
                '#title' => $this->t('Target entity type'),
            ];
        }
        if ($this->moduleHandler
            ->moduleExists('content_translation')) {
            $form['language'] = [
                '#type' => 'details',
                '#title' => $this->t('Language settings'),
                '#group' => 'additional_settings',
            ];
            $language_configuration = ContentLanguageSettings::loadByEntityTypeBundle('comment', $comment_type->id());
            $form['language']['language_configuration'] = [
                '#type' => 'language_configuration',
                '#entity_information' => [
                    'entity_type' => 'comment',
                    'bundle' => $comment_type->id(),
                ],
                '#default_value' => $language_configuration,
            ];
            $form['#submit'][] = 'language_configuration_element_submit';
        }
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Save'),
        ];
        return $form;
    }
    
    /**
     * Wraps _comment_entity_uses_integer_id().
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   Entity type being tested.
     *
     * @return bool
     *   TRUE if entity-type uses integer IDs.
     */
    protected function entityTypeSupportsComments(EntityTypeInterface $entity_type) {
        return $entity_type->entityClassImplements(FieldableEntityInterface::class) && _comment_entity_uses_integer_id($entity_type->id());
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $comment_type = $this->entity;
        $status = $comment_type->save();
        $edit_link = $this->entity
            ->toLink($this->t('Edit'), 'edit-form')
            ->toString();
        if ($status == SAVED_UPDATED) {
            $this->messenger()
                ->addStatus($this->t('Comment type %label has been updated.', [
                '%label' => $comment_type->label(),
            ]));
            $this->logger
                ->notice('Comment type %label has been updated.', [
                '%label' => $comment_type->label(),
                'link' => $edit_link,
            ]);
        }
        else {
            $this->commentManager
                ->addBodyField($comment_type->id());
            $this->messenger()
                ->addStatus($this->t('Comment type %label has been added.', [
                '%label' => $comment_type->label(),
            ]));
            $this->logger
                ->notice('Comment type %label has been added.', [
                '%label' => $comment_type->label(),
                'link' => $edit_link,
            ]);
        }
        $form_state->setRedirectUrl($comment_type->toUrl('collection'));
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CommentTypeForm::$commentManager protected property The comment manager.
CommentTypeForm::$entityTypeManager protected property Entity type manager service. Overrides EntityForm::$entityTypeManager
CommentTypeForm::$logger protected property A logger instance.
CommentTypeForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
CommentTypeForm::entityTypeSupportsComments protected function Wraps _comment_entity_uses_integer_id().
CommentTypeForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
CommentTypeForm::save public function Form submission handler for the &#039;save&#039; action. Overrides EntityForm::save
CommentTypeForm::__construct public function Constructs a CommentTypeFormController.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 35
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 3
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 13
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
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 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
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::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
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::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 FormInterface::submitForm 20
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 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.

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