class TaxRateFormBase in Ubercart 8.4

Defines the tax rate add/edit form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
  - class \Drupal\uc_tax\Form\TaxRateFormBase

Expanded class hierarchy of TaxRateFormBase

File

uc_tax/src/Form/TaxRateFormBase.php, line 13

Namespace

Drupal\uc_tax\Form

View source

class TaxRateFormBase extends EntityForm {

  /**
   * Returns a Url to redirect to if the current operation is cancelled.
   *
   * @return \Drupal\Core\Url
   *   Destination Url for a cancelled operation.
   */
  public function getCancelUrl() {
    return Url::fromRoute('entity.uc_tax_rate.collection');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $rate = $this->entity;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#description' => $this
        ->t('This name will appear to the customer when this tax is applied to an order.'),
      '#default_value' => $rate
        ->label(),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#title' => $this
        ->t('Machine name'),
      '#default_value' => $rate
        ->id(),
      '#maxlength' => 32,
      '#machine_name' => [
        'exists' => [
          $this,
          'exists',
        ],
        'replace_pattern' => '([^a-z0-9_]+)|(^custom$)',
        'error' => 'The machine-readable name must be unique, and can only contain lowercase letters, numbers, and underscores. Additionally, it can not be the reserved word "custom".',
      ],
    ];
    $form['rate'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Rate'),
      '#description' => $this
        ->t('The tax rate as a percent or decimal. Examples: 6%, .06'),
      '#size' => 15,
      '#default_value' => (double) $rate
        ->getRate() * 100.0 . '%',
      '#required' => TRUE,
    ];
    $form['shippable'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Taxed products'),
      '#options' => [
        0 => $this
          ->t('Apply tax to any product regardless of its shippability.'),
        1 => $this
          ->t('Apply tax to shippable products only.'),
      ],
      '#default_value' => (int) $rate
        ->isForShippable(),
    ];

    // @todo Remove the need for a special case for product kit module.
    $options = [];
    foreach (node_type_get_names() as $type => $name) {
      if ($type != 'product_kit' && uc_product_is_product($type)) {
        $options[$type] = $name;
      }
    }
    $options['blank-line'] = $this
      ->t('"Blank line" product');
    $form['product_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Taxed product types'),
      '#description' => $this
        ->t('Apply taxes to the specified product types/classes.'),
      '#default_value' => $rate
        ->getProductTypes(),
      '#options' => $options,
    ];
    $options = [];
    $definitions = \Drupal::service('plugin.manager.uc_order.line_item')
      ->getDefinitions();
    foreach ($definitions as $id => $line_item) {
      if (!in_array($id, [
        'subtotal',
        'tax_subtotal',
        'total',
        'tax_display',
      ])) {
        $options[$id] = $line_item['title'];
      }
    }
    $form['line_item_types'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Taxed line items'),
      '#description' => $this
        ->t('Adds the checked line item types to the total before applying this tax.'),
      '#default_value' => $rate
        ->getLineItemTypes(),
      '#options' => $options,
    ];
    $form['weight'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Weight'),
      '#description' => $this
        ->t('Taxes are sorted by weight and then applied to the order sequentially. This value is important when taxes need to include other tax line items.'),
      '#default_value' => $rate
        ->getWeight(),
    ];
    $form['display_include'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include this tax when displaying product prices.'),
      '#default_value' => $rate
        ->isIncludedInPrice(),
    ];
    $form['inclusion_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Tax inclusion text'),
      '#description' => $this
        ->t('This text will be displayed near the price to indicate that it includes tax.'),
      '#default_value' => $rate
        ->getInclusionText(),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array $form, FormStateInterface $form_state) {
    parent::validate($form, $form_state);
    $rate = $form_state
      ->getValue('rate');
    $rate = trim($rate);

    // @todo Would be nice to better validate rate, maybe with preg_match
    if (floatval($rate) < 0) {
      $form_state
        ->setErrorByName('rate', $this
        ->t('Rate must be a positive number. No commas and only one decimal point.'));
    }

    // Save trimmed rate back to form if it passes validation.
    $form_state
      ->setValue('rate', $rate);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $tax_rate = $this
      ->getEntity();

    // Save rate.
    $rate = $form_state
      ->getValue('rate');
    if (substr($rate, -1) == '%') {

      // Rate given in percentage, so convert it to a fraction for storage.
      $tax_rate
        ->setRate(floatval($rate) / 100.0);
    }

    // Save machine names of product types and line item types.
    $tax_rate
      ->setProductTypes(array_filter($form_state
      ->getValue('product_types')));
    $tax_rate
      ->setLineItemTypes(array_filter($form_state
      ->getValue('line_item_types')));

    // @todo When Rules is working in D8 ..
    // Update the name of the associated conditions.
    // $conditions = rules_config_load('uc_tax_' . $form_state->getValue('id'));
    // if ($conditions) {
    //   $conditions->label = $form_state->getValue('name');
    //   $conditions->save();
    // }
    $status = $tax_rate
      ->save();

    // Create an edit link.
    $edit_link = Link::fromTextAndUrl($this
      ->t('Edit'), $tax_rate
      ->toUrl())
      ->toString();
    if ($status == SAVED_UPDATED) {

      // If we edited an existing entity...
      $this
        ->messenger()
        ->addMessage($this
        ->t('Tax rate %label has been updated.', [
        '%label' => $tax_rate
          ->label(),
      ]));
      $this
        ->logger('uc_tax')
        ->notice('Tax rate %label has been updated.', [
        '%label' => $tax_rate
          ->label(),
        'link' => $edit_link,
      ]);
    }
    else {

      // If we created a new entity...
      $this
        ->messenger()
        ->addMessage($this
        ->t('Tax rate %label has been added.', [
        '%label' => $tax_rate
          ->label(),
      ]));
      $this
        ->logger('uc_tax')
        ->notice('Tax rate %label has been added.', [
        '%label' => $tax_rate
          ->label(),
        'link' => $edit_link,
      ]);
    }

    // Redirect the user back to the listing route after the save operation.
    $form_state
      ->setRedirect('entity.uc_tax_rate.collection');
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);

    // Change the submit button text.
    $actions['submit']['#value'] = $this
      ->t('Save');
    $actions['submit']['#suffix'] = Link::fromTextAndUrl($this
      ->t('Cancel'), $this
      ->getCancelUrl())
      ->toString();
    return $actions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityForm::$entity	protected	property	The entity being used by this form.	7
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::$privateEntityManager	private	property	The entity manager.
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity	2
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties	7
EntityForm::form	public	function	Gets the actual form array to be built.	30
EntityForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId	5
EntityForm::getEntity	public	function	Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	1
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	10
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager	public	function	Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm	public	function	This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm	17
EntityForm::__get	public	function
EntityForm::__set	public	function
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
TaxRateFormBase::actions	protected	function	Returns an array of supported actions for the current entity form. Overrides EntityForm::actions	2
TaxRateFormBase::buildForm	public	function	Form constructor. Overrides EntityForm::buildForm	1
TaxRateFormBase::getCancelUrl	public	function	Returns a Url to redirect to if the current operation is cancelled.
TaxRateFormBase::save	public	function	Form submission handler for the 'save' action. Overrides EntityForm::save
TaxRateFormBase::validate	public	function
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.

You are here

class TaxRateFormBase in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation