2021-10-14 14:31:26 +00:00
< ? php
2021-12-16 13:15:27 +00:00
/**
* @ package Joomla . Component . Builder
*
* @ created 30 th April , 2015
* @ author Llewellyn van der Merwe < https :// dev . vdm . io >
2022-08-20 16:38:51 +00:00
* @ git Joomla Component Builder < https :// git . vdm . dev / joomla / Component - Builder >
2021-12-16 13:15:27 +00:00
* @ copyright Copyright ( C ) 2015 Vast Development Method . All rights reserved .
* @ license GNU General Public License version 2 or later ; see LICENSE . txt
2021-10-14 14:31:26 +00:00
*/
// No direct access to this file
defined ( '_JEXEC' ) or die ( 'Restricted access' );
use Joomla\CMS\Application\CMSApplication ;
use Joomla\CMS\Plugin\CMSPlugin ;
2023-02-05 21:57:58 +00:00
JLoader :: register ( 'ComponentbuilderHelper' , JPATH_ADMINISTRATOR . '/components/com_componentbuilder/helpers/componentbuilder.php' );
2023-02-15 13:26:02 +00:00
use VDM\Joomla\Componentbuilder\Compiler\Factory as CFactory ;
2023-02-05 21:57:58 +00:00
use VDM\Joomla\Componentbuilder\Compiler\Utilities\Indent ;
use VDM\Joomla\Componentbuilder\Compiler\Utilities\Line ;
2021-10-14 14:31:26 +00:00
/**
* Extension - Componentbuilder Export Compiler plugin .
*
* @ package ComponentbuilderExportCompiler
2023-02-15 13:26:02 +00:00
* @ since 1.1 . 2
2021-10-14 14:31:26 +00:00
*/
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 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 ))
{
// activate export text only
$compiler -> exportTextOnly = $this -> exportTextOnly ;
2023-02-05 21:57:58 +00:00
2021-10-14 14:31:26 +00:00
// 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 )
{
2023-02-15 13:26:02 +00:00
CFactory :: _ ( 'Language' ) -> set ( 'adminsys' , $key , $string );
2021-10-14 14:31:26 +00:00
}
}
}
/**
* 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
2023-02-15 13:26:02 +00:00
$lang = CFactory :: _ ( 'Config' ) -> lang_prefix . '_CONFIG' ;
2021-10-14 14:31:26 +00:00
// start building field set for config
2023-02-05 21:57:58 +00:00
$configFieldSets [] = Indent :: _ ( 1 ) . " <fieldset " ;
$configFieldSets [] = Indent :: _ ( 2 ) . 'name="export_text_only_config"' ;
$configFieldSets [] = Indent :: _ ( 2 ) . 'label="' . $lang . '_EXPORT_TEXT_ONLY_TAB_LABEL"' ;
$configFieldSets [] = Indent :: _ ( 2 ) . 'description="' . $lang . '_EXPORT_TEXT_ONLY_TAB_DESCRIPTION">' ;
2021-10-14 14:31:26 +00:00
// 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 " ;
2023-02-05 21:57:58 +00:00
$configFieldSets [] = PHP_EOL . Indent :: _ ( 2 ) . " <!-- " . Line :: _ ( __Line__ , __Class__ ) . " Export Text Only Field. Type: Radio. (joomla) --> " ;
$configFieldSets [] = Indent :: _ ( 2 ) . " <field " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " type= \" radio \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " name= \" export_text_only \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " label= \" " . $lang . " _EXPORT_TEXT_ONLY_LABEL \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " description= \" " . $lang . " _EXPORT_TEXT_ONLY_DESCRIPTION \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " class= \" btn-group btn-group-yesno \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " default= \" 0 \" > " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " <!-- " . Line :: _ ( __Line__ , __Class__ ) . " Option Set. --> " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " <option value= \" 1 \" > " ;
$configFieldSets [] = Indent :: _ ( 4 ) . $lang . " _ACTIVATE</option> " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " <option value= \" 0 \" > " ;
$configFieldSets [] = Indent :: _ ( 4 ) . $lang . " _DEACTIVATE</option> " ;
$configFieldSets [] = Indent :: _ ( 2 ) . " </field> " ;
2021-10-14 14:31:26 +00:00
// 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. " ;
2023-02-05 21:57:58 +00:00
$configFieldSets [] = PHP_EOL . Indent :: _ ( 2 ) . " <!-- " . Line :: _ ( __Line__ , __Class__ ) . " Strict_permission_per_field Field. Type: Radio. (joomla) --> " ;
$configFieldSets [] = Indent :: _ ( 2 ) . " <field " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " type= \" radio \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " name= \" strict_permission_per_field \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " label= \" " . $lang . " _STRICT_PERMISSION_PER_FIELD_LABEL \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " description= \" " . $lang . " _STRICT_PERMISSION_PER_FIELD_DESCRIPTION \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " class= \" btn-group btn-group-yesno \" " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " default= \" 1 \" > " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " <!-- " . Line :: _ ( __Line__ , __Class__ ) . " Option Set. --> " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " <option value= \" 1 \" > " ;
$configFieldSets [] = Indent :: _ ( 4 ) . $lang . " _ACTIVATE</option> " ;
$configFieldSets [] = Indent :: _ ( 3 ) . " <option value= \" 0 \" > " ;
$configFieldSets [] = Indent :: _ ( 4 ) . $lang . " _DEACTIVATE</option> " ;
$configFieldSets [] = Indent :: _ ( 2 ) . " </field> " ;
2021-10-14 14:31:26 +00:00
}
}
// close that fieldset
2023-02-05 21:57:58 +00:00
$configFieldSets [] = Indent :: _ ( 1 ) . " </fieldset> " ;
2021-10-14 14:31:26 +00:00
}
}
/**
* 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 );
}
2021-10-14 14:31:33 +00:00
// active for all components
if ( $this -> activateOption == 1 )
2021-10-14 14:31:26 +00:00
{
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 ;
}
}