Release of v3.0.0

componentbuilderfieldorderingtabs.xml

@@ -1,13 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <extension type="plugin" version="5.0" group="content" method="upgrade">
 	<name>PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS</name>
-	<creationDate>27th July, 2024</creationDate>
+	<creationDate>14th August, 2024</creationDate>
 	<author>Llewellyn van der Merwe</author>
 	<authorEmail>joomla@vdm.io</authorEmail>
 	<authorUrl>https://dev.vdm.io</authorUrl>
 	<copyright>Copyright (C) 2015 Vast Development Method. All rights reserved.</copyright>
 	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
-	<version>2.0.0</version>
+	<version>3.0.0</version>
+	<namespace path="src">VDM\Plugin\Content\ComponentbuilderFieldOrderingTabs</namespace>
 	<description>PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_XML_DESCRIPTION</description>
 
 	<!-- Scripts to run on installation -->
@@ -15,17 +16,16 @@
 
 	<!-- Language files -->
 	<languages folder="language">
-		<language tag="en-GB">en-GB/en-GB.plg_content_componentbuilderfieldorderingtabs.ini</language>
-		<language tag="en-GB">en-GB/en-GB.plg_content_componentbuilderfieldorderingtabs.sys.ini</language>
+		<language tag="en-GB">en-GB/plg_content_componentbuilderfieldorderingtabs.ini</language>
+		<language tag="en-GB">en-GB/plg_content_componentbuilderfieldorderingtabs.sys.ini</language>
 	</languages>
 
 	<!-- Plugin files -->
 	<files>
-		<filename plugin="componentbuilderfieldorderingtabs">componentbuilderfieldorderingtabs.php</filename>
+		<folder plugin="componentbuilderfieldorderingtabs">services</folder>
 		<filename>index.html</filename>
-		<folder>language</folder>
-		<folder>fields</folder>
 		<folder>forms</folder>
-		<folder>rules</folder>
+		<folder>services</folder>
+		<folder>src</folder>
 	</files>
 </extension>

forms/admin_view.xml

@@ -4,8 +4,8 @@
 	<fields name="params">
 	<!-- default paths of fieldordering fieldset points to the plugin -->
 	<fieldset name="fieldordering" label="PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_FIELD_ORDERING"
-		addrulepath="/plugins/content/componentbuilderfieldorderingtabs/rules"
-		addfieldpath="/plugins/content/componentbuilderfieldorderingtabs/fields"
+		addrulepath="VDM\Plugin\Content\componentbuilderfieldorderingtabs\Rule"
+		addfieldpath="VDM\Plugin\Content\componentbuilderfieldorderingtabs\Field"
 	>
 	<fields name="fieldordering">
 		<!-- Add_admin_ordering Field. Type: Radio. (joomla) -->

language/en-GB/plg_content_componentbuilderfieldorderingtabs.ini

