class TemplateEditForm in Courier 8

Same name and namespace in other branches

2.x src/Form/TemplateEditForm.php \Drupal\courier\Form\TemplateEditForm

Create a message.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\courier\Form\TemplateEditForm

Expanded class hierarchy of TemplateEditForm

1 file declares its use of TemplateEditForm

ChannelFormController.php in src/Controller/ChannelFormController.php

File

src/Form/TemplateEditForm.php, line 19

Namespace

Drupal\courier\Form

View source

class TemplateEditForm extends FormBase {

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

  /**
   * The identity channel manager.
   *
   * @var \Drupal\courier\Service\IdentityChannelManagerInterface
   */
  protected $identityChannelManager;

  /**
   * The courier manager.
   *
   * @var \Drupal\courier\Service\CourierManagerInterface
   */
  protected $courierManager;

  /**
   * Constructs a MessageForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\courier\Service\IdentityChannelManagerInterface $identity_channel_manager
   *   The identity channel manager.
   * @param \Drupal\courier\Service\CourierManagerInterface $courier_manager
   *   The courier manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, IdentityChannelManagerInterface $identity_channel_manager, CourierManagerInterface $courier_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->identityChannelManager = $identity_channel_manager;
    $this->courierManager = $courier_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'courier_template_edit';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, TemplateCollectionInterface $template_collection = NULL, ContentEntityTypeInterface $courier_channel = NULL) {
    if (!isset($template_collection) || !isset($courier_channel)) {
      throw new \Exception('Missing template collection or courier channel.');
    }
    if (!($message = $template_collection
      ->getTemplate($courier_channel
      ->id()))) {

      // Create it if it does not exist.

      /** @var \Drupal\courier\ChannelInterface $message */
      $message = $this->entityTypeManager
        ->getStorage($courier_channel
        ->id())
        ->create();

      // Saving the template collection will auto save the message entity.
      $template_collection
        ->setTemplate($message)
        ->save();
    }
    $form_state
      ->set('message_entity', $message);
    $form_state
      ->set('template_collection', $template_collection);
    $t_args = [
      '@channel' => $message
        ->getEntityType()
        ->getLabel(),
    ];

    // Entity form display.
    $display = entity_get_form_display($message
      ->getEntityTypeId(), $message
      ->getEntityTypeId(), 'default');
    $form_state
      ->set([
      'form_display',
    ], $display);
    $form['message'] = [
      '#tree' => TRUE,
    ];
    $display
      ->buildForm($message, $form['message'], $form_state);
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#attributes' => [
        'class' => [
          'use-ajax-submit',
        ],
      ],
      '#type' => 'submit',
      '#value' => t('Save @channel', $t_args),
      '#button_type' => 'primary',
    ];
    $form['actions']['close'] = [
      '#attributes' => [
        'class' => [
          'use-ajax-submit',
        ],
      ],
      '#type' => 'submit',
      '#value' => t('Cancel'),
      '#submit' => [
        '::cancelForm',
      ],
    ];
    return $form;
  }

  /**
   * Cancels the form.
   *    * @param array $form
   *   An associative array containing the structure of the form.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function cancelForm(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\courier\ChannelInterface $message */
    $message = $form_state
      ->get('message_entity');

    /** @var TemplateCollectionInterface $template_collection */
    $template_collection = $form_state
      ->get('template_collection');
    $response = new AjaxResponse();
    $response
      ->addCommand(new CourierTemplate($template_collection
      ->id(), $message
      ->getEntityTypeId(), 'close'));
    $form_state
      ->setResponse($response);
  }

  /**
   * @inheritDoc
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\courier\ChannelInterface $message */
    $message = $form_state
      ->get('message_entity');
    $form_state
      ->get([
      'form_display',
    ])
      ->validateFormValues($message, $form, $form_state);
  }

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

    /** @var \Drupal\courier\ChannelInterface $message */
    $message = $form_state
      ->get('message_entity');

    /** @var TemplateCollectionInterface $template_collection */
    $template_collection = $form_state
      ->get('template_collection');
    $form_state
      ->get([
      'form_display',
    ])
      ->extractFormValues($message, $form, $form_state);
    $message
      ->save();
    $response = new AjaxResponse();
    $response
      ->addCommand(new CourierTemplate($template_collection
      ->id(), $message
      ->getEntityTypeId(), 'close'));
    $form_state
      ->setResponse($response);
  }

}

Members

Name	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
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.
TemplateEditForm::$courierManager	protected	property	The courier manager.
TemplateEditForm::$entityTypeManager	protected	property	The entity type manager.
TemplateEditForm::$identityChannelManager	protected	property	The identity channel manager.
TemplateEditForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
TemplateEditForm::cancelForm	public	function	Cancels the form.
TemplateEditForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
TemplateEditForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TemplateEditForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
TemplateEditForm::validateForm	public	function	@inheritDoc Overrides FormBase::validateForm
TemplateEditForm::__construct	public	function	Constructs a MessageForm object.
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.

You are here

class TemplateEditForm in Courier 8

Hierarchy

File

Namespace

Members

API Navigation