Update on v1.0.2 (changes towards the next release)

Here's an update on the current version, which includes changes towards the next release still in development.

componentbuilderlanguagetabs.php

@@ -12,19 +12,23 @@
 // No direct access to this file
 defined('_JEXEC') or die('Restricted access');
 
+use Joomla\CMS\Application\CMSApplication;
 use Joomla\CMS\Plugin\CMSPlugin;
+use Joomla\Registry\Registry;
 use Joomla\CMS\Form\Form;
+
+JLoader::register('ComponentbuilderHelper', JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php'); 
 
 /**
  * Content - Componentbuilder Language Tabs plugin.
  *
  * @package   ComponentbuilderLanguageTabs
- * @since     2.0.0
+ * @since     1.0.2
  */
 class PlgContentComponentbuilderLanguageTabs extends CMSPlugin
 {
 	/**
-	 * Affects constructor behaviour. If true, language files will be loaded automatically.
+	 * Affects constructor behavior. If true, language files will be loaded automatically.
 	 *
 	 * @var    boolean
 	 * @since  1.0
@@ -34,8 +38,8 @@ class PlgContentComponentbuilderLanguageTabs extends CMSPlugin
 	/**
 	 * Runs on content preparation of form.
 	 *
-	 * @param   Form     $form  The form
-	 * @param   \stdClass  $data  The data
+	 * @param   JForm     $form  The form
+	 * @param   stdClass  $data  The data
 	 *
 	 * @return  boolean
 	 *

componentbuilderlanguagetabs.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<extension type="plugin" version="5.0" group="content" method="upgrade">
+<extension type="plugin" version="3.10" group="content" method="upgrade">
 	<name>PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS</name>
 	<creationDate>5th June, 2024</creationDate>
 	<author>Llewellyn van der Merwe</author>
@@ -7,7 +7,7 @@
 	<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>1.0.2</version>
 	<description>PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_XML_DESCRIPTION</description>
 
 	<!-- Scripts to run on installation -->

fields/excludedlanguages.php

@@ -0,0 +1,180 @@
+<?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\Language\Text;
+use Joomla\CMS\HTML\HTMLHelper as Html;
+
+// import the list field type
+jimport('joomla.form.helper');
+JFormHelper::loadFieldClass('list');
+
+/**
+ * Excludedlanguages Form Field class for the Componentbuilder component
+ */
+class JFormFieldExcludedlanguages extends JFormFieldList
+{
+	/**
+	 * The excludedlanguages field type.
+	 *
+	 * @var        string
+	 */
+	public $type = 'excludedlanguages';
+
+	/**
+	 * Override to add new button
+	 *
+	 * @return  string  The field input markup.
+	 *
+	 * @since   3.2
+	 */
+	protected function getInput()
+	{
+		// see if we should add buttons
+		$set_button = $this->getAttribute('button');
+		// get html
+		$html = parent::getInput();
+		// if true set button
+		if ($set_button === 'true')
+		{
+			$button = array();
+			$script = array();
+			$button_code_name = $this->getAttribute('name');
+			// get the input from url
+			$app = Factory::getApplication();
+			$jinput = $app->input;
+			// get the view name & id
+			$values = $jinput->getArray(array(
+				'id' => 'int',
+				'view' => 'word'
+			));
+			// check if new item
+			$ref = '';
+			$refJ = '';
+			if (!is_null($values['id']) && strlen($values['view']))
+			{
+				// only load referral if not new item.
+				$ref = '&amp;ref=' . $values['view'] . '&amp;refid=' . $values['id'];
+				$refJ = '&ref=' . $values['view'] . '&refid=' . $values['id'];
+				// get the return value.
+				$_uri = (string) \Joomla\CMS\Uri\Uri::getInstance();
+				$_return = urlencode(base64_encode($_uri));
+				// load return value.
+				$ref .= '&amp;return=' . $_return;
+				$refJ .= '&return=' . $_return;
+			}
+			// get button label
+			$button_label = trim($button_code_name);
+			$button_label = preg_replace('/_+/', ' ', $button_label);
+			$button_label = preg_replace('/\s+/', ' ', $button_label);
+			$button_label = preg_replace("/[^A-Za-z ]/", '', $button_label);
+			$button_label = ucfirst(strtolower($button_label));
+			// get user object
+			$user = Factory::getUser();
+			// only add if user allowed to create language
+			if ($user->authorise('language.create', 'com_componentbuilder') && $app->isClient('administrator')) // TODO for now only in admin area.
+			{
+				// build Create button
+				$button[] = '<a id="'.$button_code_name.'Create" class="btn btn-small btn-success hasTooltip" title="'.Text::sprintf('PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_CREATE_NEW_S', $button_label).'" style="border-radius: 0px 4px 4px 0px; padding: 4px 4px 4px 7px;"
+					href="index.php?option=com_componentbuilder&amp;view=language&amp;layout=edit'.$ref.'" >
+					<span class="icon-new icon-white"></span></a>';
+			}
+			// only add if user allowed to edit language
+			if ($user->authorise('language.edit', 'com_componentbuilder') && $app->isClient('administrator')) // TODO for now only in admin area.
+			{
+				// build edit button
+				$button[] = '<a id="'.$button_code_name.'Edit" class="btn btn-small hasTooltip" title="'.Text::sprintf('PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_EDIT_S', $button_label).'" style="display: none; padding: 3px 4px 4px 7px;" href="#" >
+					<span class="icon-edit"></span></a>';
+				// build script
+				$script[] = "
+					jQuery(document).ready(function() {
+						jQuery('#adminForm').on('change', '#jform_".$button_code_name."',function (e) {
+							e.preventDefault();
+							var ".$button_code_name."Value = jQuery('#jform_".$button_code_name."').val();
+							".$button_code_name."Button(".$button_code_name."Value);
+						});
+						var ".$button_code_name."Value = jQuery('#jform_".$button_code_name."').val();
+						".$button_code_name."Button(".$button_code_name."Value);
+					});
+					function ".$button_code_name."Button(value) {
+						if (value > 0) {
+							// hide the create button
+							jQuery('#".$button_code_name."Create').hide();
+							// show edit button
+							jQuery('#".$button_code_name."Edit').show();
+							var url = 'index.php?option=com_componentbuilder&view=languages&task=language.edit&id='+value+'".$refJ."';
+							jQuery('#".$button_code_name."Edit').attr('href', url);
+						} else {
+							// show the create button
+							jQuery('#".$button_code_name."Create').show();
+							// hide edit button
+							jQuery('#".$button_code_name."Edit').hide();
+						}
+					}";
+			}
+			// check if button was created for language field.
+			if (is_array($button) && count($button) > 0)
+			{
+				// Load the needed script.
+				$document = Factory::getDocument();
+				$document->addScriptDeclaration(implode(' ',$script));
+				// return the button attached to input field.
+				return '<div class="input-append">' .$html . implode('',$button).'</div>';
+			}
+		}
+		return $html;
+	}
+
+	/**
+	 * Method to get a list of options for a list input.
+	 *
+	 * @return    array    An array of Html options.
+	 */
+	protected function getOptions()
+	{
+		$db = JFactory::getDBO();
+		$query = $db->getQuery(true);
+		$query->select($db->quoteName(array('a.langtag','a.name'),array('langtag','languages_name')));
+		$query->from($db->quoteName('#__componentbuilder_language', 'a'));
+		$query->where($db->quoteName('a.published') . ' >= 1');
+		$query->order('a.langtag ASC');
+		$db->setQuery((string)$query);
+		$items = $db->loadObjectList();
+		// add the main language
+		$main_lang = trim(JComponentHelper::getParams('com_componentbuilder')->get('language', 'en-GB'));
+		// check if any language was added
+		$wasAdded = false;
+		$options = array();
+		if ($items)
+		{
+			$options[] = JHtml::_('select.option', '', 'Select an option');
+			foreach($items as $item)
+			{
+				$item->langtag = trim($item->langtag);
+				// do not add main language
+				if ($main_lang !== $item->langtag)
+				{
+					$options[] = JHtml::_('select.option', $item->langtag, $item->languages_name . ' (' .$item->langtag.')');
+					$wasAdded = true;
+				}
+			}
+		}
+		// now if none was added give notice
+		if (!$wasAdded)
+		{
+			$options[] = JHtml::_('select.option', '', 'Add languages to select');
+		}
+		return $options;
+	}
+}

language/en-GB/en-GB.plg_content_componentbuilderlanguagetabs.ini

@@ -1,6 +1,6 @@
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS="Content - Componentbuilder Language Tabs"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_DESCRIPTION="This plugin is used to link your components to the language packaging and extending options, so you can set all the required details for the integration."
-PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Language Tabs (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to link your components to the language packaging and extending options, so you can set all the required details for the integration.</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_COMPONENTBUILDERLANGUAGETABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Language Tabs (v.1.0.2)</h1> <div style='clear: both;'></div><p>This plugin is used to link your components to the language packaging and extending options, so you can set all the required details for the integration.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 19th March, 2020</small></p>"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_LANGUAGE_OPTIONS="Language Options"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_NOTE_LANGUAGE_NOTE_LABEL="Would you like to move languages to their own packages?"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_NOTE_LANGUAGE_NOTE_DESCRIPTION="<p>Adding all your translations to your component can increase its size dramatically, so now you are able to move each extra language translation to its own installing package, leaving just your main language in the component.</p><p>Please note that this is only relevant if you actually have added extra translations to your component in the <b>Language Translations</b> area of JCB.</p>"

language/en-GB/en-GB.plg_content_componentbuilderlanguagetabs.sys.ini

@@ -1,6 +1,6 @@
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS="Content - Componentbuilder Language Tabs"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_DESCRIPTION="This plugin is used to link your components to the language packaging and extending options, so you can set all the required details for the integration."
-PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Language Tabs (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to link your components to the language packaging and extending options, so you can set all the required details for the integration.</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_COMPONENTBUILDERLANGUAGETABS_XML_DESCRIPTION="<h1>Content - Componentbuilder Language Tabs (v.1.0.2)</h1> <div style='clear: both;'></div><p>This plugin is used to link your components to the language packaging and extending options, so you can set all the required details for the integration.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 19th March, 2020</small></p>"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_LANGUAGE_OPTIONS="Language Options"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_NOTE_LANGUAGE_NOTE_LABEL="Would you like to move languages to their own packages?"
 PLG_CONTENT_COMPONENTBUILDERLANGUAGETABS_NOTE_LANGUAGE_NOTE_DESCRIPTION="<p>Adding all your translations to your component can increase its size dramatically, so now you are able to move each extra language translation to its own installing package, leaving just your main language in the component.</p><p>Please note that this is only relevant if you actually have added extra translations to your component in the <b>Language Translations</b> area of JCB.</p>"

script.php

@@ -24,4 +24,72 @@ use Joomla\CMS\Filesystem\Folder;
  */
 class plgContentComponentbuilderLanguageTabsInstallerScript
 {
+
+	/**
+	 * Called before any type of action
+	 *
+	 * @param   string  $route  Which action is happening (install|uninstall|discover_install|update)
+	 * @param   Joomla\CMS\Installer\InstallerAdapter  $adapter  The object responsible for running this script
+	 *
+	 * @return  boolean  True on success
+	 */
+	public function preflight($route, $adapter)
+	{
+		// get application
+		$app = Factory::getApplication();
+
+		// the default for both install and update
+		$jversion = new JVersion();
+		if (!$jversion->isCompatible('3.8.0'))
+		{
+			$app->enqueueMessage('Please upgrade to at least Joomla! 3.8.0 before continuing!', 'error');
+			return false;
+		}
+
+		if ('install' === $route)
+		{
+
+			// check that componentbuilder is installed
+			$pathToCore = JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php';
+			if (!JFile::exists($pathToCore))
+			{
+				$app->enqueueMessage('Joomla Component Builder must first be installed from <a href="https://www.joomlacomponentbuilder.com/ " target="_blank">Joomla Component Builder</a>.', 'error');
+				return false;
+			}
+
+			// load the helper class
+			JLoader::register('ComponentbuilderHelper', JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php');
+
+			// block install
+			$blockInstall = true;
+
+			// check the version of JCB
+			$manifest = ComponentbuilderHelper::manifest();
+			if (isset($manifest->version) && strpos($manifest->version, '.') !== false)
+			{
+				// get the version
+				$jcbVersion = explode('.', $manifest->version);
+				// check that we have JCB 3.0.0 or higher installed
+				if (count($jcbVersion) == 3 && $jcbVersion[0] >= 3 &&
+					(
+						($jcbVersion[0] == 3 && $jcbVersion[1] == 0 && $jcbVersion[2] >= 0) ||
+						($jcbVersion[0] == 3 && $jcbVersion[1] > 0) ||
+						$jcbVersion[0] > 3)
+					)
+				{
+					$blockInstall = false;
+				}
+			}
+
+			// allow install if all conditions are met
+			if ($blockInstall)
+			{
+				$app->enqueueMessage('Please upgrade to JCB v3.0.0 or higher before installing this plugin.', 'error');
+				return false;
+			}
+
+		}
+
+		return true;
+	}
 }