Skip to Content
Account
Enter the email address on your account.
Forgot Your Username?
Enter your password.
Forgot Your Password?

Or continue with

Developer

RouterModalCategoryField

2 Min Read
On This Page

RouterModalCategoryField is a delegating field that creates and proxies a different underlying Joomla form field depending on the active sef_router component setting:

  • modern router — delegates to Joomla\Component\Categories\Administrator\Field\Modal\CategoryField (the Joomla Categories modal picker with create/edit/clear buttons).
  • legacy router — delegates to Joomla\CMS\Form\Field\CategoryField with multiple = true and the joomla.form.field.list-fancy-select layout.

Class Details

PropertyValue
ClassRouterModalCategoryField
NamespaceJ2Commerce\Component\J2commerce\Administrator\Field
Fileadministrator/components/com_j2commerce/src/Field/RouterModalCategoryField.php
ExtendsJoomla\CMS\Form\FormField
Field type stringRouterModalCategory
Since6.0.8

Architecture

graph TD
    A[RouterModalCategoryField::setup] --> B{"isLegacyMode?"}
    B -- No / modern --> C[createModalCategoryField]
    B -- Yes / legacy --> D[createMultiSelectCategoryField]
    C --> E[Modal\CategoryField delegate]
    D --> F[CategoryField multi-select delegate]
    E --> G[getInput / getLabel proxied]
    F --> G
legacy router — delegates to Joomla\CMS\Form\Field\CategoryField with multiple = true and the joomla.form.field.list-fancy-select layout.

The delegate field is stored in $this->delegateField. Both getInput() and getLabel() proxy to $this->delegateField->__get('input') and ->__get('label') respectively.

Dependency Injection for Delegated Fields

Joomla's Form::loadField() normally injects database and user dependencies into field instances. Because delegate fields are created manually (bypassing Form::loadField()), RouterModalCategoryField::injectFieldDependencies() performs this injection explicitly:

protected function injectFieldDependencies(FormField $field): void
{
    if ($field instanceof DatabaseAwareInterface) {
        $field->setDatabase($this->getDatabase());
    }

    if ($field instanceof CurrentUserInterface) {
        $field->setCurrentUser($this->getCurrentUser());
    }
}

Value Migration (Legacy → Modern)

When switching from legacy (array of category IDs) to modern (single ID), the field automatically converts the stored array value to a scalar by taking reset($value):

if (is_array($value)) {
    $value = !empty($value) ? (string) reset($value) : '';
}

XML Usage

<form addfieldprefix="J2Commerce\Component\J2commerce\Administrator\Field">
    <fieldset name="basic">
        <field
            name="catid"
            type="RouterModalCategory"
            label="JGLOBAL_CHOOSE_CATEGORY_LABEL"
            extension="com_content"
            required="false"
        />
    </fieldset>
</form>

XML Attributes

AttributeRequiredDescription
nameYesField name. Single string in modern mode; submitted as name[] in legacy mode.
typeYesMust be RouterModalCategory.
labelNoLanguage key forwarded to the delegate field. Defaults to JGLOBAL_CHOOSE_CATEGORY_LABEL.
extensionNoCategory extension filter. Defaults to com_content.
requiredNoForwarded to the delegate field.

The multiple attribute is always set by the field itself and must not be specified in XML.

Delegate Field Attributes (Modern Mode)

The modal_category delegate is created with select="true", new="true", edit="true", clear="true" — giving the admin the full modal create/edit/clear experience.

Router Mode Detection

protected function isLegacyMode(): bool
{
    $params    = ComponentHelper::getParams('com_j2commerce');
    $sefRouter = $params->get('sef_router', 'modern');

    return $sefRouter === 'legacy';
}

Still stuck? Our team can help.

Back to Top