You are here

Home » API reference » PayPal for Payment 8 » Redirect.php

class Redirect in PayPal for Payment 8

Same name and namespace in other branches
  1. 2.0.x src/Controller/Redirect.php \Drupal\paypal_payment\Controller\Redirect

Handles the "redirect" route.

Hierarchy

Expanded class hierarchy of Redirect

File

src/Controller/Redirect.php, line 20

Namespace

Drupal\paypal_payment\Controller
View source 
class Redirect extends ControllerBase {

  /**
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * Redirect constructor.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   */
  public function __construct(Request $request) {
    $this->request = $request;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @noinspection NullPointerExceptionInspection */
    return new static($container
      ->get('request_stack')
      ->getCurrentRequest());
  }

  /**
   * @param \Drupal\payment\Entity\PaymentInterface $payment
   *
   * @return \Drupal\Core\Access\AccessResult
   */
  public function access(PaymentInterface $payment) : AccessResult {
    return AccessResult::allowedIf($this
      ->verify($payment));
  }

  /**
   * {@inheritdoc}
   */
  private function verify(PaymentInterface $payment) {

    /** @var PayPalBasic $payment_method */
    $payment_method = $payment
      ->getPaymentMethod();
    return $payment
      ->getOwnerId() === $this
      ->currentUser()
      ->id() && $this->request
      ->get('paymentId') === $payment_method
      ->getPaymentId();
  }

  /**
   * PayPal is redirecting the visitor here after the payment process. At this
   * point we don't know the status of the payment yet so we can only load
   * the payment and give control back to the payment context.
   *
   * @param PaymentInterface $payment
   * @return Response
   */
  public function execute(PaymentInterface $payment) : Response {
    $paymentId = $this->request
      ->get('paymentId');
    $payerID = $this->request
      ->get('PayerID');

    /** @var PayPalBasic $payment_method */
    $payment_method = $payment
      ->getPaymentMethod();

    /** @var ApiContext $api_context */
    $api_context = $payment_method
      ->getApiContext($payment_method::PAYPAL_CONTEXT_TYPE_REDIRECT);
    $p = Payment::get($paymentId, $api_context);
    $execution = new PaymentExecution();
    $execution
      ->setPayerId($payerID);
    try {
      $p
        ->execute($execution, $api_context);
      $payment_method
        ->doCapturePayment();
    } catch (Exception $ex) {

      // TODO: Error handling
    }
    return $this
      ->getResponse($payment);
  }

  /**
   * @param \Drupal\payment\Entity\PaymentInterface $payment
   *
   * @return \Symfony\Component\HttpFoundation\Response
   */
  public function cancel(PaymentInterface $payment) : Response {
    return $this
      ->getResponse($payment);
  }

  /**
   * @param \Drupal\payment\Entity\PaymentInterface $payment
   *
   * @return \Symfony\Component\HttpFoundation\Response
   */
  private function getResponse(PaymentInterface $payment) : Response {
    $response = $payment
      ->getPaymentType()
      ->getResumeContextResponse();
    return $response
      ->getResponse();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
Redirect::$request protected property
Redirect::access public function
Redirect::cancel public function
Redirect::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
Redirect::execute public function PayPal is redirecting the visitor here after the payment process. At this point we don't know the status of the payment yet so we can only load the payment and give control back to the payment context.
Redirect::getResponse private function
Redirect::verify private function
Redirect::__construct public function Redirect constructor.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.