Merge pull request civicrm#44 from totten/master-nfc

(NFC) Update to current code standard
artfulrobot · Jul 12, 2019 · 52bd266 · 52bd266
2 parents 7d65618 + 3630f8d
commit 52bd266
Show file tree

Hide file tree

Showing 17 changed files with 47 additions and 66 deletions.
diff --git a/src/API/MailingPreview.php b/src/API/MailingPreview.php
@@ -50,7 +50,7 @@ public static function preview($apiRequest) {
     $flexMailer = new FlexMailer(array(
       'is_preview' => TRUE,
       'mailing' => $mailing,
-      'job' => $job, // HMM?
+      'job' => $job,
       'attachments' => \CRM_Core_BAO_File::getEntityFile('civicrm_mailing',
         $mailing->id),
     ));
@@ -70,7 +70,8 @@ public static function preview($apiRequest) {
       'subject' => $task->getMailParam('Subject'),
       'body_html' => $task->getMailParam('html'),
       'body_text' => $task->getMailParam('text'),
-      '_rendered_by_' => 'flexmailer', // To support tests
+      // Flag our role in processing this - to support tests.
+      '_rendered_by_' => 'flexmailer',
     ));
   }
 

diff --git a/src/ClickTracker/ClickTrackerInterface.php b/src/ClickTracker/ClickTrackerInterface.php
@@ -27,6 +27,7 @@
 namespace Civi\FlexMailer\ClickTracker;
 
 interface ClickTrackerInterface {
+
   /**
    * @param string $msg
    * @param int $mailing_id

diff --git a/src/FlexMailer.php b/src/FlexMailer.php
@@ -25,16 +25,12 @@
  +--------------------------------------------------------------------+
  */
 namespace Civi\FlexMailer;
+
 use Civi\FlexMailer\Event\ComposeBatchEvent;
 use Civi\FlexMailer\Event\RunEvent;
 use Civi\FlexMailer\Event\SendBatchEvent;
 use Civi\FlexMailer\Event\WalkBatchesEvent;
-use Civi\FlexMailer\Listener\DefaultBatcher;
-use Civi\FlexMailer\Listener\DefaultComposer;
-use Civi\FlexMailer\Listener\DefaultSender;
-use Civi\FlexMailer\Listener\HookAdapter;
-use Civi\FlexMailer\Listener\OpenTracker;
-use \Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
  * Class FlexMailer
@@ -77,13 +73,6 @@
  * to do. If your listener does the work required for the event, then
  * you can disable the default listener by calling `$event->stopPropagation()`.
  *
- * @see CRM_Utils_Hook::container
- * @see Civi\Core\Container
- * @see DefaultBatcher
- * @see DefaultComposer
- * @see DefaultSender
- * @see HookAdapter
- * @see OpenTracker
  * @link http://symfony.com/doc/current/components/event_dispatcher.html
  */
 class FlexMailer {
@@ -125,7 +114,7 @@ public static function getEventTypes() {
   public $context;
 
   /**
-   * @var EventDispatcherInterface
+   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
    */
   private $dispatcher;
 
@@ -156,7 +145,7 @@ public static function createAndRun($job, $deprecatedMessageMailer, $deprecatedT
    *     - mailing: \CRM_Mailing_BAO_Mailing
    *     - job: \CRM_Mailing_BAO_MailingJob
    *     - attachments: array
-   * @param EventDispatcherInterface $dispatcher
+   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
    */
   public function __construct($context = array(), EventDispatcherInterface $dispatcher = NULL) {
     $this->context = $context;
@@ -169,7 +158,8 @@ public function __construct($context = array(), EventDispatcherInterface $dispat
    * @throws \CRM_Core_Exception
    */
   public function run() {
-    $flexMailer = $this; // PHP 5.3
+    // PHP 5.3
+    $flexMailer = $this;
 
     if (count($this->validate()) > 0) {
       throw new \CRM_Core_Exception("FlexMailer cannot execute: invalid context");
@@ -205,7 +195,7 @@ public function validate() {
   }
 
   /**
-   * @return RunEvent
+   * @return \Civi\FlexMailer\Event\RunEvent
    */
   public function fireRun() {
     $event = new RunEvent($this->context);
@@ -215,7 +205,7 @@ public function fireRun() {
 
   /**
    * @param callable $onVisitBatch
-   * @return WalkBatchesEvent
+   * @return \Civi\FlexMailer\Event\WalkBatchesEvent
    */
   public function fireWalkBatches($onVisitBatch) {
     $event = new WalkBatchesEvent($this->context, $onVisitBatch);
@@ -225,7 +215,7 @@ public function fireWalkBatches($onVisitBatch) {
 
   /**
    * @param array<FlexMailerTask> $tasks
-   * @return ComposeBatchEvent
+   * @return \Civi\FlexMailer\Event\ComposeBatchEvent
    */
   public function fireComposeBatch($tasks) {
     // This isn't a great place for this, but it ensures consistent cleanup.
@@ -241,7 +231,7 @@ public function fireComposeBatch($tasks) {
 
   /**
    * @param array<FlexMailerTask> $tasks
-   * @return SendBatchEvent
+   * @return \Civi\FlexMailer\Event\SendBatchEvent
    */
   public function fireSendBatch($tasks) {
     $event = new SendBatchEvent($this->context, $tasks);

diff --git a/src/Listener/Abdicator.php b/src/Listener/Abdicator.php
@@ -79,7 +79,8 @@ public static function isFlexmailPreferred($mailing) {
    */
   public function onRun(RunEvent $e) {
     if (self::isFlexmailPreferred($e->getMailing())) {
-      return; // OK, we'll continue running.
+      // OK, we'll continue running.
+      return;
     }
 
     // Nope, we'll abdicate.
@@ -98,7 +99,8 @@ public function onRun(RunEvent $e) {
    */
   public function onCheckSendable($e) {
     if (self::isFlexmailPreferred($e->getMailing())) {
-      return; // OK, we'll continue running.
+      // OK, we'll continue running.
+      return;
     }
 
     $e->stopPropagation();

diff --git a/src/Listener/Attachments.php b/src/Listener/Attachments.php
@@ -27,7 +27,6 @@
 namespace Civi\FlexMailer\Listener;
 
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 class Attachments extends BaseListener {
 
@@ -42,7 +41,7 @@ public function onCompose(ComposeBatchEvent $e) {
     }
 
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $task->setMailParam('attachments', $e->getAttachments());
     }
   }

diff --git a/src/Listener/BasicHeaders.php b/src/Listener/BasicHeaders.php
@@ -27,7 +27,6 @@
 namespace Civi\FlexMailer\Listener;
 
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 class BasicHeaders extends BaseListener {
 
@@ -44,7 +43,7 @@ public function onCompose(ComposeBatchEvent $e) {
     $mailing = $e->getMailing();
 
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
 
       if ($task->hasContent()) {
         continue;

diff --git a/src/Listener/BounceTracker.php b/src/Listener/BounceTracker.php
@@ -27,7 +27,6 @@
 namespace Civi\FlexMailer\Listener;
 
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 class BounceTracker extends BaseListener {
 
@@ -44,7 +43,7 @@ public function onCompose(ComposeBatchEvent $e) {
     $mailing = $e->getMailing();
 
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       list($verp) = $mailing->getVerpAndUrlsAndHeaders(
         $e->getJob()->id, $task->getEventQueueId(), $task->getHash(),
         $task->getAddress());

diff --git a/src/Listener/DefaultComposer.php b/src/Listener/DefaultComposer.php
@@ -81,7 +81,7 @@ public function onCompose(ComposeBatchEvent $e) {
 
     $hasContent = FALSE;
     foreach ($e->getTasks() as $key => $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       if (!$task->hasContent()) {
         $tp->addRow()->context($this->createTokenRowContext($e, $task));
         $hasContent = TRUE;
@@ -95,8 +95,8 @@ public function onCompose(ComposeBatchEvent $e) {
     $tp->evaluate();
 
     foreach ($tp->getRows() as $row) {
-      /** @var TokenRow $row */
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\Token\TokenRow $row */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $task = $row->context['flexMailerTask'];
       $task->setMailParams(array_merge(
         $this->createMailParams($e, $task, $row),
@@ -126,7 +126,7 @@ public function createTokenProcessorContext(ComposeBatchEvent $e) {
    * Create contextual data for a message recipient.
    *
    * @param \Civi\FlexMailer\Event\ComposeBatchEvent $e
-   * @param FlexMailerTask $task
+   * @param \Civi\FlexMailer\FlexMailerTask $task
    * @return array
    *   Contextual data describing the recipient.
    *   Typical values are `contactId` or `mailingJobId`.
@@ -151,8 +151,8 @@ public function createTokenRowContext(
    * For a given task, prepare the mailing.
    *
    * @param \Civi\FlexMailer\Event\ComposeBatchEvent $e
-   * @param FlexMailerTask $task
-   * @param TokenRow $row
+   * @param \Civi\FlexMailer\FlexMailerTask $task
+   * @param \Civi\Token\TokenRow $row
    * @return array
    *   A list of email parameters, such as "Subject", "text", and/or "html".
    * @see \CRM_Utils_Hook::alterMailParams
@@ -172,7 +172,7 @@ public function createMailParams(
   /**
    * Generate the message templates for use with token-processor.
    *
-   * @param ComposeBatchEvent $e
+   * @param \Civi\FlexMailer\Event\ComposeBatchEvent $e
    * @return array
    *   A list of templates. Some combination of:
    *     - subject: string
@@ -195,7 +195,7 @@ public function createMessageTemplates(ComposeBatchEvent $e) {
    * via `cv debug:event-dispatcher', but it produces the expected
    * interactions among tokens and click-tracking.
    *
-   * @param ComposeBatchEvent $e
+   * @param \Civi\FlexMailer\Event\ComposeBatchEvent $e
    * @param array $templates
    * @return array
    *   Updated templates.

diff --git a/src/Listener/DefaultSender.php b/src/Listener/DefaultSender.php
@@ -26,13 +26,7 @@
  */
 namespace Civi\FlexMailer\Listener;
 
-use Civi\FlexMailer\Event\RunEvent;
 use Civi\FlexMailer\Event\SendBatchEvent;
-use Civi\FlexMailer\Event\WalkBatchesEvent;
-use Civi\FlexMailer\FlexMailerTask;
-use Civi\Token\TokenProcessor;
-use Civi\Token\TokenRow;
-use Symfony\Component\EventDispatcher\Event;
 
 class DefaultSender extends BaseListener {
   const BULK_MAIL_INSERT_COUNT = 10;
@@ -56,7 +50,7 @@ public function onSend(SendBatchEvent $e) {
     $retryBatch = FALSE;
 
     foreach ($e->getTasks() as $key => $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       /** @var \Mail_mime $message */
       if (!$task->hasContent()) {
         continue;
@@ -206,7 +200,7 @@ protected function isTemporaryError($message) {
 
   /**
    * @param \CRM_Mailing_BAO_MailingJob $job
-   * @param FlexMailerTask $task
+   * @param \Civi\FlexMailer\FlexMailerTask $task
    * @param string $errorMessage
    */
   protected function recordBounce($job, $task, $errorMessage) {

diff --git a/src/Listener/HookAdapter.php b/src/Listener/HookAdapter.php
@@ -27,7 +27,6 @@
 namespace Civi\FlexMailer\Listener;
 
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 class HookAdapter extends BaseListener {
 
@@ -42,7 +41,7 @@ public function onCompose(ComposeBatchEvent $e) {
     }
 
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $mailParams = $task->getMailParams();
       if ($mailParams) {
         \CRM_Utils_Hook::alterMailParams($mailParams, 'flexmailer');

diff --git a/src/Listener/OpenTracker.php b/src/Listener/OpenTracker.php
@@ -27,7 +27,6 @@
 namespace Civi\FlexMailer\Listener;
 
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 class OpenTracker extends BaseListener {
 
@@ -44,7 +43,7 @@ public function onCompose(ComposeBatchEvent $e) {
     $config = \CRM_Core_Config::singleton();
 
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $mailParams = $task->getMailParams();
 
       if (!empty($mailParams) && !empty($mailParams['html'])) {

diff --git a/src/Listener/RequiredFields.php b/src/Listener/RequiredFields.php
@@ -47,7 +47,7 @@ class RequiredFields extends BaseListener {
    * RequiredFields constructor.
    * @param array $fields
    */
-  public function __construct( $fields) {
+  public function __construct($fields) {
     $this->fields = $fields;
   }
 

diff --git a/src/Listener/SimpleFilter.php b/src/Listener/SimpleFilter.php
@@ -26,9 +26,7 @@
  */
 namespace Civi\FlexMailer\Listener;
 
-use Civi\Core\Resolver;
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 /**
  * Class SimpleFilter
@@ -58,7 +56,7 @@ class SimpleFilter {
    */
   public static function byValue(ComposeBatchEvent $e, $field, $filter) {
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $value = $task->getMailParam($field);
       if ($value !== NULL) {
         $task->setMailParam($field, call_user_func($filter, $value, $task, $e));
@@ -86,7 +84,7 @@ public static function byColumn(ComposeBatchEvent $e, $field, $filter) {
     $values = array();
 
     foreach ($tasks as $k => $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $value = $task->getMailParam($field);
       if ($value !== NULL) {
         $values[$k] = $value;

diff --git a/src/Listener/TestPrefix.php b/src/Listener/TestPrefix.php
@@ -27,7 +27,6 @@
 namespace Civi\FlexMailer\Listener;
 
 use Civi\FlexMailer\Event\ComposeBatchEvent;
-use Civi\FlexMailer\FlexMailerTask;
 
 class TestPrefix extends BaseListener {
 
@@ -42,7 +41,7 @@ public function onCompose(ComposeBatchEvent $e) {
     }
 
     foreach ($e->getTasks() as $task) {
-      /** @var FlexMailerTask $task */
+      /** @var \Civi\FlexMailer\FlexMailerTask $task */
       $subject = $task->getMailParam('Subject');
       $subject = ts('[CiviMail Draft]') . ' ' . $subject;
       $task->setMailParam('Subject', $subject);