class PayPalExpress in PayPal for Payment 8

Same name in this branch

8 src/Plugin/Payment/MethodConfiguration/PayPalExpress.php \Drupal\paypal_payment\Plugin\Payment\MethodConfiguration\PayPalExpress
8 src/Plugin/Payment/Method/PayPalExpress.php \Drupal\paypal_payment\Plugin\Payment\Method\PayPalExpress

Same name and namespace in other branches

2.0.x src/Plugin/Payment/MethodConfiguration/PayPalExpress.php \Drupal\paypal_payment\Plugin\Payment\MethodConfiguration\PayPalExpress

Provides the configuration for the PayPal Express payment method plugin.

Plugin annotation


@PaymentMethodConfiguration(
  description = @Translation("PayPal Express payment method type."),
  id = "paypal_payment_express",
  label = @Translation("PayPal Express")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationBase implements ConfigurableInterface, DependentPluginInterface, PaymentMethodConfigurationInterface
    class \Drupal\payment\Plugin\Payment\MethodConfiguration\Basic implements ContainerFactoryPluginInterface
    class \Drupal\paypal_payment\Plugin\Payment\MethodConfiguration\PayPalBasic
    class \Drupal\paypal_payment\Plugin\Payment\MethodConfiguration\PayPalExpress

Expanded class hierarchy of PayPalExpress

File

src/Plugin/Payment/MethodConfiguration/PayPalExpress.php, line 24

Namespace

Drupal\paypal_payment\Plugin\Payment\MethodConfiguration

View source

class PayPalExpress extends PayPalBasic {

  /**
   * Gets the client ID of this configuration.
   *
   * @return string
   */
  public function getClientId() : string {
    return $this->configuration['clientId'] ?? '';
  }

  /**
   * Gets the client secret of this configuration.
   *
   * @return string
   */
  public function getClientSecret() : string {
    return $this->configuration['clientSecret'] ?? '';
  }

  /**
   * Gets the webhook ID of this configuration.
   *
   * @return string
   */
  public function getWebhookId() : string {
    return $this->configuration['webhookId'] ?? '';
  }

  /**
   * {@inheritdoc}
   */
  public function processBuildConfigurationForm(array &$element, FormStateInterface $form_state, array &$form) {
    parent::processBuildConfigurationForm($element, $form_state, $form);
    $element['paypal']['clientId'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Client ID'),
      '#default_value' => $this
        ->getClientId(),
      '#maxlength' => 255,
      '#required' => TRUE,
    ];
    $element['paypal']['clientSecret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Client Secret'),
      '#default_value' => $this
        ->getClientSecret(),
      '#maxlength' => 255,
      '#required' => TRUE,
    ];
    return $element;
  }

  /**
   * {{@inheritdoc}}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $parents = $form['plugin_form']['paypal']['#parents'];
    array_pop($parents);
    $values = $form_state
      ->getValues();
    $values = NestedArray::getValue($values, $parents);
    $this->configuration['clientId'] = $values['paypal']['clientId'];
    $this->configuration['clientSecret'] = $values['paypal']['clientSecret'];
    $this->configuration['webhookId'] = $this
      ->updateWebhook($this->configuration, $form_state
      ->getValue('id'));
  }

  /**
   * @param $configuration
   * @param $id
   * @return string
   */
  private function updateWebhook($configuration, $id) : string {
    $webhookId = $this
      ->getWebhookId();
    $webhookUrl = PayPalExpressMethod::webhookUrl($id);
    $apiContext = PayPalExpressMethod::apiContext($configuration, PayPalExpressMethod::PAYPAL_CONTEXT_TYPE_ADMIN);
    if (!empty($webhookId)) {
      try {
        $webhook = Webhook::get($webhookId, $apiContext);
        if ($webhookUrl !== $webhook
          ->getUrl()) {
          $patch = new Patch();
          $patch
            ->setOp('replace')
            ->setPath('/url')
            ->setValue($webhookUrl);
          $patchRequest = new PatchRequest();
          $patchRequest
            ->addPatch($patch);
          $webhook
            ->update($patchRequest, $apiContext);
        }
      } catch (Exception $ex) {
        $webhookId = '';
      }
    }
    if (empty($webhookId)) {
      try {

        // Create a new webhook
        $webhook = new Webhook();
        $webhook
          ->setUrl($webhookUrl);
        $eventType = new WebhookEventType();
        $eventType
          ->setName('*');
        $webhook
          ->setEventTypes([
          $eventType,
        ]);
        $webhook = $webhook
          ->create($apiContext);
        $webhookId = $webhook
          ->getId();
      } catch (Exception $ex) {
        $this
          ->messenger()
          ->addError($this
          ->t('Something went wrong when creating the webhook for your PayPal Express payment method.'));
      }
    }
    return $webhookId;
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeConfiguration() : array {
    return parent::getDerivativeConfiguration() + [
      'clientId' => $this
        ->getClientId(),
      'clientSecret' => $this
        ->getClientSecret(),
      'webhookId' => $this
        ->getWebhookId(),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Basic::$paymentStatusType	protected	property	The payment status plugin type.
Basic::$pluginSelectorManager	protected	property	The plugin selector manager.
Basic::buildConfigurationForm	public	function	Form constructor. Overrides PaymentMethodConfigurationBase::buildConfigurationForm
Basic::create	public static	function	Creates an instance of the plugin. Overrides PaymentMethodConfigurationBase::create
Basic::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides PaymentMethodConfigurationBase::defaultConfiguration
Basic::getBrandLabel	public	function	Gets the brand label.
Basic::getCapture	public	function	Gets whether or not capture is supported.
Basic::getCapturePaymentStatusSelector	protected	function	Gets the payment status selector for the capture phase.
Basic::getCaptureStatusId	public	function	Gets the status to set on payment capture.
Basic::getExecutePaymentStatusSelector	protected	function	Gets the payment status selector for the execute phase.
Basic::getExecuteStatusId	public	function	Gets the status to set on payment execution.
Basic::getPaymentStatusSelector	protected	function	Gets the payment status selector.
Basic::getRefund	public	function	Gets whether or not refunds are supported.
Basic::getRefundPaymentStatusSelector	protected	function	Gets the payment status selector for the refund phase.
Basic::getRefundStatusId	public	function	Gets the status to set on payment refund.
Basic::setBrandLabel	public	function	Sets the brand label.
Basic::setCapture	public	function	Sets whether or not capture is supported.
Basic::setCaptureStatusId	public	function	Sets the status to set on payment capture.
Basic::setExecuteStatusId	public	function	Sets the status to set on payment execution.
Basic::setRefund	public	function	Sets whether or not refunds are supported.
Basic::setRefundStatusId	public	function	Sets the status to set on payment refund.
Basic::validateConfigurationForm	public	function	Form validation handler. Overrides PaymentMethodConfigurationBase::validateConfigurationForm
Basic::__construct	public	function	Constructs a new instance. Overrides PaymentMethodConfigurationBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PaymentMethodConfigurationBase::$moduleHandler	protected	property	The module handler.
PaymentMethodConfigurationBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
PaymentMethodConfigurationBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PaymentMethodConfigurationBase::getMessageText	public	function	Gets the payer message text.
PaymentMethodConfigurationBase::getMessageTextFormat	public	function	Gets the payer message text format.
PaymentMethodConfigurationBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PaymentMethodConfigurationBase::setMessageText	public	function	Sets payer message text.
PaymentMethodConfigurationBase::setMessageTextFormat	public	function	Sets payer message text format.
PayPalBasic::getLogLevel	public	function	Gets the setting for the log level.
PayPalBasic::isLogging	public	function	Gets the setting for logging the PayPal API traffic.
PayPalBasic::isProduction	public	function	Gets the setting for the production server.
PayPalExpress::getClientId	public	function	Gets the client ID of this configuration.
PayPalExpress::getClientSecret	public	function	Gets the client secret of this configuration.
PayPalExpress::getDerivativeConfiguration	public	function	Overrides PayPalBasic::getDerivativeConfiguration
PayPalExpress::getWebhookId	public	function	Gets the webhook ID of this configuration.
PayPalExpress::processBuildConfigurationForm	public	function	Implements a form API #process callback. Overrides PayPalBasic::processBuildConfigurationForm
PayPalExpress::submitConfigurationForm	public	function	{} Overrides PayPalBasic::submitConfigurationForm
PayPalExpress::updateWebhook	private	function
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.

You are here

class PayPalExpress in PayPal for Payment 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation