class TransactionTypeListBuilder in Transaction 8

Provides a entity list page for transaction types.

View source

class TransactionTypeListBuilder extends ConfigEntityListBuilder {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The transactor plugin manager.
   *
   * @var \Drupal\transaction\TransactorPluginManager
   */
  protected $transactorManager;

  /**
   * Constructs a new TransactionTypeListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\transaction\TransactorPluginManager $transactor_manager
   *   The transactor plugin manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EntityTypeManagerInterface $entity_type_manager, TransactorPluginManager $transactor_manager) {
    parent::__construct($entity_type, $storage);
    $this->entityTypeManager = $entity_type_manager;
    $this->transactorManager = $transactor_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Name');
    $header['transactor'] = $this
      ->t('Transactor');
    $header['target_entity_type'] = $this
      ->t('Target entity type');
    $header['target_entity_bundles'] = $this
      ->t('Applicable bundles');
    return $header + parent::buildHeader();
  }

  /**
   * Gets the transactor plugin label for the given transaction type.
   *
   * @param \Drupal\transaction\TransactionTypeInterface $transaction_type
   *   The transaction type.
   *
   * @return array
   *   A render array of the transactor plugin label.
   */
  protected function getTransactorPlugin(TransactionTypeInterface $transaction_type) {
    $transactor = $this->transactorManager
      ->getDefinition($transaction_type
      ->getPluginId());
    return [
      'data' => [
        '#markup' => $transactor['title'],
      ],
    ];
  }

  /**
   * Gets the target entity type label for the given transaction type.
   *
   * @param \Drupal\transaction\TransactionTypeInterface $transaction_type
   *   The transaction type.
   *
   * @return array
   *   A render array of the target entity type label.
   */
  protected function getTargetType(TransactionTypeInterface $transaction_type) {
    $target_entity_type = $this->entityTypeManager
      ->getDefinition($transaction_type
      ->getTargetEntityTypeId());
    return [
      'data' => [
        '#markup' => $target_entity_type
          ->getLabel(),
      ],
    ];
  }

  /**
   * Generates a render array of the applicable bundles.
   *
   * @param \Drupal\transaction\TransactionTypeInterface $transaction_type
   *   The transaction type.
   *
   * @return array
   *   A render array of the applicable bundle's label.
   */
  protected function getTargetBundles(TransactionTypeInterface $transaction_type) {
    $bundles = $transaction_type
      ->getBundles();
    if (empty($bundles)) {
      return [
        'data' => [
          '#markup' => '<em>' . $this
            ->t('All') . '</em>',
          '#allowed_tags' => [
            'em',
          ],
        ],
      ];
    }

    // Compose bundle labels.
    if ($target_bundle_id = $this->entityTypeManager
      ->getDefinition($transaction_type
      ->getTargetEntityTypeId())
      ->getBundleEntityType()) {
      $target_bundle_storage = $this->entityTypeManager
        ->getStorage($target_bundle_id);
      foreach ($bundles as $key => $bundle) {
        $bundles[$key] = $target_bundle_storage
          ->load($bundle)
          ->label();
      }
    }
    return [
      'data' => [
        '#markup' => implode(', ', $bundles),
      ],
    ];
  }

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

    /** @var \Drupal\transaction\TransactionTypeInterface $entity */
    $row = [];
    $row['label'] = [
      'data' => $entity
        ->label(),
      'class' => [
        'menu-label',
      ],
    ];
    $row['transactor'] = $this
      ->getTransactorPlugin($entity);
    $row['target_entity_type'] = $this
      ->getTargetType($entity);
    $row['target_entity_bundles'] = $this
      ->getTargetBundles($entity);
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['table']['#empty'] = $this
      ->t('No transaction types available. <a href=":link">Add a transaction type</a>.', [
      ':link' => Url::fromRoute('transaction.transaction_type_creation')
        ->toString(),
    ]);
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    return [
      'operations' => [
        'title' => $this
          ->t('Transaction operations'),
        'weight' => 50,
        'url' => Url::fromRoute('entity.transaction_operation.collection', [
          'transaction_type' => $entity
            ->id(),
        ]),
      ],
    ] + parent::getDefaultOperations($entity);
  }

}

Members

Name	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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
TransactionTypeListBuilder::$entityTypeManager	protected	property	The entity type manager.
TransactionTypeListBuilder::$transactorManager	protected	property	The transactor plugin manager.
TransactionTypeListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
TransactionTypeListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
TransactionTypeListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
TransactionTypeListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
TransactionTypeListBuilder::getTargetBundles	protected	function	Generates a render array of the applicable bundles.
TransactionTypeListBuilder::getTargetType	protected	function	Gets the target entity type label for the given transaction type.
TransactionTypeListBuilder::getTransactorPlugin	protected	function	Gets the transactor plugin label for the given transaction type.
TransactionTypeListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
TransactionTypeListBuilder::__construct	public	function	Constructs a new TransactionTypeListBuilder object. Overrides EntityListBuilder::__construct

You are here

class TransactionTypeListBuilder in Transaction 8

Hierarchy

File

Namespace

Members

API Navigation