CRM-16707 Make token usage the responsibality of the form

diff --git a/CRM/Activity/Form/Task/Email.php b/CRM/Activity/Form/Task/Email.php
index bc6d9f88c5e38d83e41c621c6c51051e3228ce3d..9f645046af79c4916352ee0addfb549b498eaab2 100644 (file)
--- a/CRM/Activity/Form/Task/Email.php
+++ b/CRM/Activity/Form/Task/Email.php
@@ -94,4 +94,14 @@ class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task {
     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Activity/Form/Task/SMS.php b/CRM/Activity/Form/Task/SMS.php
index 27a76384934acf08776e39acb093e7ae274094f8..ed22a31af01da82c532f9e699af579a3e3b53672 100644 (file)
--- a/CRM/Activity/Form/Task/SMS.php
+++ b/CRM/Activity/Form/Task/SMS.php
@@ -79,4 +79,14 @@ class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task {
     CRM_Contact_Form_Task_SMSCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Admin/Form/ScheduleReminders.php b/CRM/Admin/Form/ScheduleReminders.php
index 6877fcacf0e4b7a5f1c4ab00f54fd7dd19608ac9..eeb4786d348d4d382eab3b5f38a3cb06c0d3f7e4 100644 (file)
--- a/CRM/Admin/Form/ScheduleReminders.php
+++ b/CRM/Admin/Form/ScheduleReminders.php
@@ -612,4 +612,17 @@ class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form {
     CRM_Core_Session::setStatus($status, ts('Saved'), 'success');
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    $tokens = array_merge(CRM_Core_SelectValues::activityTokens(), $tokens);
+    $tokens = array_merge(CRM_Core_SelectValues::eventTokens(), $tokens);
+    $tokens = array_merge(CRM_Core_SelectValues::membershipTokens(), $tokens);
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Contact/Form/Task/Email.php b/CRM/Contact/Form/Task/Email.php
index 727b3515535503ba2b825f88b95d68d2e0532858..6d2b1c6e9106e6b286d51e926d84b01c9a31645a 100644 (file)
--- a/CRM/Contact/Form/Task/Email.php
+++ b/CRM/Contact/Form/Task/Email.php
@@ -171,4 +171,14 @@ class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task {
     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Contact/Form/Task/PDF.php b/CRM/Contact/Form/Task/PDF.php
index e15cc5458475bb6272df041ccd2ec0f5b79c26f5..533378e220c306b547a40dc84184beed7774b01b 100644 (file)
--- a/CRM/Contact/Form/Task/PDF.php
+++ b/CRM/Contact/Form/Task/PDF.php
@@ -128,4 +128,14 @@ class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task {
     CRM_Contact_Form_Task_PDFLetterCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Contact/Form/Task/SMS.php b/CRM/Contact/Form/Task/SMS.php
index ced918d764d0d4ffd4570bbc8c03199885b1991b..4752dd13d97e46adcfe928ea811388ec2a751100 100644 (file)
--- a/CRM/Contact/Form/Task/SMS.php
+++ b/CRM/Contact/Form/Task/SMS.php
@@ -95,4 +95,14 @@ class CRM_Contact_Form_Task_SMS extends CRM_Contact_Form_Task {
     CRM_Contact_Form_Task_SMSCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Contribute/Form/Task/Email.php b/CRM/Contribute/Form/Task/Email.php
index 7e7d5ca7bf4163875d9260ba3113522fbc8e1b50..098457972dfacf458ae0a7d07939a158c4abd973 100644 (file)
--- a/CRM/Contribute/Form/Task/Email.php
+++ b/CRM/Contribute/Form/Task/Email.php
@@ -91,4 +91,14 @@ class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task {
     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Contribute/Form/Task/PDFLetter.php b/CRM/Contribute/Form/Task/PDFLetter.php
index 7dbf5fbcf1a3c28a88b095c71b211b507a69121a..43e7fbfe865b2407c3f54626bac76fcb20acea82 100644 (file)
--- a/CRM/Contribute/Form/Task/PDFLetter.php
+++ b/CRM/Contribute/Form/Task/PDFLetter.php
@@ -167,4 +167,14 @@ class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task {
     CRM_Contribute_Form_Task_PDFLetterCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Event/Form/Task/Email.php b/CRM/Event/Form/Task/Email.php
index 5d2acef1cabd5a0f1a9e2c3c3e710c8d5fddc37e..c6ed9a4ee96097d9e42a3f46140764ff259db498 100644 (file)
--- a/CRM/Event/Form/Task/Email.php
+++ b/CRM/Event/Form/Task/Email.php
@@ -91,4 +91,14 @@ class CRM_Event_Form_Task_Email extends CRM_Event_Form_Task {
     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Event/Form/Task/PDF.php b/CRM/Event/Form/Task/PDF.php
index 47cf96ccaa2e42545b06e5a2156115574e3ecc2d..156594b987d1adf4f06383b697c99c14fba959bf 100644 (file)
--- a/CRM/Event/Form/Task/PDF.php
+++ b/CRM/Event/Form/Task/PDF.php
@@ -92,4 +92,14 @@ class CRM_Event_Form_Task_PDF extends CRM_Event_Form_Task {
     return CRM_Contact_Form_Task_PDFLetterCommon::setDefaultValues();
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php
index 96ceae5d847c226e853f3759a89448b82260f48a..1d810fde27f9f1b030c134aa66a2829c80e8b379 100644 (file)
--- a/CRM/Mailing/BAO/Mailing.php
+++ b/CRM/Mailing/BAO/Mailing.php
@@ -2637,22 +2637,8 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id   = m.id
    */
   public static function commonCompose(&$form) {
     //get the tokens.
-    $tokens = CRM_Core_SelectValues::contactTokens();
+    $tokens = array();
 
-    $className = CRM_Utils_System::getClassName($form);
-    if ($className == 'CRM_Mailing_Form_Upload') {
-      $tokens = array_merge(CRM_Core_SelectValues::mailingTokens(), $tokens);
-    }
-    elseif ($className == 'CRM_Admin_Form_ScheduleReminders') {
-      $tokens = array_merge(CRM_Core_SelectValues::activityTokens(), $tokens);
-      $tokens = array_merge(CRM_Core_SelectValues::eventTokens(), $tokens);
-      $tokens = array_merge(CRM_Core_SelectValues::membershipTokens(), $tokens);
-    }
-    elseif ($className == 'CRM_Event_Form_ManageEvent_ScheduleReminders') {
-      $tokens = array_merge(CRM_Core_SelectValues::eventTokens(), $tokens);
-    }
-
-    //TODO standardize on this method
     if (method_exists($form, 'listTokens')) {
       $tokens = array_merge($form->listTokens(), $tokens);
     }
@@ -2665,6 +2651,8 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id   = m.id
     $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
     $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
 
+    $className = CRM_Utils_System::getClassName($form);
+
     if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
       $className != 'CRM_Contact_Form_Task_SMS'
     ) {

diff --git a/CRM/Mailing/Form/Upload.php b/CRM/Mailing/Form/Upload.php
index d5c358c281e927216474b4f25c72de38879dc061..cee89c8cd54d5acba8c824a1b0dbb355df91a280 100644 (file)
--- a/CRM/Mailing/Form/Upload.php
+++ b/CRM/Mailing/Form/Upload.php
@@ -690,4 +690,15 @@ class CRM_Mailing_Form_Upload extends CRM_Core_Form {
     return ts('Mailing Content');
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    $tokens = array_merge(CRM_Core_SelectValues::mailingTokens(), $tokens);
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Member/Form/Task/Email.php b/CRM/Member/Form/Task/Email.php
index 94173123368c9ede65c1c8aa274f764faa5fcd12..7547b1e92ac515731944a11e5b75228226dd1e8f 100644 (file)
--- a/CRM/Member/Form/Task/Email.php
+++ b/CRM/Member/Form/Task/Email.php
@@ -100,4 +100,14 @@ class CRM_Member_Form_Task_Email extends CRM_Member_Form_Task {
     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }

diff --git a/CRM/Member/Form/Task/PDFLetter.php b/CRM/Member/Form/Task/PDFLetter.php
index fb27292ceb5ce382d7826e0d8c52449858430a81..b16efd74659823238acb92dfefd75ffb09e3d876 100644 (file)
--- a/CRM/Member/Form/Task/PDFLetter.php
+++ b/CRM/Member/Form/Task/PDFLetter.php
@@ -100,18 +100,14 @@ class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task {
   }
 
   /**
-   * List available tokens, at time of writing these were
-   * {membership.id} => Membership ID
-   * {membership.status} => Membership Status
-   * {membership.type} => Membership Type
-   * {membership.start_date} => Membership Start Date
-   * {membership.join_date} => Membership Join Date
-   * {membership.end_date} => Membership End Date
-   * {membership.fee} => Membership Fee
+   * List available tokens for this form.
+   *
    * @return array
    */
   public function listTokens() {
-    return CRM_Core_SelectValues::membershipTokens();
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    $tokens = array_merge(CRM_Core_SelectValues::membershipTokens(), $tokens);
+    return $tokens;
   }
 
 }

diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php
index a823a2b6dc5b7034080e7d59561e68c87887d97c..4a0b020c01a02eca9da6011c17813e3bfbe5895d 100644 (file)
--- a/CRM/SMS/Form/Upload.php
+++ b/CRM/SMS/Form/Upload.php
@@ -435,4 +435,14 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form {
     return ts('SMS Content');
   }
 
+  /**
+   * List available tokens for this form.
+   *
+   * @return array
+   */
+  public function listTokens() {
+    $tokens = CRM_Core_SelectValues::contactTokens();
+    return $tokens;
+  }
+
 }