X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FContribute%2FTokens.php;h=6569c6a72ee34146048117db326b0e4ba7be8f54;hb=7fc328b34ceee79a202cc896b150c54b84ad03dc;hp=e671979590fcadf72e49bbc5137f9f1a1adf7b5e;hpb=2cd5e2977ac67f987c870801c629374975ea0e92;p=civicrm-core.git

diff --git a/CRM/Contribute/Tokens.php b/CRM/Contribute/Tokens.php
index e671979590..6569c6a72e 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,220 +18,32 @@ 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
    */
-  protected function getEntityName(): string {
-    return 'contribution';
-  }
-
-  /**
-   * Get the relevant bao name.
-   */
-  public function getBAOName(): string {
-    return CRM_Core_DAO_AllCoreTables::getFullName(ucfirst($this->getEntityName()));
+  protected function getEntityAlias(): string {
+    return 'contrib_';
   }
 
   /**
-   * Metadata about the entity fields.
-   *
-   * @var array
-   */
-  protected $fieldMetadata = [];
-
-  /**
-   * Get a list of tokens whose name and title match the DB fields.
-   * @return array
-   */
-  protected function getPassthruTokens(): array {
-    return [
-      'contribution_page_id',
-      'source',
-      'id',
-      'receive_date',
-      'total_amount',
-      'fee_amount',
-      'net_amount',
-      'trxn_id',
-      'invoice_id',
-      'currency',
-      'cancel_date',
-      'receipt_date',
-      'thankyou_date',
-      'tax_amount',
-      'contribution_status_id',
-      'financial_type_id',
-      'payment_instrument_id',
-    ];
-  }
-
-  /**
-   * 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.
+   * Get the entity name for api v4 calls.
    *
-   * See https://lab.civicrm.org/dev/core/-/issues/2650
-   *
-   * @return string[]
-   */
-  public function getBasicTokens(): array {
-    $return = [];
-    foreach (['contribution_status_id', 'payment_instrument_id', 'financial_type_id', 'contribution_page_id'] as $fieldName) {
-      $return[$fieldName] = $this->getFieldMetadata()[$fieldName]['title'];
-    }
-    return $return;
-  }
-
-  /**
-   * 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 {
-    $return = [];
-    foreach (array_keys($this->getBasicTokens()) as $fieldName) {
-      if (!empty($this->fieldMetadata[$fieldName]['pseudoconstant'])) {
-        $return[$fieldName . ':label'] = $this->fieldMetadata[$fieldName]['html']['label'];
-        $return[$fieldName . ':name'] = ts('Machine name') . ': ' . $this->fieldMetadata[$fieldName]['html']['label'];
-      }
-    }
-    return $return;
-  }
-
-  /**
-   * Class constructor.
-   */
-  public function __construct() {
-    $tokens = CRM_Utils_Array::subset(
-      CRM_Utils_Array::collect('title', $this->getFieldMetadata()),
-      $this->getPassthruTokens()
-    );
-    $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 = $this->getFieldMetadata();
-    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]}");
-    }
-  }
-
-  /**
-   * @inheritDoc
-   */
-  public function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL) {
-    $actionSearchResult = $row->context['actionSearchResult'];
-    $fieldValue = $actionSearchResult->{"contrib_$field"} ?? NULL;
-
-    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));
-    }
-    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()))) {
-      $row->tokens($entity, $field, $fieldValue);
-    }
-    elseif (!array_key_exists($field, CRM_Contribute_BAO_Contribution::fields())) {
-      if ($this->isDateField($field)) {
-        $row->format('text/plain')->tokens($entity, $field, \CRM_Utils_Date::customFormat($fieldValue));
-      }
-      else {
-        $row->format('text/plain')->tokens($entity, $field, $fieldValue);
-      }
-    }
-    else {
-      $row->dbToken($entity, $field, 'CRM_Contribute_BAO_Contribution', $field, $fieldValue);
-    }
-  }
-
-  /**
-   * Is the given field a date field.
-   *
-   * @param string $fieldName
-   *
-   * @return bool
-   */
-  public function isDateField($fieldName): bool {
-    return $this->getFieldMetadata()[$fieldName]['type'] === (\CRM_Utils_Type::T_DATE + \CRM_Utils_Type::T_TIME);
-  }
-
-  /**
-   * 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
+   * In practice this IS just ucfirst($this->GetEntityName)
+   * but declaring it seems more legible.
    *
    * @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;
+  protected function getApiEntityName(): string {
+    return 'Contribution';
   }
 
   /**
-   * Get the metadata for the available fields.
-   *
    * @return array
    */
-  protected function getFieldMetadata(): array {
-    if (empty($this->fieldMetadata)) {
-      $baoName = $this->getBAOName();
-      $fields = (array) $baoName::fields();
-      // re-index by real field name. I originally wanted to use apiv4
-      // getfields - but it returns different stuff for 'type' and
-      // does not return 'pseudoconstant' as a key so for now...
-      foreach ($fields as $details) {
-        $this->fieldMetadata[$details['name']] = $details;
-      }
-    }
-    return $this->fieldMetadata;
+  public function getCurrencyFieldName() {
+    return ['currency'];
   }
 
 }