[5.3] Form control fields, new API

administrator/components/com_categories/src/View/Categories/HtmlView.php

@@ -136,20 +136,30 @@ public function display($tpl = null)
             }
         } else {
             // In article associations modal we need to remove language filter if forcing a language.
-            if ($forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'CMD')) {
+            $forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'CMD');
+
+            if ($forcedLanguage) {
                 // If the language is forced we can't allow to select the language, so transform the language selector filter into a hidden field.
                 $languageXml = new \SimpleXMLElement('<field name="language" type="hidden" default="' . $forcedLanguage . '" />');
                 $this->filterForm->setField($languageXml, 'filter', true);
 
                 // Also, unset the active language filter so the search tools is not open by default with this filter.
                 unset($this->activeFilters['language']);
             }
+
+            $this->filterForm->addControlField('forcedLanguage', $forcedLanguage);
         }
 
         // If filter by category is active we need to know the extension name to filter the categories
         $extensionName = $this->escape($this->state->get('filter.extension'));
         $this->filterForm->setFieldAttribute('category_id', 'extension', $extensionName, 'filter');
 
+        // Add form control fields
+        $this->filterForm
+            ->addControlField('extension', $this->state->get('filter.extension', ''))
+            ->addControlField('task', '')
+            ->addControlField('boxchecked', '0');
+
         parent::display($tpl);
     }
 

administrator/components/com_categories/src/View/Category/HtmlView.php

@@ -108,10 +108,13 @@ public function display($tpl = null)
             $this->checkTags = true;
         }
 
-        Factory::getApplication()->getInput()->set('hidemainmenu', true);
+        $input          = Factory::getApplication()->getInput();
+        $forcedLanguage = $input->get('forcedLanguage', '', 'cmd');
+
+        $input->set('hidemainmenu', true);
 
         // If we are forcing a language in modal (used for associations).
-        if ($this->getLayout() === 'modal' && $forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'cmd')) {
+        if ($this->getLayout() === 'modal' && $forcedLanguage) {
             // Set the language field to the forcedLanguage and disable changing it.
             $this->form->setValue('language', null, $forcedLanguage);
             $this->form->setFieldAttribute('language', 'readonly', 'true');
@@ -123,6 +126,12 @@ public function display($tpl = null)
             $this->form->setFieldAttribute('tags', 'language', '*,' . $forcedLanguage);
         }
 
+        // Add form control fields
+        $this->form
+            ->addControlField('task', '')
+            ->addControlField('return', $input->getBase64('return', ''))
+            ->addControlField('forcedLanguage', $forcedLanguage);
+
         if ($this->getLayout() !== 'modal') {
             $this->addToolbar();
         } else {

administrator/components/com_categories/tmpl/categories/default.php

@@ -282,10 +282,7 @@
                     <?php endif; ?>
                 <?php endif; ?>
 
-                <input type="hidden" name="extension" value="<?php echo $extension; ?>">
-                <input type="hidden" name="task" value="">
-                <input type="hidden" name="boxchecked" value="0">
-                <?php echo HTMLHelper::_('form.token'); ?>
+                <?php echo $this->filterForm->renderControlFields(); ?>
             </div>
         </div>
     </div>

administrator/components/com_categories/tmpl/categories/modal.php

@@ -143,11 +143,7 @@
 
         <?php endif; ?>
 
-        <input type="hidden" name="extension" value="<?php echo $extension; ?>">
-        <input type="hidden" name="task" value="">
-        <input type="hidden" name="boxchecked" value="0">
-        <input type="hidden" name="forcedLanguage" value="<?php echo $app->getInput()->get('forcedLanguage', '', 'CMD'); ?>">
-        <?php echo HTMLHelper::_('form.token'); ?>
+        <?php echo $this->filterForm->renderControlFields(); ?>
 
     </form>
 </div>

administrator/components/com_categories/tmpl/category/edit.php

@@ -123,9 +123,6 @@
         <?php echo HTMLHelper::_('uitab.endTabSet'); ?>
 
         <?php echo $this->form->getInput('extension'); ?>
-        <input type="hidden" name="task" value="">
-        <input type="hidden" name="return" value="<?php echo $input->getBase64('return'); ?>">
-        <input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>">
-        <?php echo HTMLHelper::_('form.token'); ?>
+        <?php echo $this->form->renderControlFields(); ?>
     </div>
 </form>

administrator/components/com_content/src/View/Article/HtmlView.php

@@ -104,8 +104,11 @@ public function display($tpl = null)
             throw new GenericDataException(implode("\n", $errors), 500);
         }
 
+        $input          = Factory::getApplication()->getInput();
+        $forcedLanguage = $input->get('forcedLanguage', '', 'cmd');
+
         // If we are forcing a language in modal (used for associations).
-        if ($this->getLayout() === 'modal' && $forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'cmd')) {
+        if ($this->getLayout() === 'modal' && $forcedLanguage) {
             // Set the language field to the forcedLanguage and disable changing it.
             $this->form->setValue('language', null, $forcedLanguage);
             $this->form->setFieldAttribute('language', 'readonly', 'true');
@@ -117,6 +120,12 @@ public function display($tpl = null)
             $this->form->setFieldAttribute('tags', 'language', '*,' . $forcedLanguage);
         }
 
+        // Add form control fields
+        $this->form
+            ->addControlField('task', '')
+            ->addControlField('return', $input->getBase64('return', ''))
+            ->addControlField('forcedLanguage', $forcedLanguage);
+
         if ($this->getLayout() !== 'modal') {
             $this->addToolbar();
         } else {

administrator/components/com_content/src/View/Articles/HtmlView.php

@@ -144,7 +144,9 @@ public function display($tpl = null)
         } else {
             // In article associations modal we need to remove language filter if forcing a language.
             // We also need to change the category filter to show show categories with All or the forced language.
-            if ($forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'CMD')) {
+            $forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'CMD');
+
+            if ($forcedLanguage) {
                 // If the language is forced we can't allow to select the language, so transform the language selector filter into a hidden field.
                 $languageXml = new \SimpleXMLElement('<field name="language" type="hidden" default="' . $forcedLanguage . '" />');
                 $this->filterForm->setField($languageXml, 'filter', true);
@@ -155,8 +157,15 @@ public function display($tpl = null)
                 // One last changes needed is to change the category filter to just show categories with All language or with the forced language.
                 $this->filterForm->setFieldAttribute('category_id', 'language', '*,' . $forcedLanguage, 'filter');
             }
+
+            $this->filterForm->addControlField('forcedLanguage', $forcedLanguage);
         }
 
+        // Add form control fields
+        $this->filterForm
+            ->addControlField('task', '')
+            ->addControlField('boxchecked', '0');
+
         parent::display($tpl);
     }
 

administrator/components/com_content/tmpl/article/edit.php

@@ -179,9 +179,6 @@
             <div class="hidden"><?php echo $hidden_fields; ?></div>
         <?php endif; ?>
 
-        <input type="hidden" name="task" value="">
-        <input type="hidden" name="return" value="<?php echo $input->getBase64('return'); ?>">
-        <input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>">
-        <?php echo HTMLHelper::_('form.token'); ?>
+        <?php echo $this->form->renderControlFields(); ?>
     </div>
 </form>

administrator/components/com_content/tmpl/articles/default.php

@@ -65,6 +65,8 @@
 
     $workflow_state    = Factory::getApplication()->bootComponent('com_content')->isFunctionalityUsed('core.state', 'com_content.article');
     $workflow_featured = Factory::getApplication()->bootComponent('com_content')->isFunctionalityUsed('core.featured', 'com_content.article');
+
+    $this->filterForm->addControlField('transition_id', '');
 endif;
 
 $assoc = Associations::isEnabled();
@@ -389,13 +391,7 @@
                     <?php endif; ?>
                 <?php endif; ?>
 
-                <?php if ($workflow_enabled) : ?>
-                <input type="hidden" name="transition_id" value="">
-                <?php endif; ?>
-
-                <input type="hidden" name="task" value="">
-                <input type="hidden" name="boxchecked" value="0">
-                <?php echo HTMLHelper::_('form.token'); ?>
+                <?php echo $this->filterForm->renderControlFields(); ?>
             </div>
         </div>
     </div>

administrator/components/com_content/tmpl/articles/modal.php

@@ -168,10 +168,7 @@
 
         <?php endif; ?>
 
-        <input type="hidden" name="task" value="">
-        <input type="hidden" name="boxchecked" value="0">
-        <input type="hidden" name="forcedLanguage" value="<?php echo $app->getInput()->get('forcedLanguage', '', 'CMD'); ?>">
-        <?php echo HTMLHelper::_('form.token'); ?>
+        <?php echo $this->filterForm->renderControlFields(); ?>
 
     </form>
 </div>

administrator/components/com_menus/src/View/Item/HtmlView.php

@@ -108,8 +108,11 @@ public function display($tpl = null)
             return;
         }
 
+        $input          = Factory::getApplication()->getInput();
+        $forcedLanguage = $input->get('forcedLanguage', '', 'cmd');
+
         // If we are forcing a language in modal (used for associations).
