Commit 7111b569 authored by Adam Shepherd's avatar Adam Shepherd
Browse files

Issue #3273080 by AdamPS: Add EmailBuilder annotation for common adjusters

parent bef6cce3

modules/symfony_mailer_bc/src/Plugin/EmailBuilder/SimplenewsEmailBuilder.php

+1 −0
Changes for modules/symfony_mailer_bc/src/Plugin/EmailBuilder/SimplenewsEmailBuilder.php: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ use Drupal\symfony_mailer\Processor\TokenProcessorTrait; 
 *     "subscribe" = @Translation("Subscription confirmation"),

 *     "validate" = @Translation("Validate"),

 *   },

 *   common_adjusters = {"email_subject", "email_body"},

 *   migrate = @Translation("Simplenews subscriber settings"),

 *   migrate_warning = @Translation("This overrides the default HTML messages with imported plain text versions."),

 * )

modules/symfony_mailer_bc/src/Plugin/EmailBuilder/SimplenewsNewsletterEmailBuilder.php

+1 −0
Changes for modules/symfony_mailer_bc/src/Plugin/EmailBuilder/SimplenewsNewsletterEmailBuilder.php: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ use Symfony\Component\Mime\Address; 
 *     "node" = @Translation("Issue"),

 *   },

 *   has_entity = TRUE,

 *   common_adjusters = {"email_subject", "email_from"},

 *   migrate = @Translation("Simplenews newsletter settings"),

 * )

 *

src/Annotation/EmailBuilder.php

+7 −0
Changes for src/Annotation/EmailBuilder.php: 7 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -35,4 +35,11 @@ class EmailBuilder extends Plugin { 
   */

  public $has_entity = FALSE;



  /**

   * Array of common adjuster IDs.

   *

   * @var string[]

   */

  public $common_adjusters = [];



}

src/MailerHelper.php

+21 −16
Changes for src/MailerHelper.php: 21 added lines, 16 removed lines.
Original line number Diff line number Diff line
@@ -2,7 +2,6 @@ 


namespace Drupal\symfony_mailer;



use Drupal\Core\Plugin\DefaultPluginManager;

use Drupal\Core\Cache\CacheBackendInterface;

use Drupal\Core\Config\ConfigFactoryInterface;

use Drupal\Core\Config\Entity\ConfigEntityInterface;
@@ -10,6 +9,8 @@ use Drupal\Core\Entity\EntityFormInterface; 
use Drupal\Core\Entity\EntityTypeManagerInterface;

use Drupal\Core\Extension\ModuleHandlerInterface;

use Drupal\Core\Form\FormStateInterface;

use Drupal\Core\Plugin\DefaultPluginManager;

use Drupal\Core\StringTranslation\StringTranslationTrait;

use Drupal\symfony_mailer\Processor\EmailAdjusterManager;

use Drupal\symfony_mailer\Processor\EmailBuilderManagerInterface;

use Symfony\Component\Mime\Address;
@@ -19,6 +20,8 @@ use Symfony\Component\Mime\Address; 
 */

class MailerHelper implements MailerHelperInterface {



  use StringTranslationTrait;



  /**

   * The entity type manager.

   *
@@ -123,9 +126,9 @@ class MailerHelper implements MailerHelperInterface { 
  /**

   * {@inheritdoc}

   */

  public function renderEntityPolicy(ConfigEntityInterface $entity, string $subtype, array $common_adjusters = ['email_subject', 'email_from']) {

  public function renderEntityPolicy(ConfigEntityInterface $entity, string $subtype) {

    $type = $entity->getEntityTypeId();

    $element = $this->renderCommon($type, $common_adjusters);

    $element = $this->renderCommon($type);

    $policy_id = "$type.$subtype";

    $entities = [$policy_id, $policy_id . '.' . $entity->id()];

    $element['listing'] = $this->entityTypeManager->getListBuilder('mailer_policy')
@@ -139,8 +142,8 @@ class MailerHelper implements MailerHelperInterface { 
  /**

   * {@inheritdoc}

   */

  public function renderTypePolicy(string $type, array $common_adjusters = ['email_subject', 'email_from']) {

    $element = $this->renderCommon($type, $common_adjusters);

  public function renderTypePolicy(string $type) {

    $element = $this->renderCommon($type);

    $entities = [$type];

    foreach (array_keys($this->builderManager->getDefinition($type)['sub_types']) as $subtype) {

      $entities[] = "$type.$subtype";
@@ -159,31 +162,33 @@ class MailerHelper implements MailerHelperInterface { 
   *

   * @param string $type

   *   Type of the policies to show.

   * @param string[] $common_adjusters

   *   ID of EmailAdjusters to use as an example in the description.

   *

   * @return array

   *   The render array.

   */

  protected function renderCommon(string $type, array $common_adjusters) {

  protected function renderCommon(string $type) {

    $element = [

      '#type' => 'fieldset',

      '#title' => t('Mailer policy'),

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

      '#collapsible' => FALSE,

      '#description' => t('If you have made changes on this page, please save them before editing policy.'),

      '#description' => $this->t('If you have made changes on this page, please save them before editing policy.'),

    ];



    foreach ($common_adjusters as $adjuster_id) {

      $adjuster_names[] = $this->adjusterManager->getDefinition($adjuster_id)['label'];

    }

    $label = $this->builderManager->getDefinition($type)['label'];



    $definition = $this->builderManager->getDefinition($type);

    $element['explanation'] = [

      '#prefix' => '<p>',

      '#markup' => t('Configure Mailer policy records to customise the emails sent for @label. You can set the @adjusters and more.', ['@label' => $label, '@adjusters' => implode(', ', $adjuster_names)]),

      '#markup' => $this->t('Configure Mailer policy records to customise the emails sent for @label.', ['@label' => $definition['label']]),

      '#suffix' => '</p>',

    ];



    foreach ($definition['common_adjusters'] as $adjuster_id) {

      $adjuster_names[] = $this->adjusterManager->getDefinition($adjuster_id)['label'];

    }



    if (!empty($adjuster_names)) {

      $element['explanation']['#markup'] .= ' ' . $this->t('You can set the @adjusters and more.', ['@adjusters' => implode(', ', $adjuster_names)]);

    }



    return $element;

  }

src/MailerHelperInterface.php

+2 −6
Changes for src/MailerHelperInterface.php: 2 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -68,13 +68,11 @@ interface MailerHelperInterface { 
   *   Config entity being edited.

   * @param string $subtype

   *   Sub-type of the policies to show.

   * @param string[] $common_adjusters

   *   ID of EmailAdjusters to use as an example in the description.

   *

   * @return array

   *   The render array.

   */

  public function renderEntityPolicy(ConfigEntityInterface $entity, string $subtype, array $common_adjusters = ['email_subject', 'email_from']);

  public function renderEntityPolicy(ConfigEntityInterface $entity, string $subtype);



  /**

   * Renders an element that lists policy for a specific type.
@@ -83,12 +81,10 @@ interface MailerHelperInterface { 
   *

   * @param string $type

   *   Type of the policies to show.

   * @param string[] $common_adjusters

   *   ID of EmailAdjusters to use as an example in the description.

   *

   * @return array

   *   The render array.

   */

  public function renderTypePolicy(string $type, array $common_adjusters = ['email_subject', 'email_from']);

  public function renderTypePolicy(string $type);



}