CRM_Utils_Hook::alterMailer -- Fix typo

There was a discrepancy in the naming of this hook:

 * The stub function was named `alterMail`. Internal code therefore referred to `alterMail`.
 * The hook invocation fires as `alterMailer`. Downstream code therefore referred to `alterMailer`.

This patch standardizes on `alterMailer` to preserve the downstream
interface.  It leaves `::alterMail()` as a deprecated alias in case there's
some unexpected external use-case.

diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
index dc4907f3dd02c7210d2dedcb562ccb0194d2a014..5bcff27e6f5d1819c918bffd7356c1fc83d5a43d 100644 (file)
--- a/CRM/Utils/Hook.php
+++ b/CRM/Utils/Hook.php
@@ -1795,11 +1795,30 @@ abstract class CRM_Utils_Hook {
    * @return mixed
    * @see Mail::factory
    */
-  public static function alterMail(&$mailer, $driver, $params) {
+  public static function alterMailer(&$mailer, $driver, $params) {
     return self::singleton()
       ->invoke(3, $mailer, $driver, $params, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_alterMailer');
   }
 
+  /**
+   * Deprecated: Misnamed version of alterMailer(). Remove post-4.7.x.
+   * Modify or replace the Mailer object used for outgoing mail.
+   *
+   * @param object $mailer
+   *   The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
+   * @param string $driver
+   *   The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
+   * @param array $params
+   *   The default mailer config options
+   *
+   * @return mixed
+   * @see Mail::factory
+   * @deprecated
+   */
+  public static function alterMail(&$mailer, $driver, $params) {
+    return CRM_Utils_Hook::alterMailer($mailer, $driver, $params);
+  }
+
   /**
    * This hook is called while building the core search query,
    * so hook implementers can provide their own query objects which alters/extends core search.

diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php
index f80bcb45a804c259e6c202ed3199e3427e2e83b8..c940eddaafe6756a9a99fd80bdc25e8f1ea9f69c 100644 (file)
--- a/CRM/Utils/Mail.php
+++ b/CRM/Utils/Mail.php
@@ -126,7 +126,7 @@ class CRM_Utils_Mail {
     else {
       $mailer = Mail::factory($driver, $params);
     }
-    CRM_Utils_Hook::alterMail($mailer, $driver, $params);
+    CRM_Utils_Hook::alterMailer($mailer, $driver, $params);
     return $mailer;
   }