From: Tim Mallezie <tim.mallezie@chiro.be>
Date: Wed, 17 Jun 2015 14:53:39 +0000 (+0200)
Subject: CRM-16707 Make token usage the responsibality of the form
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=5ec6b0ad7ef1bcc8c697c117ce88e33ba6c2c8f2;p=civicrm-core.git

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 bc6d9f88c5..9f645046af 100644
--- 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 27a7638493..ed22a31af0 100644
--- 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 6877fcacf0..eeb4786d34 100644
--- 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 727b351553..6d2b1c6e91 100644
--- 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 e15cc54584..533378e220 100644
--- 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 ced918d764..4752dd13d9 100644
--- 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 7e7d5ca7bf..098457972d 100644
--- 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 7dbf5fbcf1..43e7fbfe86 100644
--- 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 5d2acef1ca..c6ed9a4ee9 100644
--- 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 47cf96ccaa..156594b987 100644
--- 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 96ceae5d84..1d810fde27 100644
--- 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 d5c358c281..cee89c8cd5 100644
--- 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 9417312336..7547b1e92a 100644
--- 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 fb27292ceb..b16efd7465 100644
--- 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 a823a2b6dc..4a0b020c01 100644
--- 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;
+  }
+
 }