Release of v3.0.0

componentbuilderlanguagepackaging.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_COMPONENTBUILDERLANGUAGEPACKAGING</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\ComponentbuilderLanguagePackaging</namespace>
 	<description>PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING_XML_DESCRIPTION</description>
 
 	<!-- Scripts to run on installation -->
@@ -15,14 +16,17 @@
 
 	<!-- Language files -->
 	<languages folder="language">
-		<language tag="en-GB">en-GB/en-GB.plg_extension_componentbuilderlanguagepackaging.ini</language>
-		<language tag="en-GB">en-GB/en-GB.plg_extension_componentbuilderlanguagepackaging.sys.ini</language>
+		<language tag="en-GB">en-GB/plg_extension_componentbuilderlanguagepackaging.ini</language>
+		<language tag="en-GB">en-GB/plg_extension_componentbuilderlanguagepackaging.sys.ini</language>
+		<language tag="af-ZA">af-ZA/plg_extension_componentbuilderlanguagepackaging.ini</language>
+		<language tag="af-ZA">af-ZA/plg_extension_componentbuilderlanguagepackaging.sys.ini</language>
 	</languages>
 
 	<!-- Plugin files -->
 	<files>
-		<filename plugin="componentbuilderlanguagepackaging">componentbuilderlanguagepackaging.php</filename>
+		<folder plugin="componentbuilderlanguagepackaging">services</folder>
 		<filename>index.html</filename>
-		<folder>language</folder>
+		<folder>services</folder>
+		<folder>src</folder>
 	</files>
 </extension>

language/af-ZA/plg_extension_componentbuilderlanguagepackaging.ini

@@ -0,0 +1,2 @@
+PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_YES="Ja"
+PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_NO="Nee"

language/af-ZA/plg_extension_componentbuilderlanguagepackaging.sys.ini

@@ -0,0 +1,2 @@
+PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_YES="Ja"
+PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_NO="Nee"

language/en-GB/plg_extension_componentbuilderlanguagepackaging.ini

@@ -1,3 +1,3 @@
 PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING="Extension - Componentbuilder Language Packaging"
 PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING_DESCRIPTION="This plugin is used to add language packaging to JCB. 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."
-PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING_XML_DESCRIPTION="<h1>Extension - Componentbuilder Language Packaging (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to add language packaging to JCB. 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.</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_COMPONENTBUILDERLANGUAGEPACKAGING_XML_DESCRIPTION="<h1>Extension - Componentbuilder Language Packaging (v.3.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to add language packaging to JCB. 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.</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>"

language/en-GB/plg_extension_componentbuilderlanguagepackaging.sys.ini

@@ -1,3 +1,3 @@
 PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING="Extension - Componentbuilder Language Packaging"
 PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING_DESCRIPTION="This plugin is used to add language packaging to JCB. 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."
-PLG_EXTENSION_COMPONENTBUILDERLANGUAGEPACKAGING_XML_DESCRIPTION="<h1>Extension - Componentbuilder Language Packaging (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to add language packaging to JCB. 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.</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_COMPONENTBUILDERLANGUAGEPACKAGING_XML_DESCRIPTION="<h1>Extension - Componentbuilder Language Packaging (v.3.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to add language packaging to JCB. 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.</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>"

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 Language Packaging script file.
  *
- * @package PlgExtensionComponentbuilderLanguagePackaging
+ * @package ComponentbuilderLanguagePackaging
  */
 class plgExtensionComponentbuilderLanguagePackagingInstallerScript
 {
+	/**
+	 * 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/componentbuilderlanguagepackaging/componentbuilderlanguagepackaging.php'))
+		{
+			$this->deleteFiles[] = '/plugins/extension/componentbuilderlanguagepackaging/componentbuilderlanguagepackaging.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,48 @@
+<?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\ComponentbuilderLanguagePackaging\Extension\ComponentbuilderLanguagePackaging;
+use Joomla\Database\DatabaseInterface;
+
+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 ComponentbuilderLanguagePackaging(
+					$container->get(DispatcherInterface::class),
+					(array) PluginHelper::getPlugin('extension', 'componentbuilderlanguagepackaging')
+				);
+				$plugin->setApplication(Factory::getApplication());
+				$plugin->setDatabase($container->get(DatabaseInterface::class));
+				return $plugin;
+			}
+		);
+	}
+};

src/Extension/ComponentbuilderLanguagePackaging.php

@@ -8,13 +8,12 @@
  * @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\ComponentbuilderLanguagePackaging\Extension;
 
 use Joomla\CMS\Application\CMSApplication;
 use Joomla\CMS\Plugin\CMSPlugin;
-use Joomla\CMS\Filesystem\Folder;
+use Joomla\CMS\Filesystem\Folder;
+use Joomla\Database\DatabaseAwareTrait;
 use VDM\Joomla\Utilities\JsonHelper;
 use VDM\Joomla\Utilities\ArrayHelper;
 use VDM\Joomla\Componentbuilder\Compiler\Factory;
@@ -23,39 +22,29 @@ use VDM\Joomla\Utilities\FileHelper;
 use VDM\Joomla\Componentbuilder\Compiler\Utilities\Indent;
 use VDM\Joomla\Componentbuilder\Compiler\Utilities\Placefix;
 use VDM\Joomla\Utilities\GetHelper;
-use VDM\Joomla\Utilities\MathHelper;
+use Joomla\Event\SubscriberInterface;
+
+// No direct access to this file
+defined('_JEXEC') or die('Restricted access');
+
 /**
  * Extension - Componentbuilder Language Packaging plugin.
  *
  * @package   ComponentbuilderLanguagePackaging
- * @since     2.0.0
+ * @since     3.0.0
  */
-class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
+final class ComponentbuilderLanguagePackaging extends CMSPlugin implements SubscriberInterface
 {
+	use DatabaseAwareTrait;
+
 	/**
-	 * Affects constructor behavior. If true, language files will be loaded automatically.
+	 * Affects constructor behaviour. If true, language files will be loaded automatically.
 	 *
 	 * @var    boolean
 	 * @since  1.0.0
 	 */
 	protected  $autoloadLanguage = true;
 
-	/**
-	 * Database object
-	 *
-	 * @var    DatabaseDriver
-	 * @since  1.0.0
-	 */
-	protected  $db;
-
-	/**
-	 * Application object
-	 *
-	 * @var    CMSApplication
-	 * @since  1.0.0
-	 */
-	protected  $app;
-
 	/**
 	 * The percentage before a language can be added
 	 * 
@@ -300,7 +289,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 	 *
 	 * @since   1.0
 	 */
-	public function jcb_ce_onBeforeBuildPluginLangFiles(&$plugin, &$languages)
+	public function jcb_ce_onBeforeBuildPluginLangFiles(&$plugin)
 	{
 		// get component id
 		$id = (int) Factory::_('Config')->component_id;
@@ -310,7 +299,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 			// set file name
 			$file_name = 'plg_' . strtolower($plugin->group) . '_' . strtolower($plugin->code_name);
 			// extrude the languages that should not remain in the plugin
-			$this->extrudeLanguages($id, $languages, Factory::_('Config')->lang_tag, $file_name, 'admin');
+			$this->extrudeLanguages($id, 'plugins', Factory::_('Config')->lang_tag, $file_name, 'admin');
 		}
 	}
 
@@ -321,7 +310,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 	 *
 	 * @since   1.0
 	 */
-	public function jcb_ce_onBeforeBuildModuleLangFiles(&$module, &$languages)
+	public function jcb_ce_onBeforeBuildModuleLangFiles(&$module)
 	{
 		// get component id
 		$id = (int) Factory::_('Config')->component_id;
@@ -329,7 +318,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 		if (ArrayHelper::check($this->activeComponents) && isset($this->activeComponents[$id]))
 		{
 			// extrude the languages that should not remain in the module
-			$this->extrudeLanguages($id, $languages, Factory::_('Config')->lang_tag, $module->file_name, $module->target_client);
+			$this->extrudeLanguages($id, 'modules', Factory::_('Config')->lang_tag, $module->file_name, $module->target_client);
 		}
 	}
 
@@ -340,7 +329,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 	 *
 	 * @since   1.0
 	 */
-	public function jcb_ce_onBeforeBuildAllLangFiles(&$languages)
+	public function jcb_ce_onBeforeBuildAllLangFiles($targetArea)
 	{
 		// get component id
 		$id = (int) Factory::_('Config')->component_id;
@@ -350,7 +339,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 			// set file name
 			$file_name = 'com_' . $this->activeComponentsNames[$id];
 			// extrude the languages that should not remain in the module
-			$this->extrudeLanguages($id, $languages, Factory::_('Config')->lang_tag, $file_name);
+			$this->extrudeLanguages($id, $targetArea, Factory::_('Config')->lang_tag, $file_name);
 		}
 		// build the language packages
 		$this->buildLanguages($id, Factory::_('Config')->lang_tag);
@@ -363,7 +352,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 	 *
 	 * @since   1.0
 	 */
-	protected function extrudeLanguages(&$id, &$languages, $langTag, &$file_name, $target_client = 'both')
+	protected function extrudeLanguages(&$id, $targetArea, $langTag, &$file_name, $target_client = 'both')
 	{
 		$mainLangLoader = [];
 		// check if this id was set before
@@ -378,14 +367,14 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 			$this->languages[$id][$file_name] = [];
 		}
 		// set all the extra languages not excluded
-		foreach ($languages as $key => $language)
+		foreach (CFactory::_('Compiler.Builder.Languages')->get($targetArea) as $key => $language)
 		{
 			if ($key !== $langTag && ArrayHelper::check($language) && (!isset($this->excludedLang[$id]) || !in_array($key, $this->excludedLang[$id])))
 			{
 				// add to our bucket
 				$this->languages[$id][$file_name][$key] = $language;
 				// remove from the JCB build
-				unset($languages[$key]);
+				CFactory::_('Compiler.Builder.Languages')->remove("{$targetArea}.{$key}");
 			}
 			// count the area strings
 			if ($langTag === $key)
@@ -462,7 +451,7 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 							// get the file name
 							$fileName = $this->getLanguageFileName($file_name, $tag, $area);
 							// check if language should be added
-							if ($this->shouldLanguageBeAdded($tag, $languageStrings, $mainLangLoader[$area], $fileName) && ($actions = $this->getLangActions($file_name, $tag, $area, $target_client)) !== false)
+							if (Factory::_('Language.Translation')->check($tag, $languageStrings, $mainLangLoader[$area], $fileName) && ($actions = $this->getLangActions($file_name, $tag, $area, $target_client)) !== false)
 							{
 								// set the language data
 								$lang = array_map(
@@ -676,51 +665,32 @@ class PlgExtensionComponentbuilderLanguagePackaging extends CMSPlugin
 	 * check if a translation should be added
 	 * 
 	 * @return  bool
-	 * 
+	 * @deprecated 3.4 Use Factory::_('Language.Translation')->check(...);
 	 */
 	protected function shouldLanguageBeAdded(&$tag, &$languageStrings, &$total, &$file_name)
 	{
 		// only log messages for none $this->langTag translations
-		if ($this->langTag !== $tag)
-		{
-			$langStringNr  = count($languageStrings);
-			$langStringSum = MathHelper::bc(
-				'mul', $langStringNr, 100
-			);
-			$percentage    = MathHelper::bc(
-				'div', $langStringSum, $total
-			);
-			$stringNAme    = ($langStringNr == 1) ? '(string '
-				. $tag . ' translated)'
-				: '(strings ' . $tag . ' translated)';
-
-			// force load if debug lines are added
-			if (!$this->debugLinenr)
-			{
-				// check if we should install this translation
-				if ($percentage < $this->percentageLanguageAdd)
-				{
-					// dont add
-					Factory::_('Compiler.Builder.Language.Messages')->set("exclude.$file_name",
-						'<b>' . $total . '</b>(total '
-						. $this->langTag . ' strings) only <b>'
-						. $langStringNr . '</b>' . $stringNAme
-						. ' = ' . $percentage
-					);
-
-					return false;
-				}
-			}
-
-			// show if it was added as well
-			Factory::_('Compiler.Builder.Language.Messages')->set("include.$file_name",
-				'<b>' . $total . '</b>(total '
-				. $this->langTag . ' strings) and <b>'
-				. $langStringNr . '</b>' . $stringNAme . ' = '
-				. $percentage
-			);
-		}
-
-		return true;
+		Factory::_('Language.Translation')->check(
+			$tag, $languageStrings, $total, $file_name
+		);
+	}
+
+	/**
+	 * Returns an array of events this subscriber will listen to.
+	 *
+	 * @return  array
+	 *
+	 * @since   5.0.0
+	 */
+	public static function getSubscribedEvents(): array
+	{
+		return [
+			'jcb_ce_onBeforeModelComponentData' => 'jcb_ce_onBeforeModelComponentData',
+			'jcb_ce_onAfterGet' => 'jcb_ce_onAfterGet',
+			'jcb_ce_onBeforeSetLangFileData' => 'jcb_ce_onBeforeSetLangFileData',
+			'jcb_ce_onBeforeBuildPluginLangFiles' => 'jcb_ce_onBeforeBuildPluginLangFiles',
+			'jcb_ce_onBeforeBuildModuleLangFiles' => 'jcb_ce_onBeforeBuildModuleLangFiles',
+			'jcb_ce_onBeforeBuildAllLangFiles' => 'jcb_ce_onBeforeBuildAllLangFiles'
+		];
 	}
 }

src/Extension/index.html

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