Moves multiple class methods to their own power classes. Moves many compiler config values to its own config class. Updated the Expantion method to use the new config class.
This commit is contained in:
@@ -12,167 +12,492 @@
|
||||
namespace VDM\Joomla\Componentbuilder\Compiler;
|
||||
|
||||
|
||||
use Joomla\Registry\Registry;
|
||||
use Joomla\Registry\Registry;
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\Input\Input;
|
||||
use VDM\Joomla\Utilities\Component\Helper;
|
||||
use VDM\Joomla\Utilities\GetHelper;
|
||||
use VDM\Joomla\Utilities\StringHelper;
|
||||
use VDM\Joomla\Utilities\String\ClassfunctionHelper;
|
||||
|
||||
|
||||
/**
|
||||
* Compiler Configurations Registry
|
||||
* Compiler Configurations
|
||||
*
|
||||
* @since 3.1.6
|
||||
* @since 3.2.0
|
||||
*/
|
||||
class Config extends Registry implements \JsonSerializable, \ArrayAccess, \IteratorAggregate, \Countable
|
||||
{
|
||||
/**
|
||||
* Hold a JInput object for easier access to the input variables.
|
||||
*
|
||||
* @var Input
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected $input;
|
||||
|
||||
/**
|
||||
* The Params
|
||||
*
|
||||
* @var Registry
|
||||
* @since 3.1.6
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected Registry $params;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param array $config The data to bind to the new Config object.
|
||||
* @param Registry $params The component parameters
|
||||
* @param Input|null $input Input
|
||||
* @param Registry|null $params The component parameters
|
||||
*
|
||||
* @since 3.1.6
|
||||
* @throws \Exception
|
||||
* @since 3.2.0
|
||||
*/
|
||||
public function __construct(array $config, ?Registry $params = null)
|
||||
public function __construct(?Input $input = null, ?Registry $params = null)
|
||||
{
|
||||
// Set the params
|
||||
$this->input = $input ?: Factory::getApplication()->input;
|
||||
$this->params = $params ?: Helper::getParams('com_componentbuilder');
|
||||
|
||||
// Instantiate the internal data object.
|
||||
$this->data = new \stdClass;
|
||||
// use underscore as the separator
|
||||
$this->separator = '_';
|
||||
|
||||
// Load the config to the data object
|
||||
$this->bindData($this->data, $this->modelConfig($config));
|
||||
// Instantiate the internal data object.
|
||||
$this->data = new \stdClass();
|
||||
}
|
||||
|
||||
/**
|
||||
* model the configuration data array
|
||||
* setting any config value
|
||||
*
|
||||
* @param array $config The data to bind to the new Config object.
|
||||
* @param String $key The value's key/path name
|
||||
* @param mixed $value Optional default value, returned if the internal value is null.
|
||||
*
|
||||
* @return array
|
||||
* @since 3.1.6
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function modelConfig(array $config): array
|
||||
public function __set($key, $value)
|
||||
{
|
||||
// we do not yet have this set as an option
|
||||
$config['remove_line_breaks']
|
||||
= 2; // 2 is global (use the components value)
|
||||
$this->set($key, $value);
|
||||
}
|
||||
|
||||
// set the minfy switch of the JavaScript
|
||||
$config['minify'] = (isset($config['minify']) && $config['minify'] != 2)
|
||||
? $config['minify'] : $this->params->get('minify', 0);
|
||||
/**
|
||||
* getting any valid value
|
||||
*
|
||||
* @param String $key The value's key/path name
|
||||
*
|
||||
* @since 3.2.0
|
||||
* @throws \InvalidArgumentException If $key is not a valid function name.
|
||||
*/
|
||||
public function __get($key)
|
||||
{
|
||||
// function name with no underscores
|
||||
$method = 'get' . ucfirst(ClassfunctionHelper::safe(str_replace('_', '', $key)));
|
||||
|
||||
// set the global language
|
||||
$config['lang_tag'] = $this->params->get('language', 'en-GB');
|
||||
if (($value = $this->get($key, '__N0T_S3T_')) !== '__N0T_S3T_')
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
elseif (method_exists($this, $method))
|
||||
{
|
||||
$value = $this->{$method}();
|
||||
|
||||
// check if we have Tidy enabled
|
||||
$config['tidy'] = extension_loaded('Tidy');
|
||||
$this->set($key, $value);
|
||||
|
||||
// set the field type builder
|
||||
$config['field_builder_type'] = $this->params->get(
|
||||
'compiler_field_builder_type', 2
|
||||
return $value;
|
||||
}
|
||||
|
||||
throw new \InvalidArgumentException(sprintf('Argument %s could not be found as function [%s], or path.', $key, $method));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a registry value.
|
||||
*
|
||||
* @param string $path Registry path (e.g. joomla.content.showauthor)
|
||||
* @param mixed $default Optional default value, returned if the internal value is null.
|
||||
*
|
||||
* @return mixed Value of entry or null
|
||||
*
|
||||
* @since 3.2.0
|
||||
*/
|
||||
public function get($path, $default = null)
|
||||
{
|
||||
// function name with no underscores
|
||||
$method = 'get' . ucfirst(ClassfunctionHelper::safe(str_replace('_', '', $path)));
|
||||
|
||||
// check if it has been set
|
||||
if (($value = parent::get($path, '__N0T_S3T_Y3T_')) !== '__N0T_S3T_Y3T_')
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
elseif (method_exists($this, $method))
|
||||
{
|
||||
$value = $this->{$method}();
|
||||
|
||||
$this->set($path, $value);
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted component id
|
||||
*
|
||||
* @return int Component id
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getComponentid(): int
|
||||
{
|
||||
return $this->input->post->get('component_id', 0, 'INT');
|
||||
}
|
||||
|
||||
/**
|
||||
* get components code name
|
||||
*
|
||||
* @return string The components code name
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getComponentcodename(): string
|
||||
{
|
||||
// get components code name
|
||||
return StringHelper::safe(GetHelper::var(
|
||||
'joomla_component', $this->component_id, 'id', 'name_code'
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* get component context
|
||||
*
|
||||
* @return string The component context
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getComponentcontext(): string
|
||||
{
|
||||
// get component context
|
||||
return $this->component_code_name . '.' . $this->component_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* get component code name length
|
||||
*
|
||||
* @return int The component code name length
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getComponentcodenamelength(): int
|
||||
{
|
||||
// get component name length
|
||||
return strlen($this->component_code_name);
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted Joomla version
|
||||
*
|
||||
* @return int Joomla version code
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getJoomlaversion(): int
|
||||
{
|
||||
return $this->input->post->get('joomla_version', 3, 'INT');
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted Joomla version name
|
||||
*
|
||||
* @return string Joomla version code name
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getJoomlaversionname(): string
|
||||
{
|
||||
return StringHelper::safe($this->joomla_version);
|
||||
}
|
||||
|
||||
/**
|
||||
* get indentation value
|
||||
*
|
||||
* @return string Indentation value
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getIndentationvalue(): string
|
||||
{
|
||||
return "\t"; // TODO add to GUI as an Global Option?
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted backup switch
|
||||
*
|
||||
* @return int Backup switch number
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getBackup(): int
|
||||
{
|
||||
return $this->input->post->get('backup', 0, 'INT');
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted repository switch
|
||||
*
|
||||
* @return int Repository switch number
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getRepository(): int
|
||||
{
|
||||
return $this->input->post->get('repository', 0, 'INT');
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted debuglinenr switch
|
||||
*
|
||||
* @return int Debuglinenr switch number
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getDebuglinenr(): int
|
||||
{
|
||||
// get posted value
|
||||
$value = $this->input->post->get('debug_line_nr', 2, 'INT');
|
||||
|
||||
// get active value
|
||||
$add = ($value == 0) ? false : (
|
||||
($value == 1) ? true : (
|
||||
((int) GetHelper::var('joomla_component', $this->component_id, 'id', 'debug_linenr' ) == 1) ? true : false
|
||||
)
|
||||
);
|
||||
|
||||
// load the compiler path
|
||||
$config['compiler_path'] = $this->params->get(
|
||||
return $add;
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted minify switch
|
||||
*
|
||||
* @return int Minify switch number
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getMinify(): int
|
||||
{
|
||||
$minify = $this->input->post->get('minify', 2, 'INT');
|
||||
|
||||
// if value is 2 use global value
|
||||
$minify = ($minify != 2) ? $minify : $this->params->get('minify', 0);
|
||||
|
||||
return $minify;
|
||||
}
|
||||
|
||||
/**
|
||||
* get posted remove line breaks switch
|
||||
*
|
||||
* @return bool Remove line breaks switch number
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getRemovelinebreaks(): bool
|
||||
{
|
||||
$value = 2; // 2 is global (use the components value) TODO: get from post
|
||||
|
||||
// get active value
|
||||
$remove = ($value == 0) ? false : (
|
||||
($value == 1) ? true : (
|
||||
((int) GetHelper::var('joomla_component', $this->component_id, 'id', 'remove_line_breaks' ) == 1) ? true : false
|
||||
)
|
||||
);
|
||||
|
||||
return $remove;
|
||||
}
|
||||
|
||||
/**
|
||||
* get system tidy state
|
||||
*
|
||||
* @return bool Tidy is active
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getTidy(): bool
|
||||
{
|
||||
// check if we have Tidy enabled
|
||||
return \extension_loaded('Tidy');
|
||||
}
|
||||
|
||||
/**
|
||||
* get language tag
|
||||
*
|
||||
* @return string The active language tag
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getLangtag(): string
|
||||
{
|
||||
// get the global language
|
||||
return $this->params->get('language', 'en-GB');
|
||||
}
|
||||
|
||||
/**
|
||||
* get language prefix
|
||||
*
|
||||
* @return string The language prefix
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getLangprefix(): string
|
||||
{
|
||||
// get components code name
|
||||
return 'COM_' . StringHelper::safe(GetHelper::var(
|
||||
'joomla_component', $this->component_id, 'id', 'name_code'
|
||||
), 'U');
|
||||
}
|
||||
|
||||
/**
|
||||
* get language target
|
||||
*
|
||||
* @return string The language active target
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getLangtarget(): string
|
||||
{
|
||||
// we start with admin
|
||||
// but this is a switch value and is changed many times
|
||||
return 'admin';
|
||||
}
|
||||
|
||||
/**
|
||||
* get language string targets
|
||||
*
|
||||
* @return array The language prefix
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getLangstringtargets(): array
|
||||
{
|
||||
// these strings are used to search for language strings in all content
|
||||
return array_values($this->lang_string_key_targets);
|
||||
}
|
||||
|
||||
/**
|
||||
* get language string targets (by key name)
|
||||
*
|
||||
* @return array The language prefix
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getLangstringkeytargets(): array
|
||||
{
|
||||
// these strings are used to search for language strings in all content
|
||||
return [
|
||||
'jjt' => 'Joomla' . '.JText._(',
|
||||
'js' => 'JText:' . ':script(',
|
||||
't' => 'Text:' . ':_(', // namespace and J version will be found
|
||||
'ts' => 'Text:' . ':sprintf(', // namespace and J version will be found
|
||||
'jt' => 'JustTEXT:' . ':_('
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* get field builder type
|
||||
*
|
||||
* @return int The field builder type
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getFieldbuildertype(): int
|
||||
{
|
||||
// get the field type builder
|
||||
return $this->params->get(
|
||||
'compiler_field_builder_type', 2
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* get compiler path
|
||||
*
|
||||
* @return string The compiler path
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getCompilerpath(): string
|
||||
{
|
||||
// get the compiler path
|
||||
return $this->params->get(
|
||||
'compiler_folder_path',
|
||||
JPATH_COMPONENT_ADMINISTRATOR . '/compiler'
|
||||
);
|
||||
}
|
||||
|
||||
// load the jcb powers path
|
||||
$config['jcb_powers_path'] = $this->params->get(
|
||||
'jcb_powers_path',
|
||||
'libraries/jcb_powers');
|
||||
/**
|
||||
* get jcb powers path
|
||||
*
|
||||
* @return string The jcb powers path
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getJcbpowerspath(): string
|
||||
{
|
||||
// get jcb powers path
|
||||
return $this->params->get('jcb_powers_path', 'libraries/jcb_powers');
|
||||
}
|
||||
|
||||
// set the component ID
|
||||
$config['component_id'] = (int)$config['component'];
|
||||
// TODO set up stream correctly
|
||||
unset($config['component']);
|
||||
/**
|
||||
* get switch to add assets table fix
|
||||
*
|
||||
* @return int Switch number to add assets table fix
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getAddassetstablefix(): int
|
||||
{
|
||||
// get global add assets table fix
|
||||
$global = $this->params->get(
|
||||
'assets_table_fix', 1
|
||||
);
|
||||
|
||||
// set this components code name
|
||||
if ($name_code = GetHelper::var(
|
||||
'joomla_component', $config['component_id'], 'id', 'name_code'
|
||||
)) {
|
||||
// set lang prefix
|
||||
$config['lang_prefix'] = 'COM_' . StringHelper::safe(
|
||||
$name_code, 'U'
|
||||
);
|
||||
// get component value
|
||||
$add = (($add_assets_table_fix = (int) GetHelper::var(
|
||||
'joomla_component', $this->component_id, 'id',
|
||||
'assets_table_fix'
|
||||
)) == 3) ? $global : $add_assets_table_fix;
|
||||
|
||||
// set component code name
|
||||
$config['component_code_name'] = StringHelper::safe(
|
||||
$name_code
|
||||
);
|
||||
return $add;
|
||||
}
|
||||
|
||||
// set component context
|
||||
$config['component_context'] = $config['component_code_name'] . '.'
|
||||
. $config['component_id'];
|
||||
/**
|
||||
* get switch add placeholders
|
||||
*
|
||||
* @return bool Switch to add placeholders
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getAddplaceholders(): bool
|
||||
{
|
||||
// get posted value
|
||||
$value = $this->input->post->get('add_placeholders', 2, 'INT');
|
||||
|
||||
// set the component name length
|
||||
$config['component_code_name_length'] = strlen(
|
||||
$config['component_code_name']
|
||||
);
|
||||
// get active value
|
||||
$add = ($value == 0) ? false : (
|
||||
($value == 1) ? true : (
|
||||
((int) GetHelper::var('joomla_component', $this->component_id, 'id', 'add_placeholders' ) == 1) ? true : false
|
||||
)
|
||||
);
|
||||
|
||||
// add assets table fix
|
||||
$global = (int)$this->params->get(
|
||||
'assets_table_fix', 1
|
||||
);
|
||||
$config['add_assets_table_fix'] = (($add_assets_table_fix
|
||||
= (int)GetHelper::var(
|
||||
'joomla_component', $config['component_id'], 'id',
|
||||
'assets_table_fix'
|
||||
)) == 3) ? $global : $add_assets_table_fix;
|
||||
return $add;
|
||||
}
|
||||
|
||||
// set if language strings line breaks should be removed
|
||||
$global = ((int)GetHelper::var(
|
||||
'joomla_component', $config['component_id'], 'id',
|
||||
'remove_line_breaks'
|
||||
) == 1) ? true : false;
|
||||
$config['remove_line_breaks'] = ((int)$config['remove_line_breaks']
|
||||
== 0)
|
||||
? false
|
||||
: (((int)$config['remove_line_breaks'] == 1) ? true
|
||||
: $global);
|
||||
/**
|
||||
* get switch add power
|
||||
*
|
||||
* @return bool Switch to add power
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getAddpower(): bool
|
||||
{
|
||||
// get posted value
|
||||
$value = $this->input->post->get('powers', 2, 'INT');
|
||||
|
||||
// set if placeholders should be added to customcode
|
||||
$global = ((int)GetHelper::var(
|
||||
'joomla_component', $config['component_id'], 'id',
|
||||
'add_placeholders'
|
||||
) == 1) ? true : false;
|
||||
$config['add_placeholders'] = ((int)$config['placeholders'] == 0)
|
||||
? false
|
||||
: (((int)$config['placeholders'] == 1) ? true : $global);
|
||||
// TODO set up stream correctly
|
||||
unset($config['placeholders']);
|
||||
// get active value
|
||||
$add = ($value == 0) ? false : (
|
||||
($value == 1) ? true : (
|
||||
((int) GetHelper::var('joomla_component', $this->component_id, 'id', 'add_powers' ) == 1) ? true : false
|
||||
)
|
||||
);
|
||||
|
||||
// set if line numbers should be added to comments
|
||||
$global = ((int)GetHelper::var(
|
||||
'joomla_component', $config['component_id'], 'id',
|
||||
'debug_linenr'
|
||||
) == 1) ? true : false;
|
||||
$config['debug_line_nr'] = ((int)$config['debuglinenr'] == 0) ? false
|
||||
: (((int)$config['debuglinenr'] == 1) ? true : $global);
|
||||
return $add;
|
||||
}
|
||||
|
||||
// set if powers should be added to component (default is true)
|
||||
$global = ((int)GetHelper::var(
|
||||
'joomla_component', $config['component_id'], 'id',
|
||||
'add_powers'
|
||||
) == 1) ? true : false;
|
||||
$config['add_power'] = (isset($config['powers']) && (int)$config['powers'] == 0)
|
||||
? false : ((isset($config['powers']) && (int)$config['powers'] == 1) ? true : $global);
|
||||
// TODO set up stream correctly
|
||||
unset($config['powers']);
|
||||
}
|
||||
|
||||
return $config;
|
||||
}
|
||||
/**
|
||||
* get switch build target switch
|
||||
*
|
||||
* @return string Switch to control the build flow
|
||||
* @since 3.2.0
|
||||
*/
|
||||
protected function getBuildtarget(): string
|
||||
{
|
||||
// we start with admin
|
||||
// but this is a switch value and is changed many times
|
||||
return 'admin';
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user