Commit 47361c90 authored by Tyler Marshall's avatar Tyler Marshall Committed by Ryan Szrama
Browse files

Issue #3144974 by TylerMarshall, rszrama, daggerhart, loze: Add a "Test email"... 

Issue #3144974 by TylerMarshall, rszrama, daggerhart, loze: Add a "Test email" task to email configurations that prompts the user to supply the necessary entity context
parent c1a6d065

commerce_email.links.task.yml

0 → 100644
+6 −0
Original line number Diff line number Diff line 
entity.commerce_email.test_form:

  title: 'Test email'

  route_name: entity.commerce_email.test_form

  base_route: 'entity.commerce_email.edit_form'

  description: 'Test sending this email.'

  weight: 50

commerce_email.routing.yml

0 → 100644
+11 −0
Original line number Diff line number Diff line 
entity.commerce_email.test_form:

  path: '/admin/commerce/config/emails/{commerce_email}/test'

  defaults:

    _form: '\Drupal\commerce_email\Form\TestEmailForm'

    _title: 'Test email'

  options:

    parameters:

      commerce_email:

        type: entity:commerce_email

  requirements:

    _permission: 'administer commerce_email'

src/EmailListBuilder.php

+34 −0
Original line number Diff line number Diff line
@@ -4,6 +4,7 @@ namespace Drupal\commerce_email; 


use Drupal\Core\Config\Entity\ConfigEntityListBuilder;

use Drupal\Core\Entity\EntityInterface;

use Drupal\Core\Url;



/**

 * Defines the list builder for emails.
@@ -33,4 +34,37 @@ class EmailListBuilder extends ConfigEntityListBuilder { 
    return $row + parent::buildRow($entity);

  }



  /**

   * {@inheritdoc}

   */

  public function getDefaultOperations(EntityInterface $entity) {

    /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */

    $operations = parent::getDefaultOperations($entity);



    if ($this->entityType->hasKey('status')) {

      if (!$entity->status() && $entity->hasLinkTemplate('enable')) {

        $operations['enable'] = [

          'title' => t('Enable'),

          'weight' => -10,

          'url' => $this->ensureDestination($entity->toUrl('enable')),

        ];

      }

      elseif ($entity->hasLinkTemplate('disable')) {

        $operations['disable'] = [

          'title' => t('Disable'),

          'weight' => 40,

          'url' => $this->ensureDestination($entity->toUrl('disable')),

        ];

      }

    }



    $operations['test'] = [

      'title' => t('Test email'),

      'weight' => 50,

      'url' => $this->ensureDestination(Url::fromRoute('entity.commerce_email.test_form', ['commerce_email' => $entity->id()])),

    ];



    return $operations;

  }



}

src/Form/TestEmailForm.php

0 → 100644
+173 −0
Original line number Diff line number Diff line 
<?php



namespace Drupal\commerce_email\Form;



use Drupal\commerce_email\EmailSenderInterface;

use Drupal\commerce_email\Entity\EmailInterface;

use Drupal\Core\Entity\EntityTypeManagerInterface;

use Drupal\Core\Form\FormBase;

use Drupal\Core\Form\FormStateInterface;

use Symfony\Component\DependencyInjection\ContainerInterface;



/**

 * Tests emails.

 */

class TestEmailForm extends FormBase {



  /**

   * The email sender.

   *

   * @var \Drupal\commerce_email\EmailSenderInterface

   */

  protected $emailSender;



  /**

   * Entity type manager.

   *

   * @var \Drupal\Core\Entity\EntityTypeManagerInterface

   */

  protected $entityTypeManager;



  /**

   * {@inheritdoc}

   */

  public static function create(ContainerInterface $container) {

    return new static(

      $container->get('commerce_email.email_sender'),

      $container->get('entity_type.manager')

    );

  }



  /**

   * {@inheritdoc}

   */

  public function __construct(EmailSenderInterface $email_sender, EntityTypeManagerInterface $entity_type_manager) {

    $this->emailSender = $email_sender;

    $this->entityTypeManager = $entity_type_manager;

  }



  /**

   * {@inheritdoc}

   */

  public function getFormId() {

    return 'commerce_email_test_form';

  }



