325 lines
10 KiB
PHP
325 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 30th April, 2015
|
|
* @author Llewellyn van der Merwe <http://www.joomlacomponentbuilder.com>
|
|
* @github Joomla Component Builder <https://github.com/vdm-io/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) . "<fieldset";
|
|
$configFieldSets[] = $this->_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) . "<!--" . $this->setLine(__LINE__) . " Export Text Only Field. Type: Radio. (joomla) -->";
|
|
$configFieldSets[] = $this->_t(2) . "<field";
|
|
$configFieldSets[] = $this->_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) . "<!--" . $this->setLine(__LINE__) . " Option Set. -->";
|
|
$configFieldSets[] = $this->_t(3) . "<option value=\"1\">";
|
|
$configFieldSets[] = $this->_t(4) . $lang . "_ACTIVATE</option>";
|
|
$configFieldSets[] = $this->_t(3) . "<option value=\"0\">";
|
|
$configFieldSets[] = $this->_t(4) . $lang . "_DEACTIVATE</option>";
|
|
$configFieldSets[] = $this->_t(2) . "</field>";
|
|
|
|
// 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) . "<!--" . $this->setLine(__LINE__) . " Strict_permission_per_field Field. Type: Radio. (joomla) -->";
|
|
$configFieldSets[] = $this->_t(2) . "<field";
|
|
$configFieldSets[] = $this->_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) . "<!--" . $this->setLine(__LINE__) . " Option Set. -->";
|
|
$configFieldSets[] = $this->_t(3) . "<option value=\"1\">";
|
|
$configFieldSets[] = $this->_t(4) . $lang . "_ACTIVATE</option>";
|
|
$configFieldSets[] = $this->_t(3) . "<option value=\"0\">";
|
|
$configFieldSets[] = $this->_t(4) . $lang . "_DEACTIVATE</option>";
|
|
$configFieldSets[] = $this->_t(2) . "</field>";
|
|
}
|
|
}
|
|
// close that fieldset
|
|
$configFieldSets[] = $this->_t(1) . "</fieldset>";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
}
|