class TaxRateForm in Ubercart 8.4
Builds the form to edit tax rate entities.
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\TaxRateForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of TaxRateForm
File
- uc_tax/
src/ Form/ TaxRateForm.php, line 13
Namespace
Drupal\uc_tax\FormView source
class TaxRateForm extends EntityForm {
/**
* The tax rate entity.
*
* @var \Drupal\uc_tax\TaxRateInterface
*/
protected $entity;
/**
* The tax rate plugin.
*
* @var \Drupal\uc_tax\TaxRatePluginInterface
*/
protected $plugin;
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$this->plugin = $this->entity
->getPlugin();
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$definition = $this->plugin
->getPluginDefinition();
$form['type'] = [
'#type' => 'item',
'#title' => $this
->t('Type'),
'#markup' => $definition['label'],
];
$form['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#maxlength' => 255,
'#default_value' => $this->entity
->label(),
'#description' => $this
->t('The tax rate name shown to the customer at checkout.'),
'#required' => TRUE,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $this->entity
->id(),
'#maxlength' => 32,
'#machine_name' => [
'exists' => '\\Drupal\\uc_tax\\Entity\\TaxRate::load',
],
'#disabled' => !$this->entity
->isNew(),
];
$form['settings'] = $this->plugin
->buildConfigurationForm([], $form_state);
$form['settings']['#tree'] = 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) $this->entity
->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' => $this->entity
->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' => $this->entity
->getLineItemTypes(),
'#options' => $options,
];
$form['display_include'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Include this tax when displaying product prices.'),
'#default_value' => $this->entity
->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' => $this->entity
->getInclusionText(),
];
return parent::form($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
$this->plugin
->validateConfigurationForm($form['settings'], $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
parent::submitForm($form, $form_state);
$this->plugin
->submitConfigurationForm($form['settings'], $form_state);
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
$actions = parent::actions($form, $form_state);
// Modify submit button text.
$actions['submit']['#value'] = $this
->t('Save tax rate');
// Add a cancel link to take us back to the list builder.
$actions['cancel'] = [
'#type' => 'link',
'#title' => $this
->t('Cancel'),
'#url' => Url::fromRoute('entity.uc_tax_rate.collection'),
];
return $actions;
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
// Save machine names of product types and line item types.
$this->entity
->setProductTypes(array_filter($form_state
->getValue('product_types')));
$this->entity
->setLineItemTypes(array_filter($form_state
->getValue('line_item_types')));
$status = $this->entity
->save();
// Create an edit link for the logger message.
$edit_link = Link::fromTextAndUrl($this
->t('Edit'), $this->entity
->toUrl())
->toString();
if ($status == SAVED_UPDATED) {
// If we edited an existing entity.
$this
->messenger()
->addMessage($this
->t('Tax rate %label has been updated.', [
'%label' => $this->entity
->label(),
]));
$this
->logger('uc_tax')
->notice('Tax rate %label has been updated.', [
'%label' => $this->entity
->label(),
'link' => $edit_link,
]);
}
else {
// If we created a new entity.
$this
->messenger()
->addMessage($this
->t('Tax rate %label has been added.', [
'%label' => $this->entity
->label(),
]));
$this
->logger('uc_tax')
->notice('Tax rate %label has been added.', [
'%label' => $this->entity
->label(),
'link' => $edit_link,
]);
}
$form_state
->setRedirectUrl($this->entity
->toUrl('collection'));
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
2 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TaxRateForm:: |
protected | property |
The tax rate entity. Overrides EntityForm:: |
|
TaxRateForm:: |
protected | property | The tax rate plugin. | |
TaxRateForm:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
|
TaxRateForm:: |
public | function |
Form constructor. Overrides EntityForm:: |
|
TaxRateForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
TaxRateForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
TaxRateForm:: |
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 EntityForm:: |
|
TaxRateForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |