braintree_cashier-8.x-4.x-dev/braintree_cashier.api.php

<?php

/**
 * @file
 * Contains braintree_cashier.api.php.
 */

use Drupal\braintree_cashier\Entity\BraintreeCashierBillingPlanInterface;
use Drupal\braintree_cashier_enterprise\EnterpriseService;
use Drupal\Core\Form\FormStateInterface;
use Drupal\user\Entity\User;

/**
 * Alter the subscription types that need a Braintree subscription ID.
 *
 * Needed for the BraintreeSubscriptionIdConstraintValidator.
 *
 * @param array $types
 *   An array of subscription type machine names.
 */
function hook_braintree_cashier_subscription_types_need_braintree_id_alter(array &$types) {
  $types[] = EnterpriseService::ENTERPRISE_MANAGER;
}

/**
 * Alter the subscription type options for the subscription entity.
 *
 * @param array $options
 *   An array of subscription types keyed by machinename with human readable
 *   values.
 */
function hook_braintree_cashier_subscription_type_options_alter(array &$options) {
  $options = array_merge([
    EnterpriseService::ENTERPRISE_MANAGER => t('Enterprise Manager'),
    EnterpriseService::ENTERPRISE_INDIVIDUAL => t('Enterprise Individual'),
  ], $options);
}

/**
 * Alter the subscription types that may be created by a billing plan.
 *
 * @param array $options
 *   An array of subscription types keyed by machinename with human readable
 *   values.
 */
function hook_braintree_cashier_billing_plan_subscription_type_options_alter(array &$options) {
  $options = array_merge([
    EnterpriseService::ENTERPRISE_MANAGER => t('Enterprise Manager'),
  ], $options);
}

/**
 * Alter the parameters used to create a new subscription entity.
 *
 * Used when the entity is created by
 * \Drupal\braintree_cashier\SubscriptionService::createSubscriptionEntity.
 *
 * @param array $params
 *   The array of parameters passed to
 *   BraintreeCashierSubscriptionInterface::create().
 * @param \Drupal\braintree_cashier\Entity\BraintreeCashierBillingPlanInterface $billing_plan
 *   The billing plan entity from which the subscription will be created.
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state of the sign up form.
 */
function hook_braintree_cashier_create_subscription_params_alter(array &$params, BraintreeCashierBillingPlanInterface $billing_plan, FormStateInterface $form_state = NULL) {
  if ($billing_plan->getSubscriptionType() == EnterpriseService::ENTERPRISE_MANAGER) {
    $params = array_merge([
      'num_users' => \Drupal::getContainer()->get('braintree_cashier_enterprise.enterprise_service')->getBillingPlanNumUsers($billing_plan),
    ], $params);
  }
}

/**
 * Alter whether the coupon code is valid.
 *
 * @param bool $discount_exists
 *   Whether the provided coupon code is valid.
 * @param string $coupon_code
 *   The user provided coupon code.
 * @param array $context
 *   An associative array containing
 *   - billing_plan: The billing plan entity from which a subscription entity
 *     is being created.
 *   - account: The User account which is attempting to use the coupon code.
 */
function hook_braintree_cashier_discount_exists_alter(&$discount_exists, $coupon_code, $context) {
  // Verify whether the coupon code is a referral code associated with a user.
}

/**
 * Alters the user provided coupon code.
 *
 * Helpful to translate a referral code into a Braintree discount code.
 *
 * @param string $coupon_code
 *   The user provided coupon code.
 */
function hook_braintree_cashier_coupon_code_alter(&$coupon_code) {
  // Look up a referral code with the given coupon code.
  // Translate the referral code to an associated discount code in Braintree.
}

/**
 * Alter the formatted period end date of a subscription.
 *
 * @param array $data
 *   An associative array containing:
 *   - formatted_period_end_date: The formatted period end date.
 *   - timestamp: The timestamp of the period end date.
 *   - subscription_entity: the subscription entity.
 */
function hook_braintree_cashier_formatted_period_end_date_alter(array &$data) {
  $data['formatted_period_end_date'] = \Drupal::service('date.formatter')->format($data['timestamp'], 'short');
}