src/applications/phortune/storage/PhortuneCharge.php

   1 <?php
   2
   3 /**
   4  * A charge is a charge (or credit) against an account and represents an actual
   5  * transfer of funds. Each charge is normally associated with a cart, but a
   6  * cart may have multiple charges. For example, a product may have a failed
   7  * charge followed by a successful charge.
   8  */
   9 final class PhortuneCharge extends PhortuneDAO
  10   implements
  11     PhabricatorPolicyInterface,
  12     PhabricatorExtendedPolicyInterface {
  13
  14   const STATUS_CHARGING   = 'charge:charging';
  15   const STATUS_CHARGED    = 'charge:charged';
  16   const STATUS_HOLD       = 'charge:hold';
  17   const STATUS_FAILED     = 'charge:failed';
  18
  19   protected $accountPHID;
  20   protected $authorPHID;
  21   protected $cartPHID;
  22   protected $providerPHID;
  23   protected $merchantPHID;
  24   protected $paymentMethodPHID;
  25   protected $amountAsCurrency;
  26   protected $amountRefundedAsCurrency;
  27   protected $refundedChargePHID;
  28   protected $refundingPHID;
  29   protected $status;
  30   protected $metadata = array();
  31
  32   private $account = self::ATTACHABLE;
  33   private $cart = self::ATTACHABLE;
  34
  35   public static function initializeNewCharge() {
  36     return id(new PhortuneCharge())
  37       ->setStatus(self::STATUS_CHARGING)
  38       ->setAmountRefundedAsCurrency(PhortuneCurrency::newEmptyCurrency());
  39   }
  40
  41   protected function getConfiguration() {
  42     return array(
  43       self::CONFIG_AUX_PHID => true,
  44       self::CONFIG_SERIALIZATION => array(
  45         'metadata' => self::SERIALIZATION_JSON,
  46       ),
  47       self::CONFIG_APPLICATION_SERIALIZERS => array(
  48         'amountAsCurrency' => new PhortuneCurrencySerializer(),
  49         'amountRefundedAsCurrency' => new PhortuneCurrencySerializer(),
  50       ),
  51       self::CONFIG_COLUMN_SCHEMA => array(
  52         'paymentMethodPHID' => 'phid?',
  53         'refundedChargePHID' => 'phid?',
  54         'refundingPHID' => 'phid?',
  55         'amountAsCurrency' => 'text64',
  56         'amountRefundedAsCurrency' => 'text64',
  57         'status' => 'text32',
  58       ),
  59       self::CONFIG_KEY_SCHEMA => array(
  60         'key_cart' => array(
  61           'columns' => array('cartPHID'),
  62         ),
  63         'key_account' => array(
  64           'columns' => array('accountPHID'),
  65         ),
  66         'key_merchant' => array(
  67           'columns' => array('merchantPHID'),
  68         ),
  69         'key_provider' => array(
  70           'columns' => array('providerPHID'),
  71         ),
  72       ),
  73     ) + parent::getConfiguration();
  74   }
  75
  76   public static function getStatusNameMap() {
  77     return array(
  78       self::STATUS_CHARGING => pht('Charging'),
  79       self::STATUS_CHARGED => pht('Charged'),
  80       self::STATUS_HOLD => pht('Hold'),
  81       self::STATUS_FAILED => pht('Failed'),
  82     );
  83   }
  84
  85   public static function getNameForStatus($status) {
  86     return idx(self::getStatusNameMap(), $status, pht('Unknown'));
  87   }
  88
  89   public function isRefund() {
  90     return $this->getAmountAsCurrency()->negate()->isPositive();
  91   }
  92
  93   public function getStatusForDisplay() {
  94     if ($this->getStatus() == self::STATUS_CHARGED) {
  95       if ($this->getRefundedChargePHID()) {
  96         return pht('Refund');
  97       }
  98
  99       $refunded = $this->getAmountRefundedAsCurrency();
 100
 101       if ($refunded->isPositive()) {
 102         if ($refunded->isEqualTo($this->getAmountAsCurrency())) {
 103           return pht('Fully Refunded');
 104         } else {
 105           return pht('%s Refunded', $refunded->formatForDisplay());
 106         }
 107       }
 108     }
 109
 110     return self::getNameForStatus($this->getStatus());
 111   }
 112
 113   public function generatePHID() {
 114     return PhabricatorPHID::generateNewPHID(
 115       PhortuneChargePHIDType::TYPECONST);
 116   }
 117
 118   public function getMetadataValue($key, $default = null) {
 119     return idx($this->metadata, $key, $default);
 120   }
 121
 122   public function setMetadataValue($key, $value) {
 123     $this->metadata[$key] = $value;
 124     return $this;
 125   }
 126
 127   public function getAccount() {
 128     return $this->assertAttached($this->account);
 129   }
 130
 131   public function attachAccount(PhortuneAccount $account) {
 132     $this->account = $account;
 133     return $this;
 134   }
 135
 136   public function getCart() {
 137     return $this->assertAttached($this->cart);
 138   }
 139
 140   public function attachCart(PhortuneCart $cart = null) {
 141     $this->cart = $cart;
 142     return $this;
 143   }
 144
 145   public function getAmountRefundableAsCurrency() {
 146     $amount = $this->getAmountAsCurrency();
 147     $refunded = $this->getAmountRefundedAsCurrency();
 148
 149     // We can't refund negative amounts of money, since it does not make
 150     // sense and is not possible in the various payment APIs.
 151
 152     $refundable = $amount->subtract($refunded);
 153     if ($refundable->isPositive()) {
 154       return $refundable;
 155     } else {
 156       return PhortuneCurrency::newEmptyCurrency();
 157     }
 158   }
 159
 160
 161 /* -(  PhabricatorPolicyInterface  )----------------------------------------- */
 162
 163
 164   public function getCapabilities() {
 165     return array(
 166       PhabricatorPolicyCapability::CAN_VIEW,
 167       PhabricatorPolicyCapability::CAN_EDIT,
 168     );
 169   }
 170
 171   public function getPolicy($capability) {
 172     return PhabricatorPolicies::getMostOpenPolicy();
 173   }
 174
 175   public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
 176     if ($capability === PhabricatorPolicyCapability::CAN_VIEW) {
 177       $any_edit = PhortuneMerchantQuery::canViewersEditMerchants(
 178         array($viewer->getPHID()),
 179         array($this->getMerchantPHID()));
 180       if ($any_edit) {
 181         return true;
 182       }
 183     }
 184
 185     return false;
 186   }
 187
 188
 189 /* -(  PhabricatorExtendedPolicyInterface  )--------------------------------- */
 190
 191
 192   public function getExtendedPolicy($capability, PhabricatorUser $viewer) {
 193     if ($this->hasAutomaticCapability($capability, $viewer)) {
 194       return array();
 195     }
 196
 197     return array(
 198       array(
 199         $this->getAccount(),
 200         PhabricatorPolicyCapability::CAN_EDIT,
 201       ),
 202     );
 203   }
 204
 205 }