You are here

class TaxRateController in Ubercart 8.4

Route controller for tax rates.

Hierarchy

Expanded class hierarchy of TaxRateController

File

uc_tax/src/Controller/TaxRateController.php, line 11

Namespace

Drupal\uc_tax\Controller
View source
class TaxRateController extends ControllerBase {

  /**
   * Build the tax rate add form.
   *
   * @param string $plugin_id
   *   The plugin ID for the tax rate.
   *
   * @return array
   *   The tax rate edit form.
   */
  public function addForm($plugin_id) {

    // Create a tax rate configuration entity.
    $entity = $this
      ->entityTypeManager()
      ->getStorage('uc_tax_rate')
      ->create([
      'plugin' => $plugin_id,
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($entity);
  }

  /**
   * Clones a tax rate.
   *
   * @param \Drupal\uc_tax\TaxRateInterface $uc_tax_rate
   *   The tax rate entity.
   */
  public function saveClone(TaxRateInterface $uc_tax_rate) {
    $name = $uc_tax_rate
      ->label();

    // Tweak the name and unset the rate ID.
    $cloned_rate = $uc_tax_rate
      ->createDuplicate();
    $cloned_rate
      ->setLabel($this
      ->t('Copy of @name', [
      '@name' => $name,
    ]));

    // @todo Have to check for uniqueness of name first - in case we have
    // cloned this rate before ...
    $cloned_rate
      ->setId($uc_tax_rate
      ->id() . "_clone");

    // Save the new rate without clearing the Rules cache.
    $cloned_rate
      ->save();

    // Clone the associated conditions as well.
    // if ($conditions = rules_config_load('uc_tax_' . $uc_tax_rate->id())) {
    //   $conditions->id = NULL;
    //   $conditions->name = '';
    //   $conditions->save('uc_tax_' . $uc_tax_rate->id());
    // }
    // entity_flush_caches();
    // Display a message and redirect back to the methods page.
    $this
      ->messenger()
      ->addMessage($this
      ->t('Tax rate %name was cloned.', [
      '%name' => $name,
    ]));
    return $this
      ->redirect('entity.uc_tax_rate.collection');
  }

  /**
   * Performs an operation on the tax rate entity.
   *
   * @param \Drupal\uc_tax\TaxRateInterface $uc_tax_rate
   *   The tax rate entity.
   * @param string $op
   *   The operation to perform, usually 'enable' or 'disable'.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect back to the tax rate listing page.
   */
  public function performOperation(TaxRateInterface $uc_tax_rate, $op) {
    $uc_tax_rate
      ->{$op}()
      ->save();
    if ($op == 'enable') {
      $this
        ->messenger()
        ->addMessage($this
        ->t('The %label tax rate has been enabled.', [
        '%label' => $uc_tax_rate
          ->label(),
      ]));
    }
    elseif ($op == 'disable') {
      $this
        ->messenger()
        ->addMessage($this
        ->t('The %label tax rate has been disabled.', [
        '%label' => $uc_tax_rate
          ->label(),
      ]));
    }
    $url = $uc_tax_rate
      ->toUrl('collection');
    return $this
      ->redirect($url
      ->getRouteName(), $url
      ->getRouteParameters(), $url
      ->getOptions());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
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.
TaxRateController::addForm public function Build the tax rate add form.
TaxRateController::performOperation public function Performs an operation on the tax rate entity.
TaxRateController::saveClone public function Clones a tax rate.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.