From e2d425c404dc62f91d5705120d8244fdc4e6ac56 Mon Sep 17 00:00:00 2001 From: Llewellyn van der Merwe Date: Thu, 14 Oct 2021 16:31:26 +0200 Subject: [PATCH] first commit - v1.0.0 --- componentbuilderexportcompiler.php | 324 ++++++++++++++++++ componentbuilderexportcompiler.xml | 80 +++++ index.html | 1 + ...tension_componentbuilderexportcompiler.ini | 16 + ...ion_componentbuilderexportcompiler.sys.ini | 16 + script.php | 57 +++ 6 files changed, 494 insertions(+) create mode 100644 componentbuilderexportcompiler.php create mode 100644 componentbuilderexportcompiler.xml create mode 100644 index.html create mode 100644 language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini create mode 100644 language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini create mode 100644 script.php diff --git a/componentbuilderexportcompiler.php b/componentbuilderexportcompiler.php new file mode 100644 index 0000000..558fee2 --- /dev/null +++ b/componentbuilderexportcompiler.php @@ -0,0 +1,324 @@ + + * @github Joomla Component Builder + * @copyright Copyright (C) 2015 - 2020 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\Application\CMSApplication; +use Joomla\CMS\Plugin\CMSPlugin; + +JLoader::register('ComponentbuilderHelper', JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php'); +/** + * Extension - Componentbuilder Export Compiler plugin. + * + * @package ComponentbuilderExportCompiler + * @since 1.0.0 + */ +class PlgExtensionComponentbuilderExportCompiler extends CMSPlugin +{ + /** + * Application object + * + * @var CMSApplication + * @since 1.0.0 + */ + protected $app; + + /** + * Affects constructor behavior. If true, language files will be loaded automatically. + * + * @var boolean + * @since 1.0.0 + */ + protected $autoloadLanguage = true; + + /** + * The language string builder + * + * @var array + */ + protected $languageArray = array(); + + /** + * The hash placeholder + * + * @var string + */ + protected $hhh = '#' . '#' . '#'; + + /** + * The open bracket placeholder + * + * @var string + */ + protected $bbb = '[' . '[' . '['; + + /** + * The close bracket placeholder + * + * @var string + */ + protected $ddd = ']' . ']' . ']'; + + /** + * The line numbers Switch + * + * @var boolean + */ + protected $debugLinenr = false; + + /* + * The lang prefix + * + * @var boolean + */ + protected $langPrefix; + + /* + * The Export Text Only switch + * + * @var int + */ + protected $exportTextOnly = 0; + + /* + * The Strict Field Export Permissions switch + * + * @var int + */ + protected $strictFieldExportPermissions = 0; + + /** + * Event Triggered in the compiler [on Before Get Component Data] + * + * @return void + * + * @since 1.0 + */ + public function jcb_ce_onAfterGetComponentData(&$context, $compiler) + { + if ($this->exportTextOnly && $this->componentActive($context)) + { + // sync needed compiler properties with this plugin class + $this->debugLinenr = $compiler->debugLinenr; + $this->hhh = $compiler->hhh; + $this->bbb = $compiler->bbb; + $this->ddd = $compiler->ddd; + $this->langPrefix = $compiler->langPrefix; + + // activate export text only + $compiler->exportTextOnly = $this->exportTextOnly; + // activate strict_permission_per_field if set in plugin (default true) + $compiler->strictFieldExportPermissions = $this->strictFieldExportPermissions; + } + } + + /** + * Event Triggered in the compiler [on After Model Component Data] + * + * @return void + * + * @since 1.0 + */ + public function jcb_ce_onAfterModelComponentData(&$context, &$component) + { + // check if we have export for any view + if ($this->componentActive($context)) + { + // set the export/import option + if (isset($component->admin_views) && ComponentbuilderHelper::checkArray($component->admin_views)) + { + foreach ($component->admin_views as $view) + { + if (!$this->exportTextOnly && (isset($view['port']) && $view['port'] || 1 == $view['settings']->add_custom_import)) + { + $this->exportTextOnly = 1; + $this->strictFieldExportPermissions = $this->params->get('strict_permission_per_field', 1); + } + } + } + } + } + + /** + * Event Triggered in the compiler [on Before Set Lang File Data] + * + * @return void + * + * @since 1.0 + */ + public function jcb_ce_onBeforeSetLangFileData(&$context, $compiler) + { + if ($this->exportTextOnly && $this->componentActive($context) && ComponentbuilderHelper::checkArray($this->languageArray)) + { + foreach($this->languageArray as $key => $string) + { + $compiler->setLangContent('adminsys', $key, $string); + } + } + } + + /** + * Event Triggered in the compiler [on Before Set Config Field sets] + * + * @return void + * + * @since 1.0 + */ + public function jcb_ce_onBeforeSetConfigFieldsets(&$context, &$timer, &$configFieldSets, &$configFieldSetsCustomField, &$componentDataConfig, &$extensionsParams, &$placeholders) + { + // only add fields after second time + if ($this->exportTextOnly && $this->componentActive($context) && $timer == 2) + { + // main lang prefix + $lang = $this->langPrefix . '_CONFIG'; + // start building field set for config + $configFieldSets[] = $this->_t(1) . "_t(2) . 'name="export_text_only_config"'; + $configFieldSets[] = $this->_t(2) . 'label="' . $lang . '_EXPORT_TEXT_ONLY_TAB_LABEL"'; + $configFieldSets[] = $this->_t(2) . 'description="' . $lang . '_EXPORT_TEXT_ONLY_TAB_DESCRIPTION">'; + // setup lang + $this->languageArray[$lang . '_EXPORT_TEXT_ONLY_TAB_LABEL'] = "Export Options"; + $this->languageArray[$lang . '_EXPORT_TEXT_ONLY_TAB_DESCRIPTION'] = "Here are some extra option to adjust the export behavior of admin views."; + // add custom Export Options + if (isset($configFieldSetsCustomField['Export Options']) && ComponentbuilderHelper::checkArray($configFieldSetsCustomField['Export Options'])) + { + $configFieldSets[] = implode("", $configFieldSetsCustomField['Export Options']); + unset($configFieldSetsCustomField['Export Options']); + } + else + { + $this->languageArray[$lang . '_EXPORT_TEXT_ONLY_LABEL'] = "Export Text Only"; + $this->languageArray[$lang . '_EXPORT_TEXT_ONLY_DESCRIPTION'] = "This option enables the export of string/text instead of linked IDs in all admin views that have an export option."; + + $this->languageArray[$lang . '_ACTIVATE'] = "Activate"; + $this->languageArray[$lang . '_DEACTIVATE'] = "Deactivate"; + + $configFieldSets[] = PHP_EOL . $this->_t(2) . ""; + $configFieldSets[] = $this->_t(2) . "_t(3) . "type=\"radio\""; + $configFieldSets[] = $this->_t(3) . "name=\"export_text_only\""; + $configFieldSets[] = $this->_t(3) . "label=\"" . $lang . "_EXPORT_TEXT_ONLY_LABEL\""; + $configFieldSets[] = $this->_t(3) . "description=\"" . $lang . "_EXPORT_TEXT_ONLY_DESCRIPTION\""; + $configFieldSets[] = $this->_t(3) . "class=\"btn-group btn-group-yesno\""; + $configFieldSets[] = $this->_t(3) . "default=\"0\">"; + $configFieldSets[] = $this->_t(3) . ""; + $configFieldSets[] = $this->_t(3) . ""; + $configFieldSets[] = $this->_t(3) . ""; + $configFieldSets[] = $this->_t(2) . ""; + + // add strict Field Export Permissions field + if ($this->strictFieldExportPermissions) + { + $this->languageArray[$lang . '_STRICT_PERMISSION_PER_FIELD_LABEL'] = "Use Strict Permission per/field"; + $this->languageArray[$lang . '_STRICT_PERMISSION_PER_FIELD_DESCRIPTION'] = "Use strict permissions per/field in the export methods where there are fields permissions in a view."; + + $configFieldSets[] = PHP_EOL . $this->_t(2) . ""; + $configFieldSets[] = $this->_t(2) . "_t(3) . "type=\"radio\""; + $configFieldSets[] = $this->_t(3) . "name=\"strict_permission_per_field\""; + $configFieldSets[] = $this->_t(3) . "label=\"" . $lang . "_STRICT_PERMISSION_PER_FIELD_LABEL\""; + $configFieldSets[] = $this->_t(3) . "description=\"" . $lang . "_STRICT_PERMISSION_PER_FIELD_DESCRIPTION\""; + $configFieldSets[] = $this->_t(3) . "class=\"btn-group btn-group-yesno\""; + $configFieldSets[] = $this->_t(3) . "default=\"1\">"; + $configFieldSets[] = $this->_t(3) . ""; + $configFieldSets[] = $this->_t(3) . ""; + $configFieldSets[] = $this->_t(3) . ""; + $configFieldSets[] = $this->_t(2) . ""; + } + } + // close that fieldset + $configFieldSets[] = $this->_t(1) . ""; + } + } + + /** + * Set the line number in comments + * + * @param int $nr The line number + * + * @return void + * + */ + protected function setLine($nr) + { + if ($this->debugLinenr) + { + return ' [Plugin-Privacy-Compiler ' . $nr . ']'; + } + return ''; + } + + /** + * Set the tab/space + * + * @param int $nr The number of tag/space + * + * @return string + * + */ + protected function _t($nr) + { + // use global method for conformity + return ComponentbuilderHelper::_t($nr); + } + + /** + * The array of active components + * + * @var array + */ + protected $componentsActive; + + /** + * The activate option + * + * @var int + */ + protected $activateOption = 0; + + /** + * Set the line number in comments + * + * @param string $context The context of the current executing component + * + * @return bool + * + */ + protected function componentActive(&$context) + { + // check the active option + if (!$this->activateOption) + { + $this->activateOption = $this->params->get('activate_option', 1); + } + elseif ($this->activateOption == 1) + { + return true; + } + // first check is we have the active components set + if ($this->activateOption == 2 && !ComponentbuilderHelper::checkArray($this->componentsActive)) + { + $this->componentsActive = $this->params->get('components'); + } + // only check if there are active + if (ComponentbuilderHelper::checkArray($this->componentsActive)) + { + return in_array((int) filter_var($context, FILTER_SANITIZE_NUMBER_INT), $this->componentsActive); + } + return false; + } + +} diff --git a/componentbuilderexportcompiler.xml b/componentbuilderexportcompiler.xml new file mode 100644 index 0000000..ebde419 --- /dev/null +++ b/componentbuilderexportcompiler.xml @@ -0,0 +1,80 @@ + + + PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER + 3rd April, 2020 + Llewellyn van der Merwe + llewellyn@joomlacomponentbuilder.com + http://www.joomlacomponentbuilder.com + Copyright (C) 2015 - 2020 Vast Development Method. All rights reserved. + GNU General Public License version 2 or later; see LICENSE.txt + 1.0.0 + PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_XML_DESCRIPTION + + + script.php + + + + en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini + en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini + + + + + componentbuilderexportcompiler.php + index.html + language + + + + + +
+ + + + + + + + + + + + + + +
+
+
+
\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..fa6d84e --- /dev/null +++ b/index.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini b/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini new file mode 100644 index 0000000..062f438 --- /dev/null +++ b/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.ini @@ -0,0 +1,16 @@ +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.1.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 21st August, 2019

" +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." +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_ALL="All" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_SELECTED="Selected" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_COMPONENTS_LABEL="Components" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_COMPONENTS_DESCRIPTION="Select the components you would like to be targeted." +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_STRICT_PERMISSION_PER_FIELD_LABEL="Add Strict Permission per/field" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_STRICT_PERMISSION_PER_FIELD_DESCRIPTION="You can add strict permissions per/field in the export method where there is field permissions in a view." +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_NO="No" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_YES="Yes" \ No newline at end of file diff --git a/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini b/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini new file mode 100644 index 0000000..062f438 --- /dev/null +++ b/language/en-GB/en-GB.plg_extension_componentbuilderexportcompiler.sys.ini @@ -0,0 +1,16 @@ +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.1.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 21st August, 2019

" +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." +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_ALL="All" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_SELECTED="Selected" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_COMPONENTS_LABEL="Components" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_COMPONENTS_DESCRIPTION="Select the components you would like to be targeted." +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_STRICT_PERMISSION_PER_FIELD_LABEL="Add Strict Permission per/field" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_STRICT_PERMISSION_PER_FIELD_DESCRIPTION="You can add strict permissions per/field in the export method where there is field permissions in a view." +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_NO="No" +PLG_EXTENSION_COMPONENTBUILDEREXPORTCOMPILER_YES="Yes" \ No newline at end of file diff --git a/script.php b/script.php new file mode 100644 index 0000000..01ac77a --- /dev/null +++ b/script.php @@ -0,0 +1,57 @@ + + * @github Joomla Component Builder + * @copyright Copyright (C) 2015 - 2020 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'); + +/** + * Extension - Componentbuilder Export Compiler script file. + * + * @package PlgExtensionComponentbuilderExportCompiler + */ +class plgExtensionComponentbuilderExportCompilerInstallerScript +{ + + /** + * Called before any type of action + * + * @param string $route Which action is happening (install|uninstall|discover_install|update) + * @param JAdapterInstance $adapter The object responsible for running this script + * + * @return boolean True on success + */ + public function preflight($route, JAdapterInstance $adapter) + { + // get application + $app = JFactory::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 Joomla Component Builder.', 'error'); + return false; + } + } + + return true; + } +}