dev/core#2747 - Reconcile fields. Consolidate/simplify loading of APIv4-style tokens.

CRM/Campaign/BAO/Campaign.php

@@ -301,20 +301,14 @@ public static function getPermissionedCampaigns(
 
   /**
    * Is CiviCampaign enabled.
+   *
    * @return bool
    */
-  public static function isCampaignEnable() {
-    static $isEnable = NULL;
-
-    if (!isset($isEnable)) {
-      $isEnable = FALSE;
-      $config = CRM_Core_Config::singleton();
-      if (in_array('CiviCampaign', $config->enableComponents)) {
-        $isEnable = TRUE;
-      }
+  public static function isCampaignEnable(): bool {
+    if (!isset(Civi::$statics[__CLASS__]['is_enabled'])) {
+      Civi::$statics[__CLASS__]['is_enabled'] = in_array('CiviCampaign', CRM_Core_Config::singleton()->enableComponents, TRUE);
     }
-
-    return $isEnable;
+    return Civi::$statics[__CLASS__]['is_enabled'];
   }
 
   /**

CRM/Contribute/BAO/Contribution.php

@@ -5167,11 +5167,7 @@ public static function getContributionTokenValues($id, $messageToken) {
     }
     if (!empty($messageToken['contribution'])) {
       $processor = new CRM_Contribute_Tokens();
-      $pseudoFields = array_keys($processor->getPseudoTokens());
-      foreach ($pseudoFields as $pseudoField) {
-        $split = explode(':', $pseudoField);
-        $result['values'][$id][$pseudoField] = $processor->getPseudoValue($split[0], $split[1], $result['values'][$id][$split[0]] ?? '');
-      }
+      $result['values'][$id] = array_merge($result['values'][$id], $processor->getPseudoValues($id));
     }
     return $result;
   }

CRM/Contribute/Tokens.php

@@ -27,13 +27,6 @@ protected function getEntityName(): string {
     return 'contribution';
   }
 
-  /**
-   * @return string
-   */
-  protected function getEntityAlias(): string {
-    return 'contrib_';
-  }
-
   /**
    * Get the entity name for api v4 calls.
    *
@@ -47,16 +40,17 @@ protected function getApiEntityName(): string {
   }
 
   /**
-   * Get a list of tokens for the entity for which access is permitted to.
+   * Get a list of tokens which are loaded via APIv4.
    *
    * This list is historical and we need to question whether we
    * should filter out any fields (other than those fields, like api_key
    * on the contact entity) with permissions defined.
    *
    * @return array
+   *   Ex: ['foo', 'bar_id', 'bar_id:name', 'bar_id:label']
    */
-  protected function getExposedFields(): array {
-    return [
+  protected function getApiTokens(): array {
+    $fields = [
       'contribution_page_id',
       'source',
       'id',
@@ -73,28 +67,58 @@ protected function getExposedFields(): array {
       'thankyou_date',
       'tax_amount',
       'contribution_status_id',
+      'contribution_status_id:name',
+      'contribution_status_id:label',
       'financial_type_id',
+      'financial_type_id:name',
+      'financial_type_id:label',
       'payment_instrument_id',
+      'payment_instrument_id:name',
+      'payment_instrument_id:label',
+      'cancel_reason',
+      'amount_level',
+      'check_number',
     ];
+    if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
+      $fields[] = 'campaign_id';
+      $fields[] = 'campaign_id.name';
+      $fields[] = 'campaign_id.title';
+    }
+
+    return $fields;
   }
 
-  /**
-   * Get tokens supporting the syntax we are migrating to.
-   *
-   * In general these are tokens that were not previously supported
-   * so we can add them in the preferred way or that we have
-   * undertaken some, as yet to be written, db update.
-   *
-   * See https://lab.civicrm.org/dev/core/-/issues/2650
-   *
-   * @return string[]
-   */
-  public function getBasicTokens(): array {
-    $return = [];
-    foreach ($this->getExposedFields() as $fieldName) {
-      $return[$fieldName] = $this->getFieldMetadata()[$fieldName]['title'];
+  public function getAliasTokens(): array {
+    $aliases = [];
+    if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
+      // Unit-tests are written to use these funny tokens - but they're not valid in APIv4.
+      $aliases['campaign'] = 'campaign_id.name';
+      $aliases['campaign_id:name'] = 'campaign_id.name';
+      $aliases['campaign_id:label'] = 'campaign_id.title';
+    }
+    return $aliases;
+  }
+
+  public function getPrefetchFields(\Civi\Token\Event\TokenValueEvent $e): array {
+    $result = parent::getPrefetchFields($e);
+
+    // Always prefetch 'civicrm_contribution.currency' in case we need to format other fields (fee_amount, total_amount, etc).
+    $result[] = 'currency';
+
+    return array_unique($result);
+  }
+
+  public function evaluateToken(\Civi\Token\TokenRow $row, $entity, $field, $prefetch = NULL) {
+    $values = $prefetch[$row->context[$this->getEntityIDField()]];
+
+    // Any monetary fields in a `Contribution` (`fee_amount`, `total_amount`, etc) should be formatted in matching `currency`.
+    // This formatting rule would be nonsensical in any other entity.
+    if ($this->isApiFieldType($field, 'Money')) {
+      return $row->format('text/plain')->tokens($entity, $field,
+        \CRM_Utils_Money::format($values[$field], $values['currency']));
     }
-    return $return;
+
+    return parent::evaluateToken($row, $entity, $field, $prefetch);
   }
 
 }

CRM/Core/BAO/ActionSchedule.php

@@ -267,38 +267,44 @@ public static function sendMailings($mappingID, $now) {
       );
 
       $multilingual = CRM_Core_I18n::isMultilingual();
+      $tokenProcessor = self::createTokenProcessor($actionSchedule, $mapping);
       while ($dao->fetch()) {
+        $row = $tokenProcessor->addRow()
+          ->context('contactId', $dao->contactID)
+          ->context('actionSearchResult', (object) $dao->toArray());
+
         // switch language if necessary
         if ($multilingual) {
           $preferred_language = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $dao->contactID, 'preferred_language');
-          CRM_Core_BAO_ActionSchedule::setCommunicationLanguage($actionSchedule->communication_language, $preferred_language);
+          $row->context('locale', CRM_Core_BAO_ActionSchedule::pickLocale($actionSchedule->communication_language, $preferred_language));
         }
 
-        $errors = [];
-        try {
-          $tokenProcessor = self::createTokenProcessor($actionSchedule, $mapping);
-          $tokenProcessor->addRow()
-            ->context('contactId', $dao->contactID)
-            ->context('actionSearchResult', (object) $dao->toArray());
-          foreach ($tokenProcessor->evaluate()->getRows() as $tokenRow) {
-            if ($actionSchedule->mode === 'SMS' || $actionSchedule->mode === 'User_Preference') {
-              CRM_Utils_Array::extend($errors, self::sendReminderSms($tokenRow, $actionSchedule, $dao->contactID));
-            }
-
-            if ($actionSchedule->mode === 'Email' || $actionSchedule->mode === 'User_Preference') {
-              CRM_Utils_Array::extend($errors, self::sendReminderEmail($tokenRow, $actionSchedule, $dao->contactID));
-            }
-            // insert activity log record if needed
-            if ($actionSchedule->record_activity && empty($errors)) {
-              $caseID = empty($dao->case_id) ? NULL : $dao->case_id;
-              CRM_Core_BAO_ActionSchedule::createMailingActivity($tokenRow, $mapping, $dao->contactID, $dao->entityID, $caseID);
+        foreach ($dao->toArray() as $key => $value) {
+          if (preg_match('/^tokenContext_(.*)/', $key, $m)) {
+            if (!in_array($m[1], $tokenProcessor->context['schema'])) {
+              $tokenProcessor->context['schema'][] = $m[1];
             }
+            $row->context($m[1], $value);
           }
         }
-        catch (\Civi\Token\TokenException $e) {
-          $errors['token_exception'] = $e->getMessage();
+      }
+
+      $tokenProcessor->evaluate();
+      foreach ($tokenProcessor->getRows() as $tokenRow) {
+        $dao = $tokenRow->context['actionSearchResult'];
+        $errors = [];
+        if ($actionSchedule->mode === 'SMS' || $actionSchedule->mode === 'User_Preference') {
+          CRM_Utils_Array::extend($errors, self::sendReminderSms($tokenRow, $actionSchedule, $dao->contactID));
         }
 
+        if ($actionSchedule->mode === 'Email' || $actionSchedule->mode === 'User_Preference') {
+          CRM_Utils_Array::extend($errors, self::sendReminderEmail($tokenRow, $actionSchedule, $dao->contactID));
+        }
+        // insert activity log record if needed
+        if ($actionSchedule->record_activity && empty($errors)) {
+          $caseID = empty($dao->case_id) ? NULL : $dao->case_id;
+          CRM_Core_BAO_ActionSchedule::createMailingActivity($tokenRow, $mapping, $dao->contactID, $dao->entityID, $caseID);
+        }
         // update action log record
         $logParams = [
           'id' => $dao->reminderID,
@@ -308,7 +314,6 @@ public static function sendMailings($mappingID, $now) {
         ];
         CRM_Core_BAO_ActionLog::create($logParams);
       }
-
     }
   }
 
@@ -401,10 +406,11 @@ public static function getRecipientListing($mappingID, $recipientType) {
   }
 
   /**
-   * @param $communication_language
-   * @param $preferred_language
+   * @param string|null $communication_language
+   * @param string|null $preferred_language
+   * @return string
    */
-  public static function setCommunicationLanguage($communication_language, $preferred_language) {
+  public static function pickLocale($communication_language, $preferred_language) {
     $currentLocale = CRM_Core_I18n::getLocale();
     $language = $currentLocale;
 
@@ -425,8 +431,7 @@ public static function setCommunicationLanguage($communication_language, $prefer
     }
 
     // change the language
-    $i18n = CRM_Core_I18n::singleton();
-    $i18n->setLocale($language);
+    return $language;
   }
 
   /**