Merge pull request #22884 from civicrm/5.47

[civicrm-core.git] / CRM / Contribute / WorkflowMessage / RecurringEdit.php

<?php

/**
 * @support template-only
 * @method array getContact()
 * @method $this setContact(array $contact)
 * @method array getContributionRecur()
 */
class CRM_Contribute_WorkflowMessage_RecurringEdit extends Civi\WorkflowMessage\GenericWorkflowMessage {
  use CRM_Contribute_WorkflowMessage_RecurringTrait;

  public const WORKFLOW = 'contribution_recurring_edit';

  /**
   * The recurring contribution contact.
   *
   * @var array|null
   *
   * @scope tokenContext
   *
   * @required
   */
  public $contact;

  /**
   * Smarty template historically defined a property 'receipt_from_email'.
   * (Note the asymmetric lack of 'receipt_from_name'.)
   *
   * TODO: This should probably be deprecated/converted/reconciled with `$this->from` in the basic AddressingTrait.
   *
   * @var string|null
   * @scope tplParams as receipt_from_email
   */
  public $receiptFromEmail;

  /**
   * Export tokens to smarty as variables.
   *
   * The key represents the smarty token and the value is the token as
   * requested from the token processor.
   *
   * The token is 'the entire part between the curly quotes' eg.
   *
   * '{contribution_recur.amount|crmMoney}.
   *
   * Unlike using the contribution directly it will default to 'raw' formatting.
   *
   * @param array $export
   */
  protected function exportExtraTokenContext(array &$export): void {
    $export['smartyTokenAlias']['installments'] = 'contribution_recur.installments';
    $export['smartyTokenAlias']['amount'] = 'contribution_recur.amount|crmMoney';
    $export['smartyTokenAlias']['recur_frequency_unit'] = 'contribution_recur.frequency_unit:label';
    $export['smartyTokenAlias']['recur_frequency_interval'] = 'contribution_recur.frequency_interval';
  }

  /**
   * Extra variables to be exported to smarty based on being calculated.
   *
   * @param array $export
   */
  protected function exportExtraTplParams(array &$export): void {
    if (empty($export['receipt_from_email']) && !empty($this->from)) {
      // At a minimum, we can at least autofill 'receipt_from_email' in the case where it's missing.
      $export['receipt_from_email'] = $this->getFrom('record')['email'];
    }
  }

}