Add handle to Tax Rate

Add clear function to TaxEvent to fetch tax rate in event
Tax interface tidy
Adjust package version

Author: Mesuva

controller.php

@@ -27,7 +27,7 @@ class Controller extends Package implements ProviderAggregateInterface
 {
     protected $pkgHandle = 'community_store';
     protected $appVersionRequired = '8.5';
-    protected $pkgVersion = '2.7.5';
+    protected $pkgVersion = '2.7.6-alpha1';
 
     protected $npmPackages = [
         'sysend' => '1.3.4',

controllers/single_page/dashboard/store/settings/tax.php

@@ -65,7 +65,6 @@ public function add_rate()
     {
         $data = $this->request->request->all();
         $errors = $this->validate($data);
-        $this->error = null; //clear errors
         $this->error = $errors;
         if (!$errors->has()) {
             TaxRate::add($data);
@@ -83,7 +82,6 @@ public function add_rate()
             if ($this->request->request->get('taxRateID')) {
                 $this->edit($this->request->request->get('taxRateID'));
             } else {
-                //first we send the data to the shipping method type.
                 $this->add();
             }
         }
@@ -95,14 +93,24 @@ public function validate($data)
         $e = $this->app->make('helper/validation/error');
 
         if ("" == $data['taxLabel']) {
-            $e->add(t("You need a label for this Tax Rate"));
+            $e->add(t("Tax Rate Label required"));
+        }
+
+        if ("" == $data['taxHandle']) {
+            $e->add(t("Tax Rate Handle required"));
+        } else {
+            $vs = $this->app->make('helper/validation/strings');
+            if (!$vs->handle($data['taxHandle'])) {
+                $e->add(t('A valid handle must contain no punctuation or spaces.'));
+            }
         }
+        
         if ("" != $data['taxRate']) {
             if (!is_numeric($data['taxRate'])) {
                 $e->add(t("Tax Rate must be a number"));
             }
         } else {
-            $e->add(t("You need to enter a tax rate"));
+            $e->add(t("Tax Rate required"));;
         }
 
         return $e;

single_pages/dashboard/store/settings/tax.php

@@ -23,7 +23,7 @@
             <div class="row">
                         <div class="col-md-12 col-sm-4">
                             <div class="form-group">
-                                <?= $form->label('taxEnabled', t('Enable Tax Rate')); ?>
+                                <?= $form->label('taxEnabled', t('Enable')); ?>
                                 <?= $form->select('taxEnabled', [false => t('No'), true => t('Yes')], $taxRate->isEnabled()); ?>
                             </div>
                         </div>
@@ -33,6 +33,12 @@
                                 <?= $form->text('taxLabel', $taxRate->getTaxLabel()); ?>
                             </div>
                         </div>
+                        <div class="col-md-12 col-sm-4">
+                            <div class="form-group">
+                                <?= $form->label('taxHandle', t('Handle')); ?>
+                                <?= $form->text('taxHandle', $taxRate->getTaxHandle()); ?>
+                            </div>
+                        </div>
                         <div class="col-md-12 col-sm-4">
                             <div class="form-group">
                                 <?= $form->label('taxRate', t('Tax Rate %')); ?>
@@ -151,7 +157,7 @@
 
 <div class="dashboard-tax-rates">
 
-	<table class="table table-striped">
+	<table class="table table-striped mb-5">
         <thead>
             <tr>
                 <th><?= t("Tax Class"); ?></th>
@@ -171,7 +177,7 @@
                                 $taxClassRates = $tc->getTaxClassRates();
                 if ($taxClassRates) {
                     foreach ($taxClassRates as $taxRate) {
-                        echo '<span class="label label-primary">' . $taxRate->getTaxLabel() . '</span> ';
+                        echo '<span class="badge bg-primary text-white label label-primary">' . e($taxRate->getTaxLabel()) . '</span> ';
                     }
                 } else {
                     ?>
@@ -199,6 +205,7 @@
 		<thead>
 			<tr>
                 <th><?= t("Tax Rate"); ?></th>
+                <th><?= t("Handle"); ?></th>
                 <th><?= t("Rate"); ?></th>
                 <th><?= t("Enabled"); ?></th>
                 <th><?= t('Applies To'); ?></th>
@@ -211,7 +218,8 @@
 		        <?php foreach ($taxRates as $tr) {
                 ?>
         			<tr>
-        				<td><?= $tr->getTaxLabel(); ?></td>
+        				<td><?= e($tr->getTaxLabel()); ?></td>
+                        <td><span class="badge bg-light text-dark"><?= e($tr->getTaxHandle()); ?></span></td>
                         <td><?= $tr->getTaxRate(); ?>%</td>
                         <td><?= ($tr->isEnabled() ? t('Yes') : t('No')); ?></td>
                         <?php

src/CommunityStore/Tax/TaxEvent.php

@@ -29,4 +29,14 @@ public function getUpdatedLabel()
         return($this->updatedLabel);
     }
 
-}
+    public function getTaxRate()
+    {
+        return $this->subject;
+    }
+
+    public function setTaxRate($rate)
+    {
+        $this->subject = $rate;
+    }
+
+}

src/CommunityStore/Tax/TaxRate.php

@@ -35,6 +35,11 @@ class TaxRate
      */
     protected $taxLabel;
 
+    /**
+     * @ORM\Column(type="string", nullable=true)
+     */
+    protected $taxHandle;
+
     /**
      * @ORM\Column(type="float")
      */
@@ -80,6 +85,12 @@ public function setTaxLabel($label)
         $this->taxLabel = $label;
     }
 
+    public function setTaxHandle($handle)
+    {
+        $this->taxHandle = $handle;
+    }
+
+
     public function setTaxRate($rate)
     {
         $this->taxRate = $rate;
@@ -141,6 +152,10 @@ public function getTaxLabel()
         return $this->taxLabel;
     }
 
+    public function getTaxHandle() {
+        return $this->taxHandle;
+    }
+
     public function getTaxRate()
     {
         return $this->taxRate;
@@ -365,6 +380,10 @@ public static function add($data)
         $tr->setTaxBasedOn($data['taxBased']);
         $tr->setTaxAddress($data['taxAddress']);
 
+        if (isset($data['taxHandle'])) {
+            $tr->setTaxHandle($data['taxHandle']);
+        }
+
         if (!isset($data['taxCountry'])) {
             $data['taxCountry'] = [];
         }