Page MenuHomec4science
Files F104521907

PhortunePaymentProvider.php
No OneTemporary
Actions

File Metadata

Created
Mon, Mar 10, 03:31

PhortunePaymentProvider.php
View Options

<?php
/**
* @task addmethod Adding Payment Methods
*/
abstract class PhortunePaymentProvider {
/* -( Selecting Providers )------------------------------------------------ */
public static function getAllProviders() {
$objects = id(new PhutilSymbolLoader())
->setAncestorClass('PhortunePaymentProvider')
->loadObjects();
return mpull($objects, null, 'getProviderKey');
}
public static function getEnabledProviders() {
$providers = self::getAllProviders();
foreach ($providers as $key => $provider) {
if (!$provider->isEnabled()) {
unset($providers[$key]);
}
}
return $providers;
}
public static function getProvidersForAddPaymentMethod() {
$providers = self::getEnabledProviders();
foreach ($providers as $key => $provider) {
if (!$provider->canCreatePaymentMethods()) {
unset($providers[$key]);
}
}
return $providers;
}
public static function getProvidersForOneTimePayment() {
$providers = self::getEnabledProviders();
foreach ($providers as $key => $provider) {
if (!$provider->canProcessOneTimePayments()) {
unset($providers[$key]);
}
}
return $providers;
}
public static function getProviderByDigest($digest) {
$providers = self::getEnabledProviders();
foreach ($providers as $key => $provider) {
$provider_digest = PhabricatorHash::digestForIndex($key);
if ($provider_digest == $digest) {
return $provider;
}
}
return null;
}
abstract public function isEnabled();
final public function getProviderKey() {
return $this->getProviderType().'@'.$this->getProviderDomain();
}
/**
* Return a short string which uniquely identifies this provider's protocol
* type, like "stripe", "paypal", or "balanced".
*/
abstract public function getProviderType();
/**
* Return a short string which uniquely identifies the domain for this
* provider, like "stripe.com" or "google.com".
*
* This is distinct from the provider type so that protocols are not bound
* to a single domain. This is probably not relevant for payments, but this
* assumption burned us pretty hard with authentication and it's easy enough
* to avoid.
*/
abstract public function getProviderDomain();
abstract public function getPaymentMethodDescription();
abstract public function getPaymentMethodIcon();
abstract public function getPaymentMethodProviderDescription();
/**
* Determine of a provider can handle a payment method.
*
* @return bool True if this provider can apply charges to the payment
* method.
*/
abstract public function canHandlePaymentMethod(
PhortunePaymentMethod $method);
abstract protected function executeCharge(
PhortunePaymentMethod $payment_method,
PhortuneCharge $charge);
/* -( Adding Payment Methods )--------------------------------------------- */
/**
* @task addmethod
*/
public function canCreatePaymentMethods() {
return false;
}
/**
* @task addmethod
*/
public function translateCreatePaymentMethodErrorCode($error_code) {
throw new PhortuneNotImplementedException($this);
}
/**
* @task addmethod
*/
public function getCreatePaymentMethodErrorMessage($error_code) {
throw new PhortuneNotImplementedException($this);
}
/**
* @task addmethod
*/
public function validateCreatePaymentMethodToken(array $token) {
throw new PhortuneNotImplementedException($this);
}
/**
* @task addmethod
*/
public function createPaymentMethodFromRequest(
AphrontRequest $request,
PhortunePaymentMethod $method,
array $token) {
throw new PhortuneNotImplementedException($this);
}
/**
* @task addmethod
*/
public function renderCreatePaymentMethodForm(
AphrontRequest $request,
array $errors) {
throw new PhortuneNotImplementedException($this);
}
/* -( One-Time Payments )-------------------------------------------------- */
public function canProcessOneTimePayments() {
return false;
}
public function renderOneTimePaymentButton(
PhortuneAccount $account,
PhortuneCart $cart,
PhabricatorUser $user) {
throw new PhortuneNotImplementedException($this);
}
/* -( Controllers )-------------------------------------------------------- */
final public function getControllerURI(
$action,
array $params = array()) {
$digest = PhabricatorHash::digestForIndex($this->getProviderKey());
$app = PhabricatorApplication::getByClass('PhabricatorApplicationPhortune');
$path = $app->getBaseURI().'provider/'.$digest.'/'.$action.'/';
$uri = new PhutilURI($path);
$uri->setQueryParams($params);
return PhabricatorEnv::getURI((string)$uri);
}
public function canRespondToControllerAction($action) {
return false;
}
public function processControllerRequest(
PhortuneProviderController $controller,
AphrontRequest $request) {
throw new PhortuneNotImplementedException($this);
}
}

Event Timeline

c4science · Help