You are here

Home » API reference » Ubercart 8.4 » PaymentMethodListBuilder.php

class PaymentMethodListBuilder in Ubercart 8.4

Defines a class to build a listing of payment method configuration entities.

Hierarchy

Expanded class hierarchy of PaymentMethodListBuilder

File

payment/uc_payment/src/PaymentMethodListBuilder.php, line 17

Namespace

Drupal\uc_payment
View source 
class PaymentMethodListBuilder extends DraggableListBuilder {

  /**
   * The payment method manager.
   *
   * @var \Drupal\uc_payment\Plugin\PaymentMethodManager
   */
  protected $paymentMethodManager;

  /**
   * Constructs a new PaymentMethodListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\uc_payment\Plugin\PaymentMethodManager $payment_method_manager
   *   The payment method plugin manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, PaymentMethodManager $payment_method_manager) {
    parent::__construct($entity_type, $storage);
    $this->paymentMethodManager = $payment_method_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('plugin.manager.uc_payment.method'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'uc_payment_methods_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = [
      'data' => $this
        ->t('Payment method'),
    ];
    $header['plugin'] = [
      'data' => $this
        ->t('Type'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['status'] = [
      'data' => $this
        ->t('Status'),
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->label();
    $definition = $entity
      ->getPlugin()
      ->getPluginDefinition();
    $row['plugin']['#markup'] = $definition['name'];
    $row['status']['#markup'] = $entity
      ->status() ? $this
      ->t('Enabled') : $this
      ->t('Disabled');
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);

    // Locked payment methods may not be deleted.
    if (isset($operations['delete']) && $entity
      ->isLocked()) {
      unset($operations['delete']);
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $options = array_map(function ($definition) {
      return $definition['name'];
    }, array_filter($this->paymentMethodManager
      ->getDefinitions(), function ($definition) {
      return !$definition['no_ui'];
    }));
    if ($options) {
      uasort($options, 'strnatcasecmp');
      $form['add'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Add payment method'),
        '#open' => TRUE,
        '#attributes' => [
          'class' => [
            'container-inline',
          ],
        ],
      ];
      $form['add']['payment_method_type'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Type'),
        '#empty_option' => $this
          ->t('- Choose -'),
        '#options' => $options,
      ];
      $form['add']['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Add payment method'),
        '#validate' => [
          '::validateAddPaymentMethod',
        ],
        '#submit' => [
          '::submitAddPaymentMethod',
        ],
        '#limit_validation_errors' => [
          [
            'payment_method_type',
          ],
        ],
      ];
    }
    $form = parent::buildForm($form, $form_state);
    $form[$this->entitiesKey]['#empty'] = $this
      ->t('No payment methods have been configured.');
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this
      ->messenger()
      ->addMessage($this
      ->t('The configuration options have been saved.'));
  }

  /**
   * Form validation handler for adding a new payment method.
   */
  public function validateAddPaymentMethod(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->isValueEmpty('payment_method_type')) {
      $form_state
        ->setErrorByName('payment_method_type', $this
        ->t('You must select the new payment method type.'));
    }
  }

  /**
   * Form submission handler for adding a new payment method.
   */
  public function submitAddPaymentMethod(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('entity.uc_payment_method.add_form', [
      'plugin_id' => $form_state
        ->getValue('payment_method_type'),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build['description'] = [
      '#markup' => '<p>' . $this
        ->t('By default, only the "No payment required" payment method is listed here. To see additional payment methods you must <a href=":install">install additional modules</a>. The "Payment Method Pack" module that comes with Ubercart provides "Check" and "COD" payment methods. The "Credit Card" module that comes with Ubercart provides a credit card payment method, although you will need an additional module to provide a payment gateway for your credit card. For more information about payment methods and settings please read the <a href=":doc">Ubercart Documentation</a>.', [
        ':install' => Url::fromRoute('system.modules_list', [], [
          'fragment' => 'edit-modules-ubercart-payment',
        ])
          ->toString(),
        ':doc' => Url::fromUri('https://www.drupal.org/docs/8/modules/ubercart')
          ->toString(),
      ]) . '</p><p>' . $this
        ->t('The order of methods shown below is the order those methods will appear on the checkout page. To re-order, drag the method to its desired location using the drag icon then save the configuration using the button at the bottom of the page.') . '</p>',
    ];
    $build += parent::render();
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PaymentMethodListBuilder::$paymentMethodManager protected property The payment method manager.
PaymentMethodListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
PaymentMethodListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
PaymentMethodListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
PaymentMethodListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
PaymentMethodListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
PaymentMethodListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PaymentMethodListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides DraggableListBuilder::render
PaymentMethodListBuilder::submitAddPaymentMethod public function Form submission handler for adding a new payment method.
PaymentMethodListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm
PaymentMethodListBuilder::validateAddPaymentMethod public function Form validation handler for adding a new payment method.
PaymentMethodListBuilder::__construct public function Constructs a new PaymentMethodListBuilder object. Overrides DraggableListBuilder::__construct
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.