@@ -1,6 +1,6 @@
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS="Content - Componentbuilder Field Ordering Tabs"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_DESCRIPTION="This plugin is used to set custom ordering to fields in the JCB list views."
-PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Field Ordering Tabs (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to set custom ordering to fields in the JCB list views.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 10th March, 2024</small></p>"
+PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Field Ordering Tabs (v.3.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to set custom ordering to fields in the JCB list views.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 10th March, 2024</small></p>"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_FIELD_ORDERING="Field Ordering"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_ADD_ADMIN_ORDERING_LABEL="Add Admin List View Ordering"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_ADD_ADMIN_ORDERING_DESCRIPTION="Select the ordering behavior, default is by id, and custom lets you select."

language/en-GB/plg_content_componentbuilderfieldorderingtabs.sys.ini

@@ -1,6 +1,6 @@
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS="Content - Componentbuilder Field Ordering Tabs"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_DESCRIPTION="This plugin is used to set custom ordering to fields in the JCB list views."
-PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Field Ordering Tabs (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to set custom ordering to fields in the JCB list views.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 10th March, 2024</small></p>"
+PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Field Ordering Tabs (v.3.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to set custom ordering to fields in the JCB list views.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 10th March, 2024</small></p>"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_FIELD_ORDERING="Field Ordering"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_ADD_ADMIN_ORDERING_LABEL="Add Admin List View Ordering"
 PLG_CONTENT_COMPONENTBUILDERFIELDORDERINGTABS_ADD_ADMIN_ORDERING_DESCRIPTION="Select the ordering behavior, default is by id, and custom lets you select."

script.php

@@ -13,15 +13,129 @@
 defined('_JEXEC') or die('Restricted access');
 
 use Joomla\CMS\Factory;
+use Joomla\CMS\Version;
+use Joomla\CMS\Installer\InstallerAdapter;
 use Joomla\CMS\Language\Text;
-use Joomla\CMS\Filesystem\File;
-use Joomla\CMS\Filesystem\Folder;
+use Joomla\Filesystem\File;
+use Joomla\Filesystem\Folder;
 
 /**
  * Content - Componentbuilder Field Ordering Tabs script file.
  *
- * @package PlgContentComponentbuilderFieldOrderingTabs
+ * @package ComponentbuilderFieldOrderingTabs
  */
 class plgContentComponentbuilderFieldOrderingTabsInstallerScript
 {
+	/**
+	 * The CMS Application.
+	 *
+	 * @since  4.4.2
+	 */
+	protected $app;
+
+	/**
+	 * A list of files to be deleted
+	 *
+	 * @var    array
+	 * @since  3.6
+	 */
+	protected array $deleteFiles = [];
+
+	/**
+	 * A list of folders to be deleted
+	 *
+	 * @var    array
+	 * @since  3.6
+	 */
+	protected array $deleteFolders = [];
+
+	/**
+	 * Constructor
+	 *
+	 * @param   InstallerAdapter  $adapter  The object responsible for running this script
+	 */
+	public function __construct($adapter)
+	{
+		// get application
+		$this->app = Factory::getApplication();
+
+		if (is_file(JPATH_ROOT . '/plugins/content/componentbuilderfieldorderingtabs/componentbuilderfieldorderingtabs.php'))
+		{
+			$this->deleteFiles[] = '/plugins/content/componentbuilderfieldorderingtabs/componentbuilderfieldorderingtabs.php';
+		}
+	}
+
+	/**
+	 * Called before any type of action
+	 *
+	 * @param   string  $route  Which action is happening (install|uninstall|discover_install|update)
+	 * @param   InstallerAdapter  $adapter  The object responsible for running this script
+	 *
+	 * @return  boolean  True on success
+	 */
+	public function preflight($route, $adapter)
+	{
+		// set application to local method var, just use $this->app in future [we will drop $app in J6]
+		$app = $this->app;
+
+		// the default for both install and update
+		$jversion = new Version();
+		if (!$jversion->isCompatible('5.0.0'))
+		{
+			$app->enqueueMessage('Please upgrade to at least Joomla! 5.0.0 before continuing!', 'error');
+			return false;
+		}
+
+		// remove old files and folders
+		$this->removeFiles();
+
+		return true;
+	}
+
+	/**
+	 * Called before any type of action
+	 *
+	 * @param   string  $route  Which action is happening (install|uninstall|discover_install|update)
+	 * @param   InstallerAdapter  $adapter  The object responsible for running this script
+	 *
+	 * @return  boolean  True on success
+	 */
+	public function postflight($route, $adapter)
+	{
+		// set application to local method var, just use $this->app in future [we will drop $app in J6]
+		$app = $this->app;
+
+		return true;
+	}
+
+	/**
+	 * Remove the files and folders in the given array from
+	 *
+	 * @return  void
+	 * @since   5.0.2
+	 */
+	protected function removeFiles()
+	{
+		if (!empty($this->deleteFiles))
+		{
+			foreach ($this->deleteFiles as $file)
+			{
+				if (is_file(JPATH_ROOT . $file) && !File::delete(JPATH_ROOT . $file))
+				{
+					echo Text::sprintf('JLIB_INSTALLER_ERROR_FILE_FOLDER', $file) . '<br>';
+				}
+			}
+		}
+
+		if (!empty($this->deleteFolders))
+		{
+			foreach ($this->deleteFolders as $folder)
+			{
+				if (is_dir(JPATH_ROOT . $folder) && !Folder::delete(JPATH_ROOT . $folder))
+				{
+					echo Text::sprintf('JLIB_INSTALLER_ERROR_FILE_FOLDER', $folder) . '<br>';
+				}
+			}
+		}
+	}
 }

services/provider.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * @package    Joomla.Component.Builder
+ *
+ * @created    30th April, 2015
+ * @author     Llewellyn van der Merwe <https://dev.vdm.io>
+ * @git        Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
+ * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+// No direct access to this file
+defined('_JEXEC') or die('Restricted access');
+
+use Joomla\CMS\Factory;
+use Joomla\CMS\Plugin\PluginHelper;
+use Joomla\CMS\Extension\PluginInterface;
+use Joomla\Event\DispatcherInterface;
+use Joomla\DI\ServiceProviderInterface;
+use Joomla\DI\Container;
+use VDM\Plugin\Content\ComponentbuilderFieldOrderingTabs\Extension\ComponentbuilderFieldOrderingTabs;
+
+return new class () implements ServiceProviderInterface {
+	/**
+	* Registers the service provider with a DI container.
+	*
+	* @param   Container  $container  The DI container.
+	*
+	* @return  void
+	* @since   4.3.0
+	*/
+	public function register(Container $container)
+	{
+		$container->set(
+			PluginInterface::class,
+			function (Container $container) {
+				$plugin = new ComponentbuilderFieldOrderingTabs(
+					$container->get(DispatcherInterface::class),
+					(array) PluginHelper::getPlugin('content', 'componentbuilderfieldorderingtabs')
+				);
+				$plugin->setApplication(Factory::getApplication());
+
+				return $plugin;
+			}
+		);
+	}
+};

src/Extension/ComponentbuilderFieldOrderingTabs.php

@@ -8,20 +8,21 @@
  * @copyright  Copyright (C) 2015 Vast Development Method. All rights reserved.
  * @license    GNU General Public License version 2 or later; see LICENSE.txt
  */
-
-// No direct access to this file
-defined('_JEXEC') or die('Restricted access');
+namespace VDM\Plugin\Content\ComponentbuilderFieldOrderingTabs\Extension;
 
 use Joomla\CMS\Form\Form;
 use Joomla\CMS\Plugin\CMSPlugin;
 
+// No direct access to this file
+defined('_JEXEC') or die('Restricted access');
+
 /**
  * Content - Componentbuilder Field Ordering Tabs plugin.
  *
  * @package   ComponentbuilderFieldOrderingTabs
- * @since     2.0.0
+ * @since     3.0.0
  */
-class PlgContentComponentbuilderFieldOrderingTabs extends CMSPlugin
+final class ComponentbuilderFieldOrderingTabs extends CMSPlugin
 {
 	/**
 	 * Affects constructor behaviour. If true, language files will be loaded automatically.
@@ -49,7 +50,7 @@ class PlgContentComponentbuilderFieldOrderingTabs extends CMSPlugin
 		if (strpos($context, 'com_componentbuilder.admin_view') === 0)
 		{
 			// Add the forms path
-			Form::addFormPath(__DIR__ . '/forms');
+			Form::addFormPath(__DIR__ . '/../../forms');
 			// add the admin view params for privacy integration
 			$form->loadFile('admin_view');
 		}

src/Field/index.html

@@ -0,0 +1 @@
+<html><body bgcolor="#FFFFFF"></body></html>

src/Rule/index.html

@@ -0,0 +1 @@
+<html><body bgcolor="#FFFFFF"></body></html>