joomla/Component-Builder
42
28 Fork 13
Code Issues 57 Pull Requests Projects Wiki Activity

Release of v5.1.1-rc1

Browse Source 
Move all banners to GitHub. Adds library phpspreadsheet to JCB. Adds import item example to demo component. Updates the Superpower class with the GetRemote class in the plugin. Ensures the super power autoloader triggers the correct repositories. Adds the ModalSelect fieldtype to Joomla Component Builder - J5. Adds the Data Import Function to the Demo Component. Adds new country related tables and fields to the Demo Component. Resolves the Database Updating issue in the compiler. #1212,#1209. Adds the Component Commands Plugin to the CLI for Import of spreadsheet data-sets. Add edit and create options to the ModalSelect Field (in Joomla 5). Add all needed Powers to the release package, to speed-up the build of the demo component. Refactor initialization flow to accommodate future scalability and integration with all designated areas. Refactor the Creator Builders class. Refactor the FieldString and FieldXML classes. Add JCB new package engine. Enhance operator support in dynamic get system. Relates to issue #1226. Fixes issue with loading the Component Builder Wiki. Adds advanced version update notice to the Component Builder Dashboard. Completely refactors the class that builds the Component Dashboard. #1134. Fix the FieldXML interface mismatch. #1228. Adds Initialize, Reset, and Push functionality to the Repository entities. Completely refactors the SQL tweaks and SQL dump classes. Fix bug in the filter of Languages by linked entities. #1230.
This commit is contained in:
Robot committed 2025-07-02 19:03:37 +00:00
1 parent 1702bd1f0c
commit 087e3a7c19
26 files changed
+795 -980
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

