class TransactionOperationListBuilder in Transaction 8

Provides a entity list page for transaction operations.

View source

class TransactionOperationListBuilder extends ConfigEntityListBuilder {

  /**
   * The ID of the transaction type to which the listed operations belongs.
   *
   * @var string
   */
  protected $transactionTypeId;

  /**
   * 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 string $transaction_type_id
   *   The transaction type ID that operations belongs to.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, $transaction_type_id) {
    parent::__construct($entity_type, $storage);
    $this->transactionTypeId = $transaction_type_id;
  }

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

    // Get the transaction type id from request or route options.
    if ($transaction_type = $container
      ->get('request_stack')
      ->getCurrentRequest()
      ->get('transaction_type')) {
      $transaction_type_id = is_string($transaction_type) ? $transaction_type : $transaction_type
        ->id();
    }
    else {
      $route_options = $container
        ->get('current_route_match')
        ->getRouteObject()
        ->getOptions();
      $transaction_type_id = isset($route_options['_transaction_transaction_type_id']) ? $route_options['_transaction_transaction_type_id'] : '';
    }
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $transaction_type_id);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $query = $this
      ->getStorage()
      ->getQuery()
      ->condition('transaction_type', $this->transactionTypeId)
      ->sort('id');

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('ID');
    $header['label'] = $this
      ->t('Name');
    $header['description'] = [
      'data' => $this
        ->t('Description template'),
      'class' => [
        RESPONSIVE_PRIORITY_MEDIUM,
      ],
    ];
    $header['details'] = [
      'data' => $this
        ->t('Detail templates'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\transaction\TransactionOperationInterface $entity */
    $row = [];
    $row['id'] = [
      'data' => $entity
        ->id(),
    ];
    $row['label'] = [
      'data' => $entity
        ->label(),
      'class' => [
        'menu-label',
      ],
    ];
    $row['description'] = [
      'data' => !empty($description = $entity
        ->getDescription()) ? Unicode::truncate($description, 80, TRUE, TRUE) : $this
        ->notAvailableValue(),
    ];
    $row['details'] = [
      'data' => !empty($details = $entity
        ->getDetails()) ? $this
        ->formatPlural(count($details), '@count line', '@count lines') : $this
        ->notAvailableValue(),
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * Builds a non-available column value.
   *
   * @return array
   *   Markup array with a 'n/a' value.
   */
  protected function notAvailableValue() {
    return [
      '#markup' => '<em>' . $this
        ->t('n/a') . '</em>',
      '#allowed_tags' => [
        'em',
      ],
    ];
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
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::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.
TransactionOperationListBuilder::$transactionTypeId	protected	property	The ID of the transaction type to which the listed operations belongs.
TransactionOperationListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
TransactionOperationListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
TransactionOperationListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
TransactionOperationListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
TransactionOperationListBuilder::notAvailableValue	protected	function	Builds a non-available column value.
TransactionOperationListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
TransactionOperationListBuilder::__construct	public	function	Constructs a new TransactionTypeListBuilder object. Overrides EntityListBuilder::__construct

You are here

class TransactionOperationListBuilder in Transaction 8

Hierarchy

File

Namespace

Members

API Navigation