You are here

Home » API reference » Ubercart 8.4 » TaxRateListBuilder.php

class TaxRateListBuilder in Ubercart 8.4

Same name in this branch
  1. 8.4 uc_tax/src/TaxRateListBuilder.php \Drupal\uc_tax\TaxRateListBuilder
  2. 8.4 uc_tax/src/Controller/TaxRateListBuilder.php \Drupal\uc_tax\Controller\TaxRateListBuilder

Provides a listing of tax rate entities.

Hierarchy

Expanded class hierarchy of TaxRateListBuilder

File

uc_tax/src/TaxRateListBuilder.php, line 17

Namespace

Drupal\uc_tax
View source 
class TaxRateListBuilder extends DraggableListBuilder {

  /**
   * The tax rate plugin manager.
   *
   * @var \Drupal\uc_tax\Plugin\TaxRatePluginManager
   */
  protected $taxRatePluginManager;

  /**
   * Constructs a new TaxRateListBuilder 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_tax\Plugin\TaxRatePluginManager $tax_rate_plugin_manager
   *   The tax rate plugin manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, TaxRatePluginManager $tax_rate_plugin_manager) {
    parent::__construct($entity_type, $storage);
    $this->taxRatePluginManager = $tax_rate_plugin_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_tax.rate'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = [
      'data' => $this
        ->t('Name'),
    ];
    $header['description'] = [
      'data' => $this
        ->t('Description'),
    ];
    $header['shippable'] = [
      'data' => $this
        ->t('Taxed products'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['product_types'] = [
      'data' => $this
        ->t('Taxed product types'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['line_item_types'] = [
      'data' => $this
        ->t('Taxed line items'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['status'] = [
      'data' => $this
        ->t('Status'),
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $plugin = $entity
      ->getPlugin();
    $row['label'] = $entity
      ->label();
    $row['description']['#markup'] = $plugin
      ->getSummary();
    $row['shippable']['#markup'] = $entity
      ->isForShippable() ? $this
      ->t('Shippable products') : $this
      ->t('Any product');
    $row['product_types']['#markup'] = implode(', ', $entity
      ->getProductTypes());
    $row['line_item_types']['#markup'] = implode(', ', $entity
      ->getLineItemTypes());
    $row['status']['#markup'] = $entity
      ->status() ? $this
      ->t('Enabled') : $this
      ->t('Disabled');
    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 buildForm(array $form, FormStateInterface $form_state) {
    $options = array_map(function ($definition) {
      return $definition['label'];
    }, $this->taxRatePluginManager
      ->getDefinitions());
    uasort($options, 'strnatcasecmp');
    $form['add'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Add a tax rate'),
      '#open' => TRUE,
      '#attributes' => [
        'class' => [
          'container-inline',
        ],
      ],
    ];
    $form['add']['plugin'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Type'),
      '#empty_option' => $this
        ->t('- Choose -'),
      '#options' => $options,
    ];
    $form['add']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add tax rate'),
      '#validate' => [
        '::validateAddMethod',
      ],
      '#submit' => [
        '::submitAddMethod',
      ],
      '#limit_validation_errors' => [
        [
          'plugin',
        ],
      ],
    ];
    $form = parent::buildForm($form, $form_state);
    $form[$this->entitiesKey]['#empty'] = $this
      ->t('No tax rates have been configured yet.');
    $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 rate.
   */
  public function validateAddMethod(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->isValueEmpty('plugin')) {
      $form_state
        ->setErrorByName('plugin', $this
        ->t('You must select a tax rate type.'));
    }
  }

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

  /**
   * {@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 tax rate' button to add a new rate, or use the widget in the 'Operations' column to edit, delete, enable/disable, or clone existing tax rates. Rates that are disabled will not be applied at checkout and will not be included in product prices.</p><p>Taxes are sorted by weight and then applied to the order sequentially. This order is important when taxes need to be applied to other tax line items. 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::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
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::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.
TaxRateListBuilder::$taxRatePluginManager protected property The tax rate plugin manager.
TaxRateListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
TaxRateListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::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 DraggableListBuilder::buildRow
TaxRateListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
TaxRateListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
TaxRateListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides DraggableListBuilder::render
TaxRateListBuilder::submitAddMethod public function Form submission handler for adding a new method.
TaxRateListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm
TaxRateListBuilder::validateAddMethod public function Form validation handler for adding a new rate.
TaxRateListBuilder::__construct public function Constructs a new TaxRateListBuilder object. Overrides DraggableListBuilder::__construct