admin/src/Model/AjaxModel.php
+233
View File
@@ -42,6 +42,8 @@ use VDM\Joomla\Utilities\Base64Helper;
use VDM\Joomla\Componentbuilder\Table\Search;
use VDM\Joomla\Componentbuilder\Compiler\Utilities\FieldHelper;
use VDM\Joomla\Utilities\FormHelper;
use VDM\Joomla\Componentbuilder\Utilities\FilterHelper;
use VDM\Joomla\Data\Factory as DataFactory;
use VDM\Joomla\Componentbuilder\Package\Factory as PackageFactory;
use VDM\Joomla\Componentbuilder\Fieldtype\Factory as FieldtypeFactory;
use VDM\Joomla\Componentbuilder\JoomlaPower\Factory as JoomlaPowerFactory;
@@ -4872,6 +4874,237 @@ class AjaxModel extends ListModel
return $xml;
}
// Used in language_translation
/**
* Export language translation data by filtering records based on extension, translated, and untranslated tags.
*
* This method loads translation records from the database and structures them into an array
* with language-tagged headers (e.g., `en-GB`, `de-DE`). It supports filtering for a specific
* extension, already translated languages, and missing translations. All matching records are
* padded with empty values for missing languages, and returned with a size count or errors.
*
* @param string $extension The extension identifier in format "type__name" (e.g., "com_example__field").
* @param string $translated Comma-separated list of language tags that must have translations.
* @param string $notTranslated Comma-separated list of language tags that must not yet have translations.
*
* @return array<string, mixed> Returns an array with:
* - 'data' (array<int, array<string, string>>): The exportable translation rows.
* - 'size' (int): Number of rows (if successful).
* - 'errors' (string): Error message (if an error occurred).
*
* @throws \Throwable If any unexpected exception occurs during data fetching or parsing.
* @since 5.1.1
*/
public function exportLanguageTranslations(string $extension, string $translated, string $notTranslated): array
{
try {
$ids = $this->resolveLanguageTranslationFilterIds($extension, $translated, $notTranslated);
$where = $this->buildLanguageTranslationWhereClause($ids);
$records = $this->loadLanguageTranslationRows($where);
$headers = $this->getLanguageTranslationHeaders();
if (empty($records))
{
return $this->errorLanguageTranslationResponse(Text::_('COM_COMPONENTBUILDER_NO_LANGUAGE_STRINGS_FOUND'));
}
$data = $this->normalizeLanguageTranslationData($records, $headers);
return [
'data' => $data,
'size' => count($data),
];
} catch (\Throwable $e) {
return $this->errorLanguageTranslationResponse($e->getMessage());
}
}
/**
* Resolve all relevant record IDs from the given filters.
*
* @param string $extension Extension string in format "type__name".
* @param string $translated Comma-separated list of translated language tags.
* @param string $notTranslated Comma-separated list of untranslated language tags.
*
* @return array<int>|null Array of record IDs, or empty array to load all or null to force a skip all.
* @since 5.1.1
*/
protected function resolveLanguageTranslationFilterIds(string $extension, string $translated, string $notTranslated): ?array
{
$ids = [];
$forceEmpty = false;
// Extension IDs
if (!empty($extension) && strpos($extension, '__') !== false)
{
[$type, $name] = explode('__', $extension, 2);
$extIds = FilterHelper::translation($name, $type);
if (!empty($extIds))
{
$ids = array_merge($ids, $extIds);
}
else
{
$forceEmpty = true;
}
}
// Translated IDs
if (!empty($translated))
{
$trIds = FilterHelper::translations($translated);
if (!empty($trIds))
{
$ids = array_merge($ids, $trIds);
}
else
{
$forceEmpty = true;
}
}
// Not translated IDs
if (!empty($notTranslated))
{
$untrIds = FilterHelper::translations($notTranslated, false);
if (!empty($untrIds))
{
$ids = array_merge($ids, $untrIds);
}
else
{
$forceEmpty = true;
}
}
if ($ids === [] && !$forceEmpty)
{
return [];
}
return $forceEmpty ? null : array_unique($ids);
}
/**
* Build a SQL WHERE clause using resolved IDs.
*
* @param array<int>|null $ids The record IDs to include in the query.
*
* @return array<string, array<string, mixed>> A structured WHERE clause.
* @since 5.1.1
*/
protected function buildLanguageTranslationWhereClause(?array $ids): array
{
if ($ids === [])
{
// return all published
return ['published' => ['value' => 1, 'operator' => '=', 'quote' => false]];
}
elseif ($ids === null)
{
// return none
return ['id' => ['value' => 0, 'operator' => '=', 'quote' => false]];
}
// return selected and published
return [
'id' => ['value' => $ids, 'operator' => 'IN', 'quote' => false],
'published' => ['value' => 1, 'operator' => '=', 'quote' => false]
];
}
/**
* Load translation rows from the database based on the given WHERE clause.
*
* @param array<string, array<string, mixed>>|null $where Optional WHERE clause.
*
* @return array<int, array<string, mixed>> Loaded records with 'source' and 'translation' keys.
* @since 5.1.1
*/
protected function loadLanguageTranslationRows(?array $where): array
{
return DataFactory::_('Load')->rows(
['source', 'translation'],
['language_translation'],
$where,
['source' => 'ASC']
);
}
/**
* Get the list of available language headers (e.g., ['en-GB' => 'en-GB']).
*
* This includes a default 'source' => 'source' entry.
*
* @return array<string, string> Associative list of language tags.
* @since 5.1.1
*/
protected function getLanguageTranslationHeaders(): array
{
return ComponentbuilderHelper::getLanguageTranslationsHeaders() ?? ['source' => 'source'];
}
/**
* Normalize translation records by mapping language keys and padding missing headers.
*
* @param array<int, array<string, mixed>> $rows Raw translation rows from the database.
* @param array<string, string> $headers Valid language header list.
*
* @return array<int, array<string, string>> Structured translation data ready for export.
* @since 5.1.1
*/
protected function normalizeLanguageTranslationData(array $rows, array $headers): array
{
$normalized = [];
foreach ($rows as $row)
{
$translations = json_decode($row['translation'] ?? '[]', true) ?: [];
unset($row['translation']);
// Pad all expected language headers
foreach ($headers as $lang => $_)
{
if ($lang === 'source')
{
continue;
}
$row[$lang] = '';
}
foreach ($translations as $entry)
{
$lang = $entry['language'] ?? '';
$text = trim(($entry['translation'] ?? ''));
if (isset($headers[$lang]) && trim($text) !== '')
{
$row[$lang] = $text;
}
}
$normalized[] = $row;
}
return $normalized;
}
/**
* Build a standardized error response with message.
*
* @param string $message Error message to return.
*
* @return array<string, mixed> Error response with 'data' as empty array and 'errors' as message.
* @since 5.1.1
*/
protected function errorLanguageTranslationResponse(string $message): array
{
return [
'data' => [],
'errors' => $message,
];
}
// Used in admin_fields_relations
public function getCodeGlueOptions($listfield, $joinfields, $type, $area)
{
admin/src/Model/Language_translationModel.php
-91
View File
@@ -29,10 +29,7 @@ use Joomla\Utilities\ArrayHelper;
use Joomla\Input\Input;
use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
use Joomla\CMS\Helper\TagsHelper;
use VDM\Joomla\Utilities\SessionHelper;
use VDM\Joomla\Utilities\StringHelper as UtilitiesStringHelper;
use VDM\Joomla\Utilities\ObjectHelper;
use VDM\Joomla\Utilities\GuidHelper;
use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper;
// No direct access to this file
@@ -118,62 +115,6 @@ class Language_translationModel extends AdminModel
return parent::getTable($type, $prefix, $config);
}
/**
* Retrieves or generates a Vast Development Method (VDM) key for the current item.
*
* This function performs the following operations:
* 1. Checks if the VDM key is already set. If not, it proceeds to generate or retrieve one.
* 2. Determines the item ID based on the presence of a specific argument.
* 3. Attempts to retrieve an existing VDM key from a helper method using the item ID.
* 4. If a VDM key is not found, it generates a new random VDM key.
* 5. Stores the VDM key and associates it with the item ID in a helper method.
* 6. Optionally, stores return and GUID values if available.
* 7. Returns the VDM key.
*
* @return string The VDM key for the current item.
*/
public function getVDM()
{
if (!isset($this->vastDevMod))
{
$_id = 0; // new item probably (since it was not set in the getItem method)
if (empty($_id))
{
$id = 0;
}
else
{
$id = $_id;
}
// set the id and view name to session
if (($vdm = SessionHelper::get('language_translation__'.$id)) !== null)
{
$this->vastDevMod = $vdm;
}
else
{
// set the vast development method key
$this->vastDevMod = UtilitiesStringHelper::random(50);
SessionHelper::set($this->vastDevMod, 'language_translation__'.$id);
SessionHelper::set('language_translation__'.$id, $this->vastDevMod);
// set a return value if found
$jinput = Factory::getApplication()->input;
$return = $jinput->get('return', null, 'base64');
SessionHelper::set($this->vastDevMod . '__return', $return);
// set a GUID value if found
if (isset($item) && ObjectHelper::check($item) && isset($item->guid)
&& GuidHelper::valid($item->guid))
{
SessionHelper::set($this->vastDevMod . '__guid', $item->guid);
}
}
}
return $this->vastDevMod;
}
/**
* Method to get a single record.
*
@@ -233,38 +174,6 @@ class Language_translationModel extends AdminModel
$translation->loadString($item->translation);
$item->translation = $translation->toArray();
}
if (empty($item->id))
{
$id = 0;
}
else
{
$id = $item->id;
}
// set the id and view name to session
if (($vdm = SessionHelper::get('language_translation__'.$id)) !== null)
{
$this->vastDevMod = $vdm;
}
else
{
// set the vast development method key
$this->vastDevMod = UtilitiesStringHelper::random(50);
SessionHelper::set($this->vastDevMod, 'language_translation__'.$id);
SessionHelper::set('language_translation__'.$id, $this->vastDevMod);
// set a return value if found
$jinput = Factory::getApplication()->input;
$return = $jinput->get('return', null, 'base64');
SessionHelper::set($this->vastDevMod . '__return', $return);
// set a GUID value if found
if (isset($item) && ObjectHelper::check($item) && isset($item->guid)
&& GuidHelper::valid($item->guid))
{
SessionHelper::set($this->vastDevMod . '__guid', $item->guid);
}
}
}
return $item;
admin/src/Model/Language_translationsModel.php
-100
View File
@@ -28,7 +28,6 @@ use VDM\Joomla\Componentbuilder\Utilities\FilterHelper as JCBFilterHelper;
use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper;
use VDM\Joomla\Utilities\ObjectHelper;
use VDM\Joomla\Utilities\StringHelper;
use VDM\Joomla\Utilities\JsonHelper;
use Joomla\CMS\Form\Form;
// No direct access to this file
@@ -282,55 +281,6 @@ class Language_translationsModel extends ListModel
}
}
}
// prep the lang strings for export
if (isset($_export) && $_export && UtilitiesArrayHelper::check($items))
{
// insure we have the same order in the languages
$languages = ComponentbuilderHelper::getVars('language', 1, 'published', 'langtag');
foreach ($items as $nr => &$item)
{
// remove some values completely
unset($item->components);
unset($item->modules);
unset($item->plugins);
unset($item->params);
unset($item->published);
unset($item->created_by);
unset($item->modified_by);
unset($item->created);
unset($item->modified);
unset($item->version);
unset($item->hits);
unset($item->access);
unset($item->ordering);
// set the lang order
if ($nr != 0)
{
foreach ($languages as $lanTag)
{
$item->{$lanTag} = '';
}
// now adapt the source
if (isset($item->translation) && JsonHelper::check($item->translation))
{
$translations = json_decode($item->translation, true);
if (UtilitiesArrayHelper::check($translations))
{
foreach ($translations as $language)
{
if (isset($language['translation']) && StringHelper::check($language['translation'])
&& isset($language['language']) && StringHelper::check($language['language']))
{
$item->{$language['language']} = $language['translation'];
}
}
}
}
}
// remove translation
unset($item->translation);
}
}
// return items
return $items;
@@ -606,56 +556,6 @@ class Language_translationsModel extends ListModel
{
array_unshift($items,$headers);
}
// prep the lang strings for export
if (isset($_export) && $_export && UtilitiesArrayHelper::check($items))
{
// insure we have the same order in the languages
$languages = ComponentbuilderHelper::getVars('language', 1, 'published', 'langtag');
foreach ($items as $nr => &$item)
{
// remove some values completely
unset($item->components);
unset($item->modules);
unset($item->plugins);
unset($item->params);
unset($item->published);
unset($item->created_by);
unset($item->modified_by);
unset($item->created);
unset($item->modified);
unset($item->version);
unset($item->hits);
unset($item->access);
unset($item->ordering);
// set the lang order
if ($nr != 0)
{
foreach ($languages as $lanTag)
{
$item->{$lanTag} = '';
}
// now adapt the source
if (isset($item->translation) && JsonHelper::check($item->translation))
{
$translations = json_decode($item->translation, true);
if (UtilitiesArrayHelper::check($translations))
{
foreach ($translations as $language)
{
if (isset($language['translation']) && StringHelper::check($language['translation'])
&& isset($language['language']) && StringHelper::check($language['language']))
{
$item->{$language['language']} = $language['translation'];
}
}
}
}
}
// remove translation
unset($item->translation);
}
}
return $items;
}
}
admin/src/Model/RepositoriesModel.php
+116 -10
View File
@@ -23,9 +23,11 @@ use Joomla\Utilities\ArrayHelper;
use Joomla\Input\Input;
use VDM\Component\Componentbuilder\Administrator\Helper\ComponentbuilderHelper;
use Joomla\CMS\Helper\TagsHelper;
use VDM\Joomla\Utilities\FormHelper;
use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper;
use VDM\Joomla\Utilities\ObjectHelper;
use VDM\Joomla\Utilities\StringHelper;
use Joomla\CMS\Form\Form;
// No direct access to this file
\defined('_JEXEC') or die;
@@ -89,8 +91,8 @@ class RepositoriesModel extends ListModel
'a.organisation','organisation',
'a.repository','repository',
'a.target','target',
'a.base','base',
'a.type','type'
'a.type','type',
'a.base','base'
);
}
@@ -99,6 +101,48 @@ class RepositoriesModel extends ListModel
$this->app ??= Factory::getApplication();
}
/**
* Get the filter form - Override the parent method
*
* @param array $data data
* @param boolean $loadData load current data
*
* @return Form|boolean The Form object or false on error
*
* @since JCB 2.12.5
*/
public function getFilterForm($data = array(), $loadData = true)
{
// load form from the parent class
$form = parent::getFilterForm($data, $loadData);
// Create the "read write branch" filter
$attributes = array(
'name' => 'branch',
'type' => 'list',
'onchange' => 'this.form.submit();',
);
$options = [
'' => '- ' . Text::_('COM_COMPONENTBUILDER_SELECT_BRANCH_STATE') . ' -',
'write' => Text::_('COM_COMPONENTBUILDER_WRITE_BRANCH_SET'),
'no_write' => Text::_('COM_COMPONENTBUILDER_NO_WRITE_BRANCH_SET'),
'read' => Text::_('COM_COMPONENTBUILDER_READ_BRANCH_SET'),
'no_read' => Text::_('COM_COMPONENTBUILDER_NO_READ_BRANCH_SET'),
'both' => Text::_('COM_COMPONENTBUILDER_BOTH_BRANCHES_SET'),
'none' => Text::_('COM_COMPONENTBUILDER_NO_BRANCHES_SET')
];
$form->setField(FormHelper::xml($attributes, $options),'filter');
$form->setValue(
'branch',
'filter',
$this->state->get("filter.branch")
);
array_push($this->filter_fields, 'branch');
return $form;
}
/**
* Method to auto-populate the model state.
*
@@ -166,13 +210,6 @@ class RepositoriesModel extends ListModel
$this->setState('filter.target', $target);
}
$base = $this->getUserStateFromRequest($this->context . '.filter.base', 'filter_base');
if ($formSubmited)
{
$base = $app->input->post->get('base');
$this->setState('filter.base', $base);
}
$type = $this->getUserStateFromRequest($this->context . '.filter.type', 'filter_type');
if ($formSubmited)
{
@@ -180,6 +217,13 @@ class RepositoriesModel extends ListModel
$this->setState('filter.type', $type);
}
$base = $this->getUserStateFromRequest($this->context . '.filter.base', 'filter_base');
if ($formSubmited)
{
$base = $app->input->post->get('base');
$this->setState('filter.base', $base);
}
// List state information.
parent::populateState($ordering, $direction);
}
@@ -298,6 +342,51 @@ class RepositoriesModel extends ListModel
// From the componentbuilder_item table
$query->from($db->quoteName('#__componentbuilder_repository', 'a'));
// Filtering by "branch"
$filterBranch = $this->state->get('filter.branch');
// Ensure the filter value is a string and not empty
if (is_string($filterBranch) && $filterBranch !== '')
{
$readBranch = 'CHAR_LENGTH(TRIM(' . $db->quoteName('a.read_branch') . '))';
$writeBranch = 'CHAR_LENGTH(TRIM(' . $db->quoteName('a.write_branch') . '))';
switch ($filterBranch)
{
case 'both':
// Both read_branch and write_branch must be set
$query->where("{$readBranch} > 1");
$query->where("{$writeBranch} > 1");
break;
case 'none':
// Neither read_branch nor write_branch must be set
$query->where("{$readBranch} = 0");
$query->where("{$writeBranch} = 0");
break;
case 'read':
// Only read_branch must be set
$query->where("{$readBranch} > 1");
break;
case 'write':
// Only write_branch must be set
$query->where("{$writeBranch} > 1");
break;
case 'no_read':
// Only read_branch must NOT be set
$query->where("{$readBranch} = 0");
break;
case 'no_write':
// Only write_branch must NOT be set
$query->where("{$writeBranch} = 0");
break;
}
}
// Filter by published state
$published = $this->getState('filter.published');
if (is_numeric($published))
@@ -397,6 +486,23 @@ class RepositoriesModel extends ListModel
{
$query->where('a.target = ' . $db->quote($db->escape($_target)));
}
// Filter by Type.
$_type = $this->getState('filter.type');
if (is_numeric($_type))
{
if (is_float($_type))
{
$query->where('a.type = ' . (float) $_type);
}
else
{
$query->where('a.type = ' . (int) $_type);
}
}
elseif (StringHelper::check($_type))
{
$query->where('a.type = ' . $db->quote($db->escape($_type)));
}
// Filter by Base.
$_base = $this->getState('filter.base');
if (is_numeric($_base))
@@ -458,8 +564,8 @@ class RepositoriesModel extends ListModel
$id .= ':' . $this->getState('filter.organisation');
$id .= ':' . $this->getState('filter.repository');
$id .= ':' . $this->getState('filter.target');
$id .= ':' . $this->getState('filter.base');
$id .= ':' . $this->getState('filter.type');
$id .= ':' . $this->getState('filter.base');
return parent::getStoreId($id);
}