-        if ($this->getLayout() === 'modal' && $forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'cmd')) {
+        if ($this->getLayout() === 'modal' && $forcedLanguage) {
             // Set the language field to the forcedLanguage and disable changing it.
             $this->form->setValue('language', null, $forcedLanguage);
             $this->form->setFieldAttribute('language', 'readonly', 'true');
@@ -118,6 +121,13 @@ public function display($tpl = null)
             $this->form->setFieldAttribute('parent_id', 'language', '*,' . $forcedLanguage);
         }
 
+        // Add form control fields
+        $this->form
+            ->addControlField('task', '')
+            ->addControlField('forcedLanguage', $forcedLanguage)
+            ->addControlField('menutype', $input->get('menutype', ''))
+            ->addControlField('fieldtype', '', ['id' => 'fieldtype']);
+
         if ($this->getLayout() !== 'modal') {
             $this->addToolbar();
         } else {

administrator/components/com_menus/src/View/Items/HtmlView.php

@@ -266,16 +266,25 @@ public function display($tpl = null)
             }
         } else {
             // In menu associations modal we need to remove language filter if forcing a language.
-            if ($forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'CMD')) {
+            $forcedLanguage = Factory::getApplication()->getInput()->get('forcedLanguage', '', 'CMD');
+
+            if ($forcedLanguage) {
                 // If the language is forced we can't allow to select the language, so transform the language selector filter into a hidden field.
                 $languageXml = new \SimpleXMLElement('<field name="language" type="hidden" default="' . $forcedLanguage . '" />');
                 $this->filterForm->setField($languageXml, 'filter', true);
 
                 // Also, unset the active language filter so the search tools is not open by default with this filter.
                 unset($this->activeFilters['language']);
             }
+
+            $this->filterForm->addControlField('forcedLanguage', $forcedLanguage);
         }
 
+        // Add form control fields
+        $this->filterForm
+            ->addControlField('task', '')
+            ->addControlField('boxchecked', '0');
+
         // Allow a system plugin to insert dynamic menu types to the list shown in menus:
         $this->getDispatcher()->dispatch('onBeforeRenderMenuItems', new BeforeRenderMenuItemsViewEvent('onBeforeRenderMenuItems', [
             'subject' => $this,

administrator/components/com_menus/src/View/Menu/HtmlView.php

@@ -79,6 +79,9 @@ public function display($tpl = null)
             throw new GenericDataException(implode("\n", $errors), 500);
         }
 
+        // Add form control fields
+        $this->form->addControlField('task', '');
+
         parent::display($tpl);
         $this->addToolbar();
     }

administrator/components/com_menus/tmpl/item/edit.php

@@ -170,10 +170,6 @@
         <?php echo HTMLHelper::_('uitab.endTabSet'); ?>
     </div>
 
-    <input type="hidden" name="task" value="">
-    <input type="hidden" name="forcedLanguage" value="<?php echo $input->get('forcedLanguage', '', 'cmd'); ?>">
-    <input type="hidden" name="menutype" value="<?php echo $input->get('menutype', '', 'cmd'); ?>">
     <?php echo $this->form->getInput('component_id'); ?>
-    <?php echo HTMLHelper::_('form.token'); ?>
-    <input type="hidden" id="fieldtype" name="fieldtype" value="">
+    <?php echo $this->form->renderControlFields(); ?>
 </form>

administrator/components/com_menus/tmpl/items/default.php

@@ -275,9 +275,7 @@
                     <?php endif; ?>
                 <?php endif; ?>
 
-                <input type="hidden" name="task" value="">
-                <input type="hidden" name="boxchecked" value="0">
-                <?php echo HTMLHelper::_('form.token'); ?>
+                <?php echo $this->filterForm->renderControlFields(); ?>
             </div>
         </div>
     </div>

administrator/components/com_menus/tmpl/menu/edit.php

@@ -66,7 +66,6 @@
             <?php endif; ?>
 
         <?php echo HTMLHelper::_('uitab.endTabSet'); ?>
-        <input type="hidden" name="task" value="">
-        <?php echo HTMLHelper::_('form.token'); ?>
+        <?php echo $this->form->renderControlFields(); ?>
     </div>
 </form>

components/com_content/src/View/Form/HtmlView.php

@@ -192,6 +192,11 @@ public function display($tpl = null)
             $this->showSaveAsCopy = true;
         }
 
+        // Add form control fields
+        $this->form
+            ->addControlField('task', '')
+            ->addControlField('return', $this->return_page ?? '');
+
         $this->_prepareDocument();
 
         parent::display($tpl);

components/com_content/tmpl/form/edit.php

@@ -151,9 +151,7 @@
 
             <?php echo HTMLHelper::_('uitab.endTabSet'); ?>
 
-            <input type="hidden" name="task" value="">
-            <input type="hidden" name="return" value="<?php echo $this->return_page; ?>">
-            <?php echo HTMLHelper::_('form.token'); ?>
+            <?php echo $this->form->renderControlFields(); ?>
         </fieldset>
         <div class="d-grid gap-2 d-sm-block mb-2">
             <button type="button" class="btn btn-primary" data-submit-task="article.apply">