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

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

componentbuilderpowersautoloadercompiler.php

@@ -14,14 +14,21 @@ defined('_JEXEC') or die('Restricted access');
 
 use Joomla\CMS\Factory;
 use Joomla\CMS\Language\Text;
-use Joomla\CMS\Plugin\CMSPlugin;
-use VDM\Joomla\Componentbuilder\Compiler\Factory as CompilerFactory;
+use Joomla\CMS\Application\CMSApplication;
+use Joomla\CMS\Plugin\CMSPlugin;
+use Joomla\Registry\Registry;
 use VDM\Joomla\Utilities\ArrayHelper;
+use VDM\Joomla\Componentbuilder\Compiler\Factory as CompilerFactory;
+
+JLoader::register('ComponentbuilderHelper', JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php');
+
+use VDM\Joomla\Componentbuilder\Compiler\Factory as CFactory;
+
 /**
  * Extension - Componentbuilder Powers Autoloader Compiler plugin.
  *
  * @package   ComponentbuilderPowersAutoloaderCompiler
- * @since     2.0.0
+ * @since     1.2.0
  */
 class PlgExtensionComponentbuilderPowersAutoloaderCompiler extends CMSPlugin
 {
@@ -43,15 +50,15 @@ class PlgExtensionComponentbuilderPowersAutoloaderCompiler extends CMSPlugin
 	public function jcb_ce_onAfterGet()
 	{
 		// check if this component needs a power autoloader plugin loaded
-		if (CompilerFactory::_('Config')->add_power && $this->componentActive())
+		if (CFactory::_('Config')->add_power && $this->componentActive())
 		{
 			// now get the plugin ID if set
 			if (($id = (int) $this->params->get('plugin', 0)) !== 0)
 			{
 				// load the power autoloader plugin
-				CompilerFactory::_('Joomlaplugin.Data')->set($id);
+				CFactory::_('Joomlaplugin.Data')->set($id);
 				// now set the plugin powers placeholder
-				CompilerFactory::_('Compiler.Builder.Content.One')->set('PLUGIN_POWER_AUTOLOADER', '');
+				CFactory::_('Compiler.Builder.Content.One')->set('PLUGIN_POWER_AUTOLOADER', '');
 			}
 			else
 			{

componentbuilderpowersautoloadercompiler.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<extension type="plugin" version="5.0" group="extension" method="upgrade">
+<extension type="plugin" version="3.10" group="extension" method="upgrade">
 	<name>PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER</name>
 	<creationDate>16th May, 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.2.0</version>
 	<description>PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_XML_DESCRIPTION</description>
 
 	<!-- Scripts to run on installation -->

fields/joomlacomponents.php

@@ -0,0 +1,61 @@
+<?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');
+
+/**
+ * Joomlacomponents Form Field class for the Componentbuilder component
+ */
+class JFormFieldJoomlacomponents extends JFormFieldList
+{
+	/**
+	 * The joomlacomponents field type.
+	 *
+	 * @var        string
+	 */
+	public $type = 'joomlacomponents';
+
+	/**
+	 * 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.id','a.system_name'),array('id','components_system_name')));
+		$query->from($db->quoteName('#__componentbuilder_joomla_component', 'a'));
+		$query->where($db->quoteName('a.published') . ' >= 1');
+		$query->order('a.system_name ASC');
+		$db->setQuery((string)$query);
+		$items = $db->loadObjectList();
+		$options = array();
+		if ($items)
+		{
+			foreach($items as $item)
+			{
+				$options[] = JHtml::_('select.option', $item->id, $item->components_system_name);
+			}
+		}
+
+		return $options;
+	}
+}

fields/joomlaplugins.php

@@ -0,0 +1,183 @@
+<?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');
+
+/**
+ * Joomlaplugins Form Field class for the Componentbuilder component
+ */
+class JFormFieldJoomlaplugins extends JFormFieldList
+{
+	/**
+	 * The joomlaplugins field type.
+	 *
+	 * @var        string
+	 */
+	public $type = 'joomlaplugins';
+
+	/**
+	 * 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 joomla_plugin
+			if ($user->authorise('joomla_plugin.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_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_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=joomla_plugin&amp;layout=edit'.$ref.'" >
+					<span class="icon-new icon-white"></span></a>';
+			}
+			// only add if user allowed to edit joomla_plugin
+			if ($user->authorise('joomla_plugin.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_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_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=joomla_plugins&task=joomla_plugin.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 joomla_plugin 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()
+	{
+		// Get the user object.
+		$user = Factory::getUser();
+		// Get the databse object.
+		$db = Factory::getDBO();
+		$query = $db->getQuery(true);
+		$query->select($db->quoteName(array('a.id','a.system_name','a.name','b.name','c.name'),array('id','plugin_system_name','name','class_extends_name','joomla_plugin_group_name')));
+		$query->from($db->quoteName('#__componentbuilder_joomla_plugin', 'a'));
+		$query->join('LEFT', $db->quoteName('#__componentbuilder_class_extends', 'b') . ' ON (' . $db->quoteName('a.class_extends') . ' = ' . $db->quoteName('b.id') . ')');
+		$query->join('LEFT', $db->quoteName('#__componentbuilder_joomla_plugin_group', 'c') . ' ON (' . $db->quoteName('a.joomla_plugin_group') . ' = ' . $db->quoteName('c.id') . ')');
+		$query->where($db->quoteName('a.published') . ' >= 1');
+		$query->order('a.system_name ASC');
+		// Implement View Level Access (if set in table)
+		if (!$user->authorise('core.options', 'com_componentbuilder'))
+		{
+			$columns = $db->getTableColumns('#__componentbuilder_joomla_plugin');
+			if(isset($columns['access']))
+			{
+				$groups = implode(',', $user->getAuthorisedViewLevels());
+				$query->where('a.access IN (' . $groups . ')');
+			}
+		}
+		$db->setQuery((string)$query);
+		$items = $db->loadObjectList();
+		$options = array();
+		if ($items)
+		{
+			$options[] = Html::_('select.option', '', 'Select a plugin');
+			foreach($items as $item)
+			{
+				// set a full class name
+				$group_name = $item->joomla_plugin_group_name ?? '';
+				$name = $item->name ?? '';
+				$options[] = Html::_('select.option', $item->id, '( ' . $item->plugin_system_name . ' ) class Plg' . $group_name . $name . ' extends ' . $item->class_extends_name);
+			}
+		}
+		return $options;
+	}
+}

language/en-GB/en-GB.plg_extension_componentbuilderpowersautoloadercompiler.ini

@@ -1,6 +1,6 @@
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER="Extension - Componentbuilder Powers Autoloader Compiler"
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_DESCRIPTION="This plugin is used to build the power autoloader plugin for your component 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."
-PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Powers Autoloader Compiler (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to build the power autoloader plugin for your component 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.</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_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Powers Autoloader Compiler (v.1.2.0)</h1> <div style='clear: both;'></div><p>This plugin is used to build the power autoloader plugin for your component 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.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 13th November, 2021</small></p>"
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_YOU_DO_NOT_HAVE_A_GLOBAL_POWER_PLUGIN_SETUP_SO_THE_POWERS_PLUGIN_AUTOLOADER_COULD_NOT_BE_ADDED="You do not have a global power plugin setup, so the powers plugin autoloader could not be added."
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_GLOBAL_AUTOLOADER="Global Autoloader"
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_NOTE_SELECT_POWER_PLUGIN_LABEL="Select your power autoloader plugin here."

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

@@ -1,6 +1,6 @@
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER="Extension - Componentbuilder Powers Autoloader Compiler"
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_DESCRIPTION="This plugin is used to build the power autoloader plugin for your component 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."
-PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Powers Autoloader Compiler (v.2.0.0)</h1> <div style='clear: both;'></div><p>This plugin is used to build the power autoloader plugin for your component 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.</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_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_XML_DESCRIPTION="<h1>Extension - Componentbuilder Powers Autoloader Compiler (v.1.2.0)</h1> <div style='clear: both;'></div><p>This plugin is used to build the power autoloader plugin for your component 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.</p><p>Created by <a href='https://dev.vdm.io' target='_blank'>Llewellyn van der Merwe</a><br /><small>Development started 13th November, 2021</small></p>"
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_YOU_DO_NOT_HAVE_A_GLOBAL_POWER_PLUGIN_SETUP_SO_THE_POWERS_PLUGIN_AUTOLOADER_COULD_NOT_BE_ADDED="You do not have a global power plugin setup, so the powers plugin autoloader could not be added."
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_GLOBAL_AUTOLOADER="Global Autoloader"
 PLG_EXTENSION_COMPONENTBUILDERPOWERSAUTOLOADERCOMPILER_NOTE_SELECT_POWER_PLUGIN_LABEL="Select your power autoloader plugin here."

script.php

@@ -24,4 +24,72 @@ use Joomla\CMS\Filesystem\Folder;
  */
 class plgExtensionComponentbuilderPowersAutoloaderCompilerInstallerScript
 {
+
+	/**
+	 * 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.10 or higher installed
+				if (count($jcbVersion) == 3 && $jcbVersion[0] >= 3 &&
+					(
+						($jcbVersion[0] == 3 && $jcbVersion[1] == 0 && $jcbVersion[2] >= 10) ||
+						($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.10 or higher before installing this plugin.', 'error');
+				return false;
+			}
+
+		}
+
+		return true;
+	}
 }