X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FContribute%2FTokens.php;h=ca1b952cc7fb842cfc24209b783d14d6f0c90d87;hb=b5e0905cb40f7d91842653767ea7e2ae02e20bd8;hp=6ff9a0c63731ac433bbe6fd3fc859497d1922fec;hpb=7481d06dfc486fe079cd3a7e96d321f6c1287e69;p=civicrm-core.git

diff --git a/CRM/Contribute/Tokens.php b/CRM/Contribute/Tokens.php
index 6ff9a0c637..ca1b952cc7 100644
--- a/CRM/Contribute/Tokens.php
+++ b/CRM/Contribute/Tokens.php
@@ -10,11 +10,6 @@
  +--------------------------------------------------------------------+
  */
 
-use Civi\ActionSchedule\Event\MailingQueryEvent;
-use Civi\Token\AbstractTokenSubscriber;
-use Civi\Token\TokenProcessor;
-use Civi\Token\TokenRow;
-
 /**
  * Class CRM_Contribute_Tokens
  *
@@ -23,65 +18,71 @@ use Civi\Token\TokenRow;
  * At time of writing, we don't have any particularly special tokens -- we just
  * do some basic formatting based on the corresponding DB field.
  */
-class CRM_Contribute_Tokens extends AbstractTokenSubscriber {
+class CRM_Contribute_Tokens extends CRM_Core_EntityTokens {
 
   /**
    * @return string
    */
-  private function getEntityName(): string {
+  protected function getEntityName(): string {
     return 'contribution';
   }
 
   /**
-   * Get the relevant bao name.
+   * @return string
    */
-  public function getBAOName(): string {
-    return CRM_Core_DAO_AllCoreTables::getFullName(ucfirst($this->getEntityName()));
+  protected function getEntityAlias(): string {
+    return 'contrib_';
   }
 
   /**
-   * Metadata about the entity fields.
+   * Get the entity name for api v4 calls.
    *
-   * @var array
+   * In practice this IS just ucfirst($this->GetEntityName)
+   * but declaring it seems more legible.
+   *
+   * @return string
    */
-  protected $entityFieldMetadata = [];
+  protected function getApiEntityName(): string {
+    return 'Contribution';
+  }
 
   /**
-   * Get a list of tokens whose name and title match the DB fields.
+   * Get a list of tokens for the entity for which access is permitted to.
+   *
+   * 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
    */
-  protected function getPassthruTokens(): array {
-    return [
+  protected function getExposedFields(): array {
+    $fields = [
       'contribution_page_id',
+      'source',
+      'id',
       'receive_date',
       'total_amount',
       'fee_amount',
       'net_amount',
+      'non_deductible_amount',
       'trxn_id',
       'invoice_id',
       'currency',
-      'contribution_cancel_date',
+      'cancel_date',
       'receipt_date',
       'thankyou_date',
       'tax_amount',
       'contribution_status_id',
+      'financial_type_id',
+      'payment_instrument_id',
+      'cancel_reason',
+      'amount_level',
+      'check_number',
     ];
-  }
-
-  /**
-   * Get alias tokens.
-   *
-   * @return array
-   */
-  protected function getAliasTokens(): array {
-    return [
-      'id' => 'contribution_id',
-      'payment_instrument' => 'payment_instrument_id',
-      'source' => 'contribution_source',
-      'status' => 'contribution_status_id',
-      'type' => 'financial_type_id',
-      'cancel_date' => 'contribution_cancel_date',
-    ];
+    if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
+      $fields[] = 'campaign_id';
+    }
+    return $fields;
   }
 
   /**
@@ -95,137 +96,12 @@ class CRM_Contribute_Tokens extends AbstractTokenSubscriber {
    *
    * @return string[]
    */
-  protected function getBasicTokens(): array {
-    return ['contribution_status_id' => ts('Contribution Status ID')];
-  }
-
-  /**
-   * Get pseudoTokens - it tokens that reflect the name or label of a pseudoconstant.
-   *
-   * @internal - this function will likely be made protected soon.
-   *
-   * @return array
-   */
-  public function getPseudoTokens(): array {
+  public function getBasicTokens(): array {
     $return = [];
-    foreach (array_keys($this->getBasicTokens()) as $fieldName) {
-      if (!empty($this->entityFieldMetadata[$fieldName]['pseudoconstant'])) {
-        $return[$fieldName . ':label'] = $this->entityFieldMetadata[$fieldName]['html']['label'];
-        $return[$fieldName . ':name'] = ts('Machine name') . ': ' . $this->entityFieldMetadata[$fieldName]['html']['label'];
-      }
+    foreach ($this->getExposedFields() as $fieldName) {
+      $return[$fieldName] = $this->getFieldMetadata()[$fieldName]['title'];
     }
     return $return;
   }
 
-  /**
-   * Class constructor.
-   */
-  public function __construct() {
-    $this->entityFieldMetadata = CRM_Contribute_DAO_Contribution::fields();
-    $tokens = CRM_Utils_Array::subset(
-      CRM_Utils_Array::collect('title', $this->entityFieldMetadata),
-      $this->getPassthruTokens()
-    );
-    $tokens['id'] = ts('Contribution ID');
-    $tokens['payment_instrument'] = ts('Payment Instrument');
-    $tokens['source'] = ts('Contribution Source');
-    // Per https://lab.civicrm.org/dev/core/-/issues/2650
-    // the intent is to deprecate this field in favour of
-    // {contribution.contribution_status_id:label}
-    $tokens['status'] = ts('Contribution Status');
-    $tokens['type'] = ts('Financial Type');
-    $tokens = array_merge($tokens, $this->getPseudoTokens(), CRM_Utils_Token::getCustomFieldTokens('Contribution'));
-    parent::__construct('contribution', $tokens);
-  }
-
-  /**
-   * Check if the token processor is active.
-   *
-   * @param \Civi\Token\TokenProcessor $processor
-   *
-   * @return bool
-   */
-  public function checkActive(TokenProcessor $processor) {
-    return !empty($processor->context['actionMapping'])
-      && $processor->context['actionMapping']->getEntity() === 'civicrm_contribution';
-  }
-
-  /**
-   * Alter action schedule query.
-   *
-   * @param \Civi\ActionSchedule\Event\MailingQueryEvent $e
-   */
-  public function alterActionScheduleQuery(MailingQueryEvent $e): void {
-    if ($e->mapping->getEntity() !== 'civicrm_contribution') {
-      return;
-    }
-
-    $fields = CRM_Contribute_DAO_Contribution::fields();
-    foreach ($this->getPassthruTokens() as $token) {
-      $e->query->select("e." . $fields[$token]['name'] . " AS contrib_{$token}");
-    }
-    foreach (array_keys($this->getPseudoTokens()) as $token) {
-      $split = explode(':', $token);
-      $e->query->select("e." . $fields[$split[0]]['name'] . " AS contrib_{$split[0]}");
-    }
-    foreach ($this->getAliasTokens() as $alias => $orig) {
-      $e->query->select('e.' . $fields[$orig]['name'] . " AS contrib_{$alias}");
-    }
-  }
-
-  /**
-   * @inheritDoc
-   */
-  public function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL) {
-    $actionSearchResult = $row->context['actionSearchResult'];
-    $fieldValue = $actionSearchResult->{"contrib_$field"} ?? NULL;
-
-    $aliasTokens = $this->getAliasTokens();
-    if (in_array($field, ['total_amount', 'fee_amount', 'net_amount'])) {
-      return $row->format('text/plain')->tokens($entity, $field,
-        \CRM_Utils_Money::format($fieldValue, $actionSearchResult->contrib_currency));
-    }
-    if (isset($aliasTokens[$field])) {
-      $row->dbToken($entity, $field, 'CRM_Contribute_BAO_Contribution', $aliasTokens[$field], $fieldValue);
-    }
-    elseif ($cfID = \CRM_Core_BAO_CustomField::getKeyID($field)) {
-      $row->customToken($entity, $cfID, $actionSearchResult->entity_id);
-    }
-    elseif (array_key_exists($field, $this->getPseudoTokens())) {
-      $split = explode(':', $field);
-      $row->tokens($entity, $field, $this->getPseudoValue($split[0], $split[1], $actionSearchResult->{"contrib_$split[0]"} ?? NULL));
-    }
-    elseif (in_array($field, array_keys($this->getBasicTokens()))) {
-      // For now we just ensure that the label fields do not override the
-      // id field here.
-      // Later we will add support for contribution_status_id:label
-      $row->tokens($entity, $field, $fieldValue);
-    }
-    else {
-      $row->dbToken($entity, $field, 'CRM_Contribute_BAO_Contribution', $field, $fieldValue);
-    }
-  }
-
-  /**
-   * Get the value for the relevant pseudo field.
-   *
-   * @param string $realField e.g contribution_status_id
-   * @param string $pseudoKey e.g name
-   * @param int|string $fieldValue e.g 1
-   *
-   * @return string
-   *   Eg. 'Completed' in the example above.
-   *
-   * @internal function will likely be protected soon.
-   */
-  public function getPseudoValue(string $realField, string $pseudoKey, $fieldValue): string {
-    if ($pseudoKey === 'name') {
-      $fieldValue = (string) CRM_Core_PseudoConstant::getName($this->getBAOName(), $realField, $fieldValue);
-    }
-    if ($pseudoKey === 'label') {
-      $fieldValue = (string) CRM_Core_PseudoConstant::getLabel($this->getBAOName(), $realField, $fieldValue);
-    }
-    return (string) $fieldValue;
-  }
-
 }