You are here

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

abstract class PayPalBasic in PayPal for Payment 8

Same name in this branch
  1. 8 src/Plugin/Payment/MethodConfiguration/PayPalBasic.php \Drupal\paypal_payment\Plugin\Payment\MethodConfiguration\PayPalBasic
  2. 8 src/Plugin/Payment/Method/PayPalBasic.php \Drupal\paypal_payment\Plugin\Payment\Method\PayPalBasic
Same name and namespace in other branches
  1. 2.0.x src/Plugin/Payment/MethodConfiguration/PayPalBasic.php \Drupal\paypal_payment\Plugin\Payment\MethodConfiguration\PayPalBasic

Abstract class for PayPal payment method configurations.

Hierarchy

Expanded class hierarchy of PayPalBasic

File

src/Plugin/Payment/MethodConfiguration/PayPalBasic.php, line 13

Namespace

Drupal\paypal_payment\Plugin\Payment\MethodConfiguration
View source 
abstract class PayPalBasic extends Basic {

  /**
   * Gets the setting for the production server.
   *
   * @return bool
   */
  public function isProduction() : bool {
    return !empty($this->configuration['production']);
  }

  /**
   * Gets the setting for logging the PayPal API traffic.
   *
   * @param $type
   *
   * @return bool
   */
  public function isLogging($type) : bool {
    return !empty($this->configuration['logging'][$type]);
  }

  /**
   * Gets the setting for the log level.
   *
   * @return string
   */
  public function getLogLevel() : string {
    return $this->configuration['loglevel'] ?? 'DEBUG';
  }

  /**
   * {@inheritdoc}
   */
  public function processBuildConfigurationForm(array &$element, FormStateInterface $form_state, array &$form) {
    parent::processBuildConfigurationForm($element, $form_state, $form);
    $element['paypal'] = [
      '#type' => 'container',
    ];
    $element['paypal']['production'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Production Server'),
      '#default_value' => $this
        ->isProduction(),
    ];
    $element['paypal']['logging'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Logging'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $element['paypal']['logging']['loglevel'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Log Level'),
      '#options' => [
        'DEBUG' => $this
          ->t('Debugging'),
      ],
      '#default_value' => $this
        ->getLogLevel(),
    ];
    $element['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_ADMIN] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Logging admin tasks'),
      '#default_value' => $this
        ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_ADMIN),
    ];
    $element['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_CREATE] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Logging when creating payment'),
      '#default_value' => $this
        ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_CREATE),
    ];
    $element['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_WEBHOOK] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Logging the webhooks'),
      '#default_value' => $this
        ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_WEBHOOK),
    ];
    $element['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_REDIRECT] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Logging the redirects back from PayPal'),
      '#default_value' => $this
        ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_REDIRECT),
    ];
    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['production'] = !empty($values['paypal']['production']);
    $this->configuration['loglevel'] = $values['paypal']['logging']['loglevel'];
    $this->configuration['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_ADMIN] = !empty($values['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_ADMIN]);
    $this->configuration['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_CREATE] = !empty($values['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_CREATE]);
    $this->configuration['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_WEBHOOK] = !empty($values['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_WEBHOOK]);
    $this->configuration['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_REDIRECT] = !empty($values['paypal']['logging'][PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_REDIRECT]);
  }

  /**
   * @return array
   */
  public function getDerivativeConfiguration() : array {
    return [
      'production' => $this
        ->isProduction(),
      'loglevel' => $this
        ->getLogLevel(),
      'logging' => [
        PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_ADMIN => $this
          ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_ADMIN),
        PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_CREATE => $this
          ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_CREATE),
        PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_WEBHOOK => $this
          ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_WEBHOOK),
        PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_REDIRECT => $this
          ->isLogging(PayPalBasicMethod::PAYPAL_CONTEXT_TYPE_REDIRECT),
      ],
    ];
  }

}

Members

Namesort descending 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::getDerivativeConfiguration public function 2
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.
PayPalBasic::processBuildConfigurationForm public function Implements a form API #process callback. Overrides Basic::processBuildConfigurationForm 2
PayPalBasic::submitConfigurationForm public function {} Overrides Basic::submitConfigurationForm 2
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.