You are here

Home » API reference » Message 8 » MessageTemplateForm.php

class MessageTemplateForm in Message 8

Form controller for node type forms.

Hierarchy

Expanded class hierarchy of MessageTemplateForm

File

src/Form/MessageTemplateForm.php, line 17

Namespace

Drupal\message\Form
View source 
class MessageTemplateForm extends EntityForm {

  /**
   * The entity being used by this form.
   *
   * @var \Drupal\message\Entity\MessageTemplate
   */
  protected $entity;

  /**
   * The purge plugin manager.
   *
   * @var \Drupal\message\MessagePurgePluginManager
   */
  protected $purgeManager;

  /**
   * Constructs the message template form.
   *
   * @param \Drupal\message\MessagePurgePluginManager $purge_manager
   *   The message purge plugin manager service.
   */
  public function __construct(MessagePurgePluginManager $purge_manager) {
    $this->purgeManager = $purge_manager;
  }

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

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

    /** @var \Drupal\message\Entity\MessageTemplate $template */
    $template = $this->entity;
    $form['label'] = [
      '#title' => $this
        ->t('Label'),
      '#type' => 'textfield',
      '#default_value' => $template
        ->label(),
      '#description' => $this
        ->t('The human-readable name of this message template. This text will be displayed as part of the list on the <em>Add message</em> page. It is recommended that this name begin with a capital letter and contain only letters, numbers, and spaces. This name must be unique.'),
      '#required' => TRUE,
      '#size' => 30,
    ];
    $form['template'] = [
      '#type' => 'machine_name',
      '#default_value' => $template
        ->id(),
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#disabled' => $template
        ->isLocked(),
      '#machine_name' => [
        'exists' => '\\Drupal\\message\\Entity\\MessageTemplate::load',
        'source' => [
          'label',
        ],
      ],
      '#description' => $this
        ->t('A unique machine-readable name for this message template. It must only contain lowercase letters, numbers, and underscores. This name will be used for constructing the URL of the %message-add page, in which underscores will be converted into hyphens.', [
        '%message-add' => $this
          ->t('Add message'),
      ]),
    ];
    $form['description'] = [
      '#title' => $this
        ->t('Description'),
      '#type' => 'textfield',
      '#default_value' => $this->entity
        ->getDescription(),
      '#description' => $this
        ->t('The human-readable description of this message template.'),
    ];
    $multiple = new MessageTemplateMultipleTextField($this->entity, [
      get_class($this),
      'addMoreAjax',
    ]);
    $multiple
      ->textField($form, $form_state);
    $settings = $this->entity
      ->getSettings();
    $form['settings'] = [
      // Placeholder for other module to add their settings, that should be
      // added to the settings column.
      '#tree' => TRUE,
    ];
    $form['settings']['token options']['clear'] = [
      '#title' => $this
        ->t('Clear empty tokens'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('When this option is selected, empty tokens will be removed from display.'),
      '#default_value' => isset($settings['token options']['clear']) ? $settings['token options']['clear'] : FALSE,
    ];
    $form['settings']['token options']['token replace'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Token replace'),
      '#description' => $this
        ->t('When this option is selected, token processing will happen.'),
      '#default_value' => !isset($settings['token options']['token replace']) || !empty($settings['token options']['token replace']),
    ];
    $form['settings']['purge_override'] = [
      '#title' => $this
        ->t('Override global purge settings'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('Override <a href=":settings">global purge settings</a> for messages using this template.', [
        ':settings' => Url::fromRoute('message.settings')
          ->toString(),
      ]),
      '#default_value' => $this->entity
        ->getSetting('purge_override'),
    ];

    // Add the purge method settings form.
    $settings = $this->entity
      ->getSetting('purge_methods', []);
    $this->purgeManager
      ->purgeSettingsForm($form, $form_state, $settings);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = t('Save message template');
    $actions['delete']['#value'] = t('Delete message template');
    return $actions;
  }

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

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

    // Save only the enabled purge methods if overriding the global settings.
    $override = $form_state
      ->getValue([
      'settings',
      'purge_override',
    ]);
    $settings = $this->entity
      ->getSettings();
    $settings['purge_methods'] = $override ? $this->purgeManager
      ->getPurgeConfiguration($form, $form_state) : [];
    $this->entity
      ->setSettings($settings);
  }

  /**
   * Ajax callback for the "Add another item" button.
   *
   * This returns the new page content to replace the page content made obsolete
   * by the form submission.
   */
  public static function addMoreAjax(array $form, FormStateInterface $form_state) {
    return $form['text'];
  }

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

    // Sort by weight.
    $text = $form_state
      ->getValue('text');
    usort($text, function ($a, $b) {
      return SortArray::sortByKeyInt($a, $b, '_weight');
    });

    // Do not store weight, as these are now sorted.
    $text = array_map(function ($a) {
      unset($a['_weight']);
      return $a;
    }, $text);
    $this->entity
      ->set('text', $text);
    parent::save($form, $form_state);
    $params = [
      '@template' => $form_state
        ->getValue('label'),
    ];
    $this
      ->messenger()
      ->addMessage($this
      ->t('The message template @template created successfully.', $params));
    $form_state
      ->setRedirect('message.overview_templates');
    return $this->entity;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$entityTypeManager protected property The entity type manager. 3
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::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::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 5
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
MessageTemplateForm::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
MessageTemplateForm::$purgeManager protected property The purge plugin manager.
MessageTemplateForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
MessageTemplateForm::addMoreAjax public static function Ajax callback for the "Add another item" button.
MessageTemplateForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MessageTemplateForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
MessageTemplateForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
MessageTemplateForm::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
MessageTemplateForm::validate public function
MessageTemplateForm::__construct public function Constructs the message template form.
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.