class TaxRateListBuilder in Ubercart 8.4

Provides a listing of uc_tax_rate configuration entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
      • class \Drupal\uc_tax\Controller\TaxRateListBuilder

File

uc_tax/src/Controller/TaxRateListBuilder.php, line 12

Namespace

Drupal\uc_tax\Controller

class TaxRateListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Name');
    $header['rate'] = $this
      ->t('Rate');
    $header['shippable'] = $this
      ->t('Taxed products');
    $header['product_types'] = $this
      ->t('Taxed product types');
    $header['line_item_types'] = $this
      ->t('Taxed line items');
    $header['weight'] = $this
      ->t('Weight');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->getLabel();
    $row['rate'] = (double) $entity
      ->getRate() * 100 . '%';
    $row['shippable'] = $entity
      ->isForShippable() ? $this
      ->t('Shippable products') : $this
      ->t('Any product');
    $row['product_types'] = implode(', ', $entity
      ->getProductTypes());
    $row['line_item_types'] = implode(', ', $entity
      ->getLineItemTypes());
    $row['weight'] = $entity
      ->getWeight();

    //    $row['weight'] = [
    //      '#type' => 'weight',
    //      '#default_value' => $entity->getWeight(),
    //      '#attributes' => ['class' => ['uc-tax-method-weight']],
    //    ];

    //$row['weight']['#attributes'] = ['class' => ['uc-quote-method-weight']];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function buildOperations(EntityInterface $entity) {
    $build = parent::buildOperations($entity);
    $build['#links']['clone'] = [
      'title' => $this
        ->t('Clone'),
      'url' => Url::fromRoute('entity.uc_tax_rate.clone', [
        'uc_tax_rate' => $entity
          ->id(),
      ]),
      'weight' => 10,
    ];
    uasort($build['#links'], 'Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build['description'] = [
      '#markup' => $this
        ->t("<p>This is a list of the tax rates currently defined on your Drupal site.</p><p>You may use the 'Add a tax rate' button to add a new rate, or use the widget in the 'Operations' column to edit, delete, or clone existing tax rates.</p>"),
    ];
    $build += parent::render();
    $build['table']['#empty'] = $this
      ->t('No tax rates have been configured yet.');
    $build['table']['#tabledrag'] = [
      [
        'action' => 'order',
        'relationship' => 'sibling',
        'group' => 'uc-tax-method-weight',
      ],
    ];
    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::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	20
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.
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.
TaxRateListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
TaxRateListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity. Overrides EntityListBuilder::buildOperations
TaxRateListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
TaxRateListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render