Skip to main content

TaxprofileField Field Type

TaxprofileField extends Joomla's ListField to render a <select> populated with every enabled tax profile from #__j2commerce_taxprofiles. Tax profiles define which tax rates apply to a product based on geo-zone rules. The stored value is the integer primary key j2commerce_taxprofile_id.

Class Reference​

PropertyValue
ClassTaxprofileField
NamespaceJ2Commerce\Component\J2commerce\Administrator\Field
Fileadministrator/components/com_j2commerce/src/Field/TaxprofileField.php
ExtendsJoomla\CMS\Form\Field\ListField
Field type tokenTaxprofile
Since6.0.7

Database Query​

SELECT j2commerce_taxprofile_id AS value, taxprofile_name AS text
FROM #__j2commerce_taxprofiles
WHERE enabled = 1
ORDER BY taxprofile_name ASC

The stored value is j2commerce_taxprofile_id (integer).

XML Usage​

Basic Usage​

<field
    name="taxprofile_id"
    type="Taxprofile"
    label="COM_MYPLUGIN_FIELD_TAXPROFILE_LABEL"
    description="COM_MYPLUGIN_FIELD_TAXPROFILE_DESC"
/>

With "Not Taxable" Placeholder​

Adding a child <option value=""> is the standard way to represent an untaxed product:

<field
    name="taxprofile_id"
    type="Taxprofile"
    label="COM_MYPLUGIN_FIELD_TAXPROFILE_LABEL">
    <option value="">COM_J2COMMERCE_NOT_TAXABLE</option>
</field>

Supported XML Attributes​

AttributeTypeDescription
namestringForm field name
labelstringLanguage key for the field label
descriptionstringLanguage key for the tooltip
defaultintegerDefault selected tax profile ID
requiredbooleanWhether a value is required
multiplebooleanAllow multi-select
classstringAdditional CSS classes on the <select> element

Usage in Plugin Forms​

<?xml version="1.0" encoding="utf-8"?>
<form addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field">

    <fieldset name="basic">

        <field
            name="taxprofile_id"
            type="Taxprofile"
            label="COM_MYPLUGIN_FIELD_TAXPROFILE_LABEL"
            description="COM_MYPLUGIN_FIELD_TAXPROFILE_DESC">
            <option value="">COM_J2COMMERCE_NOT_TAXABLE</option>
        </field>

    </fieldset>

</form>

In a Plugin Manifest <config> Block​

<config>
    <fields name="params" addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field">
        <fieldset name="basic">
            <field
                name="default_taxprofile_id"
                type="Taxprofile"
                label="COM_MYPLUGIN_DEFAULT_TAXPROFILE_LABEL"
                description="COM_MYPLUGIN_DEFAULT_TAXPROFILE_DESC"
            />
        </fieldset>
    </fields>
</config>

Source Code​

// File: administrator/components/com_j2commerce/src/Field/TaxprofileField.php

declare(strict_types=1);

namespace J2Commerce\Component\J2commerce\Administrator\Field;

use Joomla\CMS\Factory;
use Joomla\CMS\Form\Field\ListField;
use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Language\Text;
use Joomla\Database\DatabaseInterface;

class TaxprofileField extends ListField
{
    protected $type = 'Taxprofile';

    public function getOptions(): array
    {
        $options = parent::getOptions();

        $db    = Factory::getContainer()->get(DatabaseInterface::class);
        $query = $db->getQuery(true)
            ->select([
                $db->quoteName('j2commerce_taxprofile_id', 'value'),
                $db->quoteName('taxprofile_name', 'text')
            ])
            ->from($db->quoteName('#__j2commerce_taxprofiles'))
            ->where($db->quoteName('enabled') . ' = 1')
            ->order($db->quoteName('taxprofile_name') . ' ASC');

        $db->setQuery($query);

        foreach ($db->loadObjectList() as $profile) {
            $options[] = HTMLHelper::_('select.option', $profile->value, $profile->text);
        }

        return $options;
    }
}

Notes​

  • Only tax profiles with enabled = 1 appear. Tax profiles are managed under J2Commerce -> Configuration -> Tax Profiles.
  • To represent a non-taxable product, add a child <option value=""> with a "Not Taxable" language key. An empty string stored in the field means no tax profile is assigned.
  • Tax profiles connect to tax rates through geo-zone rules stored in #__j2commerce_taxrules.