  /**

   * {@inheritdoc}

   */

  public function buildForm(array $form, FormStateInterface $form_state, EmailInterface $commerce_email = NULL) {

    // Exit if for some reason a valid email entity is not passed in.

    if (empty($commerce_email)) {

      return [

        '#type' => 'markup',

        '#markup' => $this->t('Email not found.'),

      ];

    }



    $form_state->set('commerce_email', $commerce_email);



    // Get the target entity type ID and definition.

    $target_entity_type_id = $commerce_email->getTargetEntityTypeId();

    $target_entity_type = $this->entityTypeManager->getDefinition($target_entity_type_id);



    // Prompt the user to supply the variables derived from the event context.

    $form['context'] = [

      '#type' => 'fieldset',

      '#title' => $this->t('Test context'),

    ];

    $form['context']['target_entity'] = [

      '#type' => 'entity_autocomplete',

      '#target_type' => $target_entity_type_id,

      '#title' => $target_entity_type->getLabel(),

      '#description' => $this->t('Reference the entity to use for token replacement in this email.'),

    ];



    // Allow the user to override the default settings of this email.

    $form['from'] = [

      '#type' => 'textfield',

      '#title' => $this->t('From'),

      '#maxlength' => 255,

      '#default_value' => $commerce_email->getFrom(),

      '#required' => TRUE,

      '#element_validate' => ['token_element_validate'],

      '#token_types' => [$target_entity_type_id],

    ];

    $form['to'] = [

      '#type' => 'textfield',

      '#title' => $this->t('To'),

      '#maxlength' => 255,

      '#default_value' => $commerce_email->getTo(),

      '#required' => TRUE,

      '#element_validate' => ['token_element_validate'],

      '#token_types' => [$target_entity_type_id],

    ];

    $form['cc'] = [

      '#type' => 'textfield',

      '#title' => $this->t('Cc'),

      '#maxlength' => 255,

      '#default_value' => $commerce_email->getCc(),

      '#element_validate' => ['token_element_validate'],

      '#token_types' => [$target_entity_type_id],

    ];

    $form['bcc'] = [

      '#type' => 'textfield',

      '#title' => $this->t('Bcc'),

      '#maxlength' => 255,

      '#default_value' => $commerce_email->getBcc(),

      '#element_validate' => ['token_element_validate'],

      '#token_types' => [$target_entity_type_id],

    ];

    $form['subject'] = [

      '#type' => 'textfield',

      '#title' => $this->t('Subject'),

      '#maxlength' => 255,

      '#default_value' => '[TEST] ' . $commerce_email->getSubject(),

      '#required' => TRUE,

      '#element_validate' => ['token_element_validate'],

      '#token_types' => [$target_entity_type_id],

    ];

    $form['body'] = [

      '#type' => 'textarea',

      '#title' => $this->t('Body'),

      '#default_value' => $commerce_email->getBody(),

      '#rows' => 10,

      '#required' => TRUE,

      '#element_validate' => ['token_element_validate'],

      '#token_types' => [$target_entity_type_id],

    ];



    $form['actions']['submit'] = [

      '#type' => 'submit',

      '#value' => 'Test email',

      '#button_type' => 'primary',

    ];



    return $form;

  }



  /**

   * {@inheritdoc}

   */

  public function submitForm(array &$form, FormStateInterface $form_state) {

    $values = $form_state->getUserInput();



    /** @var \Drupal\commerce_email\Entity\EmailInterface $email */

    $commerce_email = $form_state->get('commerce_email');



    // Override the email configuration with form input.

    $commerce_email->setFrom($values['from']);

    $commerce_email->setTo($values['to']);

    $commerce_email->setCc($values['cc']);

    $commerce_email->setBcc($values['bcc']);

    $commerce_email->setSubject($values['subject']);

    $commerce_email->setBody($values['body']);



    // Send the email using the referenced entity.

    $entity = $this->entityTypeManager->getStorage($commerce_email->getTargetEntityTypeId())->load($form_state->getValue('target_entity'));

    $this->emailSender->send($commerce_email, $entity);



    $this->messenger()->addMessage($this->t('Test email sent.'));

  }



}