Release of v3.0.0

componentbuilderexportcompiler.xml

@@ -1,13 +1,14 @@
 <?xml version="1.0" encoding="utf-8"?>
 <extension type="plugin" version="5.0" group="extension" method="upgrade">
 	<name>PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER</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\Extension\ComponentbuilderExportCompiler</namespace>
 	<description>PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION</description>
 
 	<!-- Scripts to run on installation -->
@@ -15,18 +16,19 @@
 
 	<!-- Language files -->
 	<languages folder="language">
-		<language tag="en-GB">en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini</language>
-		<language tag="en-GB">en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini</language>
+		<language tag="en-GB">en-GB/plg_extension_componentbuilderexportcompiler.ini</language>
+		<language tag="en-GB">en-GB/plg_extension_componentbuilderexportcompiler.sys.ini</language>
 	</languages>
 
 	<!-- Plugin files -->
 	<files>
-		<filename plugin="componentbuilderexportcompiler">componentbuilderexportcompiler.php</filename>
+		<folder plugin="componentbuilderexportcompiler">services</folder>
 		<filename>index.html</filename>
-		<folder>language</folder>
+		<folder>services</folder>
+		<folder>src</folder>
 	</files>
 
-	<!-- Config parameter -->
+	<!-- Config parameters -->
 	<config
 			addruleprefix="VDM\Component\Componentbuilder\Administrator\Rule"
 			addfieldprefix="VDM\Component\Componentbuilder\Administrator\Field">

language/en-GB/plg_extension_componentbuilderexportcompiler.ini

@@ -1,6 +1,6 @@
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER="Extension - Componentbuilder Export Compiler"
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_DESCRIPTION="This plugin is used to tweak the export options for your components during compilation. To activate it you must first enable it here. Then open your JCB component global options, and under the Global tab, select this plugin in the Activate Compiler Plugins field.Also be sure to activate the component/s that should be targeted with this added export feature under the Component Activation tab."
-PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Export Compiler (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to tweak the export options for your components during compilation. To activate it you must first enable it here. Then open your JCB component global options, and under the Global tab, select this plugin in the Activate Compiler Plugins field.Also be sure to activate the component/s that should be targeted with this added export feature under the Component Activation tab.</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_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Export Compiler (v.3.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to tweak the export options for your components during compilation. To activate it you must first enable it here. Then open your JCB component global options, and under the Global tab, select this plugin in the Activate Compiler Plugins field.Also be sure to activate the component/s that should be targeted with this added export feature under the Component Activation tab.</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_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_SETTINGS="Settings"
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_ACTIVATE_OPTION_LABEL="Activate Options"
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_ACTIVATE_OPTION_DESCRIPTION="You can select the kind of activation control you would like to use. <b>All</b> will target all components, and <b>Selected</b> will let you select only those you want to be active."

language/en-GB/plg_extension_componentbuilderexportcompiler.sys.ini

@@ -1,6 +1,6 @@
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER="Extension - Componentbuilder Export Compiler"
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_DESCRIPTION="This plugin is used to tweak the export options for your components during compilation. To activate it you must first enable it here. Then open your JCB component global options, and under the Global tab, select this plugin in the Activate Compiler Plugins field.Also be sure to activate the component/s that should be targeted with this added export feature under the Component Activation tab."
-PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Export Compiler (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to tweak the export options for your components during compilation. To activate it you must first enable it here. Then open your JCB component global options, and under the Global tab, select this plugin in the Activate Compiler Plugins field.Also be sure to activate the component/s that should be targeted with this added export feature under the Component Activation tab.</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_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Export Compiler (v.3.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to tweak the export options for your components during compilation. To activate it you must first enable it here. Then open your JCB component global options, and under the Global tab, select this plugin in the Activate Compiler Plugins field.Also be sure to activate the component/s that should be targeted with this added export feature under the Component Activation tab.</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_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_SETTINGS="Settings"
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_ACTIVATE_OPTION_LABEL="Activate Options"
 PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_ACTIVATE_OPTION_DESCRIPTION="You can select the kind of activation control you would like to use. <b>All</b> will target all components, and <b>Selected</b> will let you select only those you want to be active."

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;
 
 /**
  * Extension - Componentbuilder Export Compiler script file.
  *
- * @package PlgExtensionComponentbuilderExportCompiler
+ * @package ComponentbuilderExportCompiler
  */
 class plgExtensionComponentbuilderExportCompilerInstallerScript
 {
+	/**
+	 * 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/extension/componentbuilderexportcompiler/componentbuilderexportcompiler.php'))
+		{
+			$this->deleteFiles[] = '/plugins/extension/componentbuilderexportcompiler/componentbuilderexportcompiler.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/index.html

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

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\Extension\ComponentbuilderExportCompiler\Extension\ComponentbuilderExportCompiler;
+
+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 ComponentbuilderExportCompiler(
+					$container->get(DispatcherInterface::class),
+					(array) PluginHelper::getPlugin('extension', 'componentbuilderexportcompiler')
+				);
+				$plugin->setApplication(Factory::getApplication());
+
+				return $plugin;
+			}
+		);
+	}
+};

src/Extension/ComponentbuilderExportCompiler.php

@@ -8,9 +8,7 @@
  * @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\Extension\ComponentbuilderExportCompiler\Extension;
 
 use Joomla\CMS\Application\CMSApplication;
 use Joomla\CMS\Plugin\CMSPlugin;
@@ -18,22 +16,19 @@ use VDM\Joomla\Componentbuilder\Compiler\Factory;
 use VDM\Joomla\Utilities\ArrayHelper;
 use VDM\Joomla\Componentbuilder\Compiler\Utilities\Indent;
 use VDM\Joomla\Componentbuilder\Compiler\Utilities\Line;
+use Joomla\Event\SubscriberInterface;
+
+// No direct access to this file
+defined('_JEXEC') or die('Restricted access');
+
 /**
  * Extension - Componentbuilder Export Compiler plugin.
  *
  * @package   ComponentbuilderExportCompiler
- * @since     2.0.0
+ * @since     3.0.0
  */
-class PlgExtensionComponentbuilderExportCompiler extends CMSPlugin
+final class ComponentbuilderExportCompiler extends CMSPlugin implements SubscriberInterface
 {
-	/**
-	 * Application object
-	 *
-	 * @var    CMSApplication
-	 * @since  1.0.0
-	 */
-	protected  $app;
-
 	/**
 	 * Affects constructor behavior. If true, language files will be loaded automatically.
 	 *
@@ -251,4 +246,21 @@ class PlgExtensionComponentbuilderExportCompiler extends CMSPlugin
 		return false;
 	}
 
+
+	/**
+	 * Returns an array of events this subscriber will listen to.
+	 *
+	 * @return  array
+	 *
+	 * @since   5.0.0
+	 */
+	public static function getSubscribedEvents(): array
+	{
+		return [
+			'jcb_ce_onAfterGetComponentData' => 'jcb_ce_onAfterGetComponentData',
+			'jcb_ce_onAfterModelComponentData' => 'jcb_ce_onAfterModelComponentData',
+			'jcb_ce_onBeforeSetLangFileData' => 'jcb_ce_onBeforeSetLangFileData',
+			'jcb_ce_onBeforeSetConfigFieldsets' => 'jcb_ce_onBeforeSetConfigFieldsets'
+		];
+	}
 }

src/Extension/index.html

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