You are here

Home » API reference » Payment 8.2 » PaymentMethodConfigurationListBuilder.php

class PaymentMethodConfigurationListBuilder in Payment 8.2

Lists payment method configurations..

Hierarchy

Expanded class hierarchy of PaymentMethodConfigurationListBuilder

1 file declares its use of PaymentMethodConfigurationListBuilder
PaymentMethodConfigurationListBuilderTest.php in tests/src/Unit/Entity/PaymentMethodConfiguration/PaymentMethodConfigurationListBuilderTest.php

File

src/Entity/PaymentMethodConfiguration/PaymentMethodConfigurationListBuilder.php, line 14

Namespace

Drupal\payment\Entity\PaymentMethodConfiguration
View source 
class PaymentMethodConfigurationListBuilder extends ConfigEntityListBuilder {

  /**
   * The payment method configuration manager.
   *
   * @var \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface
   */
  protected $paymentMethodConfigurationManager;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {

    /** @var static $list_builder */
    $list_builder = parent::createInstance($container, $entity_type);
    $list_builder->moduleHandler = $container
      ->get('module_handler');
    $list_builder->paymentMethodConfigurationManager = $container
      ->get('plugin.manager.payment.method_configuration');
    $list_builder->stringTranslation = $container
      ->get('string_translation');
    return $list_builder;
  }

  /**
   * Sets the payment method configuration manager.
   *
   * @param \Drupal\payment\Plugin\Payment\MethodConfiguration\PaymentMethodConfigurationManagerInterface $payment_method_configuration_manager
   *   The payment method configuration manager.
   */
  public function setPaymentMethodConfigurationManager(PaymentMethodConfigurationManagerInterface $payment_method_configuration_manager) {
    $this->paymentMethodConfigurationManager = $payment_method_configuration_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $row['label'] = [
      'data' => $this
        ->t('Name'),
    ];
    $row['plugin'] = [
      'data' => $this
        ->t('Type'),
    ];
    $row['owner'] = array(
      'data' => $this
        ->t('Owner'),
      'class' => array(
        RESPONSIVE_PRIORITY_LOW,
      ),
    );
    $row['status'] = array(
      'data' => $this
        ->t('Status'),
      'class' => array(
        RESPONSIVE_PRIORITY_MEDIUM,
      ),
    );
    $row['operations'] = [
      'data' => $this
        ->t('Operations'),
    ];
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\payment\Entity\PaymentMethodConfigurationInterface $payment_method_configuration */
    $payment_method_configuration = $entity;
    $row['data']['label'] = $payment_method_configuration
      ->label();
    $plugin_definition = $this->paymentMethodConfigurationManager
      ->getDefinition($payment_method_configuration
      ->getPluginId());
    $row['data']['plugin'] = isset($plugin_definition['label']) ? $plugin_definition['label'] : $this
      ->t('Unknown');
    $row['data']['owner']['data'] = array(
      '#theme' => 'username',
      '#account' => $payment_method_configuration
        ->getOwner(),
    );
    $row['data']['status'] = $payment_method_configuration
      ->status() ? $this
      ->t('Enabled') : $this
      ->t('Disabled');
    $operations = $this
      ->buildOperations($entity);
    $row['data']['operations']['data'] = $operations;
    if (!$payment_method_configuration
      ->status()) {
      $row['class'] = array(
        'payment-method-configuration-disabled',
      );
    }
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    foreach (array(
      'enable',
      'disable',
    ) as $operation) {
      if (!$entity
        ->access($operation)) {
        unset($operations[$operation]);
      }
    }
    if ($entity
      ->access('duplicate')) {
      $operations['duplicate'] = array(
        'title' => $this
          ->t('Duplicate'),
        'weight' => 99,
        'url' => $entity
          ->toUrl('duplicate-form'),
      );
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['table']['#attached']['library'][] = 'payment/payment_method_configuration.list';
    $build['table']['#attributes']['class'][] = 'payment-method-configuration-list';
    $build['table']['#empty'] = $this
      ->t('There is no payment method configuration yet.');
    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
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::$limit protected property The number of entities to list per page, or FALSE to list all entities. 3
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
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 16
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PaymentMethodConfigurationListBuilder::$paymentMethodConfigurationManager protected property The payment method configuration manager.
PaymentMethodConfigurationListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
PaymentMethodConfigurationListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
PaymentMethodConfigurationListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
PaymentMethodConfigurationListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
PaymentMethodConfigurationListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
PaymentMethodConfigurationListBuilder::setPaymentMethodConfigurationManager public function Sets the payment method configuration manager.
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.