Merge pull request #5760 from sudhabisht/SMSissue

[civicrm-core.git] / CRM / Core / BAO / MessageTemplate.php

diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php
index d8ba0e606523c66b24ae94abfdf9b96a8d581f9d..48518b8be7077b26f11c983d33ff888adaa86457 100644 (file)
--- a/CRM/Core/BAO/MessageTemplate.php
+++ b/CRM/Core/BAO/MessageTemplate.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -41,15 +41,14 @@ require_once 'Mail/mime.php';
 class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
 
   /**
-   * Fetch object based on array of properties
+   * Fetch object based on array of properties.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Core_BAO_MessageTemplate object
-   * @static
+   * @return CRM_Core_BAO_MessageTemplate
    */
   public static function retrieve(&$params, &$defaults) {
     $messageTemplates = new CRM_Core_DAO_MessageTemplate();
@@ -62,7 +61,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
   }
 
   /**
-   * Update the is_active flag in the db
+   * Update the is_active flag in the db.
    *
    * @param int $id
    *   Id of the database record.
@@ -70,20 +69,18 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
    *   Value we want to set the is_active field.
    *
    * @return Object
-   *   DAO object on sucess, NULL otherwise
-   * @static
+   *   DAO object on success, NULL otherwise
    */
   public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_MessageTemplate', $id, 'is_active', $is_active);
   }
 
   /**
-   * Add the Message Templates
+   * Add the Message Templates.
    *
    * @param array $params
    *   Reference array contains the values submitted by the form.
    *
-   * @static
    *
    * @return object
    */
@@ -100,13 +97,10 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
   }
 
   /**
-   * Delete the Message Templates
-   *
-   * @static
+   * Delete the Message Templates.
    *
    * @param int $messageTemplatesID
-   *
-   * @return object
+   * @return void
    */
   public static function del($messageTemplatesID) {
     // make sure messageTemplatesID is an integer
@@ -129,9 +123,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
   }
 
   /**
-   * Get the Message Templates
+   * Get the Message Templates.
    *
-   * @static
    *
    * @param bool $all
    *
@@ -234,7 +227,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
       $smarty = CRM_Core_Smarty::singleton();
       foreach (array(
                  'text',
-                 'html'
+                 'html',
                ) as $elem) {
         $$elem = $smarty->fetch("string:{$$elem}");
       }
@@ -279,12 +272,12 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
   /**
    * Revert a message template to its default subject+text+HTML state
    *
-   * @param int id id of the template
+   * @param int $id id of the template
    *
    * @return void
    */
   public static function revert($id) {
-    $diverted = new self;
+    $diverted = new CRM_Core_BAO_MessageTemplate();
     $diverted->id = (int) $id;
     $diverted->find(1);
 
@@ -292,7 +285,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
       CRM_Core_Error::fatal(ts('Did not find a message template with id of %1.', array(1 => $id)));
     }
 
-    $orig = new self;
+    $orig = new CRM_Core_BAO_MessageTemplate();
     $orig->workflow_id = $diverted->workflow_id;
     $orig->is_reserved = 1;
     $orig->find(1);
@@ -309,13 +302,13 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
   }
 
   /**
-   * Send an email from the specified template based on an array of params
+   * Send an email from the specified template based on an array of params.
    *
    * @param array $params
    *   A string-keyed array of function params, see function body for details.
    *
    * @return array
-   *   of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
+   *   Array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
    */
   public static function sendTemplate($params) {
     $defaults = array(
@@ -384,7 +377,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
       else {
         CRM_Core_Error::fatal(ts('No such message template: option group %1, option value %2.', array(
               1 => $params['groupName'],
-              2 => $params['valueName']
+              2 => $params['valueName'],
             )));
       }
     }
@@ -414,7 +407,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
     // replace tokens in the three elements (in subject as if it was the text body)
     $domain = CRM_Core_BAO_Domain::getDomain();
     $hookTokens = array();
-    $mailing = new CRM_Mailing_BAO_Mailing;
+    $mailing = new CRM_Mailing_BAO_Mailing();
     $mailing->body_text = $text;
     $mailing->body_html = $html;
     $tokens = $mailing->getTokens();
@@ -457,7 +450,6 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
       $text = CRM_Utils_Token::replaceContactTokens($text, $contact, FALSE, $tokens['text'], FALSE, TRUE);
       $html = CRM_Utils_Token::replaceContactTokens($html, $contact, FALSE, $tokens['html'], FALSE, TRUE);
 
-
       $contactArray = array($contactID => $contact);
       CRM_Utils_Hook::tokenValues($contactArray,
         array($contactID),
@@ -477,8 +469,6 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
     $subject = "{strip}$subject{/strip}";
 
     // parse the three elements with Smarty
-
-
     $smarty = CRM_Core_Smarty::singleton();
     foreach ($params['tplParams'] as $name => $value) {
       $smarty->assign($name, $value);
@@ -486,7 +476,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
     foreach (array(
                'subject',
                'text',
-               'html'
+               'html',
              ) as $elem) {
       $$elem = $smarty->fetch("string:{$$elem}");
     }
@@ -545,4 +535,5 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
 
     return array($sent, $subject, $text, $html);
   }
+
 }