diff --git a/componentbuilderexportcompiler.xml b/componentbuilderexportcompiler.xml index 7e1bb11..992a036 100644 --- a/componentbuilderexportcompiler.xml +++ b/componentbuilderexportcompiler.xml @@ -1,13 +1,14 @@ PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER - 27th July, 2024 + 14th August, 2024 Llewellyn van der Merwe joomla@vdm.io https://dev.vdm.io Copyright (C) 2015 Vast Development Method. All rights reserved. GNU General Public License version 2 or later; see LICENSE.txt - 2.0.0 + 3.0.0 + VDM\Plugin\Extension\ComponentbuilderExportCompiler PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION @@ -15,18 +16,19 @@ - en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini - en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini + en-GB/plg_extension_componentbuilderexportcompiler.ini + en-GB/plg_extension_componentbuilderexportcompiler.sys.ini - componentbuilderexportcompiler.php + services index.html - language + services + src - + diff --git a/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini b/language/en-GB/plg_extension_componentbuilderexportcompiler.ini similarity index 97% rename from language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini rename to language/en-GB/plg_extension_componentbuilderexportcompiler.ini index 6988449..c1d7b9e 100644 --- a/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini +++ b/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="

Extension - Componentbuilder Export Compiler (v.2.0.0)

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.

Created by Llewellyn van der Merwe
Development started 10th March, 2024

" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION="

Extension - Componentbuilder Export Compiler (v.3.0.0)

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.

Created by Llewellyn van der Merwe
Development started 10th March, 2024

" 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. All will target all components, and Selected will let you select only those you want to be active." diff --git a/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini b/language/en-GB/plg_extension_componentbuilderexportcompiler.sys.ini similarity index 97% rename from language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini rename to language/en-GB/plg_extension_componentbuilderexportcompiler.sys.ini index 6988449..c1d7b9e 100644 --- a/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini +++ b/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="

Extension - Componentbuilder Export Compiler (v.2.0.0)

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.

Created by Llewellyn van der Merwe
Development started 10th March, 2024

" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION="

Extension - Componentbuilder Export Compiler (v.3.0.0)

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.

Created by Llewellyn van der Merwe
Development started 10th March, 2024

" 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. All will target all components, and Selected will let you select only those you want to be active." diff --git a/script.php b/script.php index 66d8a04..e72efeb 100644 --- a/script.php +++ b/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) . '
'; + } + } + } + + 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) . '
'; + } + } + } + } } diff --git a/services/index.html b/services/index.html new file mode 100644 index 0000000..fa6d84e --- /dev/null +++ b/services/index.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/services/provider.php b/services/provider.php new file mode 100644 index 0000000..f997303 --- /dev/null +++ b/services/provider.php @@ -0,0 +1,47 @@ + + * @git 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; + } + ); + } +}; diff --git a/componentbuilderexportcompiler.php b/src/Extension/ComponentbuilderExportCompiler.php similarity index 91% rename from componentbuilderexportcompiler.php rename to src/Extension/ComponentbuilderExportCompiler.php index 27653d6..3844ece 100644 --- a/componentbuilderexportcompiler.php +++ b/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' + ]; + } } diff --git a/src/Extension/index.html b/src/Extension/index.html new file mode 100644 index 0000000..fa6d84e --- /dev/null +++ b/src/Extension/index.html @@ -0,0 +1 @@ + \ No newline at end of file