Release of v5.1.1-beta3

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.
This commit is contained in:
2025-06-23 17:02:17 +00:00
parent 3c1057a830
commit dbebb5663c
28 changed files with 2067 additions and 888 deletions

View File

@@ -9,7 +9,7 @@ This is a professional-grade [Joomla 5.x](https://extensions.joomla.org/extensio
JCB generates native Joomla components, plugins, and modules for Joomla 3.x, 4.x, and 5.x — and is already prepared for Joomla 6. Every compiled project is tailored for the specific version without needing backward compatibility plugins. With integrated version-aware compiling, smart boilerplating, and Git-powered project syncing, JCB is much more than a code generator—it's a **full-stack development pipeline for Joomla extensions**.
You can install this component easily. The latest release (**5.1.1-beta2**) is available on [Releases](https://git.vdm.dev/joomla/pkg-component-builder/releases) and updated frequently with full source access.
You can install this component easily. The latest release (**5.1.1-beta3**) is available on [Releases](https://git.vdm.dev/joomla/pkg-component-builder/releases) and updated frequently with full source access.
Upgrades are seamless through Joomlas built-in extension update mechanism.
@@ -229,9 +229,9 @@ JCB is developed by developers for developers. Its purpose is to democratize hig
* **Company:** [Vast Development Method](https://dev.vdm.io)
* **Author:** [Llewellyn van der Merwe](mailto:joomla@vdm.io)
* **Component:** [Component Builder](https://git.vdm.dev/joomla/Component-Builder)
* **Created:** 30th April, 2015 · **Last Build:** 19th June, 2025 · **Version:** 5.1.1-beta2
* **Created:** 30th April, 2015 · **Last Build:** 23rd June, 2025 · **Version:** 5.1.1-beta3
* **License:** GNU General Public License version 2 or later; see LICENSE.txt · **Copyright:** Copyright (C) 2015 Vast Development Method. All rights reserved.
* **Lines:** 1086810 · **Fields:** 2096 · **Files:** 7419 · **Folders:** 724
* **Lines:** 1090382 · **Fields:** 2096 · **Files:** 7450 · **Folders:** 725
> Generated with [JCB](https://www.joomlacomponentbuilder.com) — The Smartest Way to Build Joomla Extensions.

View File

@@ -27,6 +27,24 @@ namespace ###NAMESPACEPREFIX###\Component\###ComponentNamespace###\Administrator
*/
class ###Component###Model extends ListModel
{
/**
* Represents the current user object.
*
* @var User The user object representing the current user.
* @since 3.2.0
*/
protected User $user;
/**
* View groups of this component
*
* @var array<string, string>
* @since 5.1.1
*/
protected array $viewGroups = [
'main' => [###DASHBOARDICONS###],
];
###DASHBOARDICONACCESS###
/**
* The styles array.
*
@@ -48,199 +66,50 @@ class ###Component###Model extends ListModel
'administrator/components/com_###component###/assets/js/admin.js'
];
public function getIcons()
/**
* Constructor
*
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
* @param ?MVCFactoryInterface $factory The factory.
*
* @since 1.6
* @throws \Exception
*/
public function __construct($config = [], MVCFactoryInterface $factory = null)
{
// load user for access menus
$user = Joomla___39403062_84fb_46e0_bac4_0023f766e827___Power::getApplication()->getIdentity();
// reset icon array
$icons = [];
// view groups array
$viewGroups = array(
'main' => array(###DASHBOARDICONS###)
);###DASHBOARDICONACCESS###
// loop over the $views
foreach($viewGroups as $group => $views)
parent::__construct($config, $factory);
$this->user ??= $this->getCurrentUser();
}
/**
* Get dashboard icons, grouped by view sections.
*
* @return array<string, array<int, \stdClass|false>>
* @since 5.1.1
*/
public function getIcons(): array
{
$icons = [];
foreach ($this->viewGroups as $group => $views)
{
$i = 0;
if (Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check($views))
if (!Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check($views))
{
foreach($views as $view)
$icons[$group][] = false;
continue;
}
foreach ($views as $view)
{
$icon = $this->buildIconObject($view);
if ($icon !== null)
{
$add = false;
// external views (links)
if (strpos($view,'||') !== false)
{
$dwd = explode('||', $view);
if (count($dwd) == 3)
{
list($type, $name, $url) = $dwd;
$viewName = $name;
$alt = $name;
$url = $url;
$image = $name . '.' . $type;
$name = 'COM_###COMPONENT###_DASHBOARD_' . Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name,'U');
}
}
// internal views
elseif (strpos($view,'.') !== false)
{
$dwd = explode('.', $view);
if (count($dwd) == 3)
{
list($type, $name, $action) = $dwd;
}
elseif (count($dwd) == 2)
{
list($type, $name) = $dwd;
$action = false;
}
if ($action)
{
$viewName = $name;
switch($action)
{
case 'add':
$url = 'index.php?option=com_###component###&view=' . $name . '&layout=edit';
$image = $name . '_' . $action. '.' . $type;
$alt = $name . '&nbsp;' . $action;
$name = 'COM_###COMPONENT###_DASHBOARD_'.Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name,'U').'_ADD';
$add = true;
break;
default:
// check for new convention (more stable)
if (strpos($action, '_qpo0O0oqp_') !== false)
{
list($action, $extension) = (array) explode('_qpo0O0oqp_', $action);
$extension = str_replace('_po0O0oq_', '.', $extension);
}
else
{
$extension = 'com_###component###.' . $name;
}
$url = 'index.php?option=com_categories&view=categories&extension=' . $extension;
$image = $name . '_' . $action . '.' . $type;
$alt = $viewName . '&nbsp;' . $action;
$name = 'COM_###COMPONENT###_DASHBOARD_' . Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name,'U') . '_' . Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($action,'U');
break;
}
}
else
{
$viewName = $name;
$alt = $name;
$url = 'index.php?option=com_###component###&view=' . $name;
$image = $name . '.' . $type;
$name = 'COM_###COMPONENT###_DASHBOARD_' . Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name,'U');
$hover = false;
}
}
else
{
$viewName = $view;
$alt = $view;
$url = 'index.php?option=com_###component###&view=' . $view;
$image = $view . '.png';
$name = ucwords($view).'<br /><br />';
$hover = false;
}
// first make sure the view access is set
if (Super___0a59c65c_9daf_4bc9_baf4_e063ff9e6a8a___Power::check($viewAccess))
{
// setup some defaults
$dashboard_add = false;
$dashboard_list = false;
$accessTo = '';
$accessAdd = '';
// access checking start
$accessCreate = (isset($viewAccess[$viewName.'.create'])) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($viewAccess[$viewName.'.create']):false;
$accessAccess = (isset($viewAccess[$viewName.'.access'])) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($viewAccess[$viewName.'.access']):false;
// set main controllers
$accessDashboard_add = (isset($viewAccess[$viewName.'.dashboard_add'])) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($viewAccess[$viewName.'.dashboard_add']):false;
$accessDashboard_list = (isset($viewAccess[$viewName.'.dashboard_list'])) ? Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($viewAccess[$viewName.'.dashboard_list']):false;
// check for adding access
if ($add && $accessCreate)
{
$accessAdd = $viewAccess[$viewName.'.create'];
}
elseif ($add)
{
$accessAdd = 'core.create';
}
// check if access to view is set
if ($accessAccess)
{
$accessTo = $viewAccess[$viewName.'.access'];
}
// set main access controllers
if ($accessDashboard_add)
{
$dashboard_add = $user->authorise($viewAccess[$viewName.'.dashboard_add'], 'com_###component###');
}
if ($accessDashboard_list)
{
$dashboard_list = $user->authorise($viewAccess[$viewName.'.dashboard_list'], 'com_###component###');
}
if (Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($accessAdd) && Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($accessTo))
{
// check access
if($user->authorise($accessAdd, 'com_###component###') && $user->authorise($accessTo, 'com_###component###') && $dashboard_add)
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
elseif (Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($accessTo))
{
// check access
if($user->authorise($accessTo, 'com_###component###') && $dashboard_list)
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
elseif (Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($accessAdd))
{
// check access
if($user->authorise($accessAdd, 'com_###component###') && $dashboard_add)
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
else
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
else
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
$i++;
$icons[$group][] = $icon;
}
}
else
{
$icons[$group][$i] = false;
}
}
return $icons;
}
@@ -286,5 +155,188 @@ class ###Component###Model extends ListModel
public function setScript(string $path): void
{
$this->scripts[] = $path;
}
/**
* Build a single dashboard icon if access is granted.
*
* @param string $view The view string to parse.
*
* @return \stdClass|null The icon object or null if access denied.
* @since 5.1.1
*/
protected function buildIconObject(string $view): ?\stdClass
{
$parsed = $this->parseViewDefinition($view);
if (!$parsed)
{
return null;
}
[
'type' => $type,
'name' => $name,
'url' => $url,
'image' => $image,
'alt' => $alt,
'viewName' => $viewName,
'add' => $add,
] = $parsed;
if (!$this->hasAccessToView($viewName, $add))
{
return null;
}
return $this->createIconObject($url, $name, $image, $alt);
}
/**
* Parse a view string into structured components.
*
* @param string $view The view definition string.
*
* @return array<string, mixed>|null Parsed values or null on failure.
* @since 5.1.1
*/
protected function parseViewDefinition(string $view): ?array
{
$add = false;
if (strpos($view, '||') !== false)
{
$parts = explode('||', $view);
if (count($parts) === 3)
{
[$type, $name, $url] = $parts;
return [
'type' => $type,
'name' => 'COM_###COMPONENT###_DASHBOARD_' . Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name, 'U'),
'url' => $url,
'image' => "{$name}.{$type}",
'alt' => $name,
'viewName' => $name,
'add' => false,
];
}
}
if (strpos($view, '.') !== false)
{
$parts = explode('.', $view);
$type = $parts[0] ?? '';
$name = $parts[1] ?? '';
$action = $parts[2] ?? null;
$viewName = $name;
if ($action)
{
if ($action === 'add')
{
$url = "index.php?option=com_###component###&view={$name}&layout=edit";
$image = "{$name}_{$action}.{$type}";
$alt = "{$name}&nbsp;{$action}";
$name = 'COM_###COMPONENT###_DASHBOARD_' .
Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name, 'U') . '_ADD';
$add = true;
}
else
{
if (strpos($action, '_qpo0O0oqp_') !== false)
{
[$action, $ext] = explode('_qpo0O0oqp_', $action);
$extension = str_replace('_po0O0oq_', '.', $ext);
}
else
{
$extension = "com_###component###.{$name}";
}
$url = "index.php?option=com_categories&view=categories&extension={$extension}";
$image = "{$name}_{$action}.{$type}";
$alt = "{$name}&nbsp;{$action}";
$name = 'COM_###COMPONENT###_DASHBOARD_' .
Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name, 'U') . '_' .
Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($action, 'U');
}
}
else
{
$url = "index.php?option=com_###component###&view={$name}";
$image = "{$name}.{$type}";
$alt = $name;
$name = 'COM_###COMPONENT###_DASHBOARD_' .
Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::safe($name, 'U');
}
return compact('type', 'name', 'url', 'image', 'alt', 'viewName', 'add');
}
return [
'type' => 'png',
'name' => ucwords($view) . '<br /><br />',
'url' => "index.php?option=com_###component###&view={$view}",
'image' => "{$view}.png",
'alt' => $view,
'viewName' => $view,
'add' => false,
];
}
/**
* Determine if the user has access to view or create the item.
*
* @param string $viewName The base name of the view.
* @param bool $add If this is an add-action.
*
* @return bool
* @since 5.1.1
*/
protected function hasAccessToView(string $viewName, bool $add): bool
{
$viewAccess = $this->viewAccess;
$accessAdd = $add && isset($viewAccess["{$viewName}.create"])
? $viewAccess["{$viewName}.create"]
: ($add ? 'core.create' : '');
$accessTo = $viewAccess["{$viewName}.access"] ?? '';
$dashboardAdd = isset($viewAccess["{$viewName}.dashboard_add"]) &&
$this->user->authorise($viewAccess["{$viewName}.dashboard_add"], 'com_###component###');
$dashboardList = isset($viewAccess["{$viewName}.dashboard_list"]) &&
$this->user->authorise($viewAccess["{$viewName}.dashboard_list"], 'com_###component###');
if ($add && Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($accessAdd))
{
return $this->user->authorise($accessAdd, 'com_###component###') && $dashboardAdd;
}
if (Super___1f28cb53_60d9_4db1_b517_3c7dc6b429ef___Power::check($accessTo))
{
return $this->user->authorise($accessTo, 'com_###component###') && $dashboardList;
}
return !$accessTo && !$accessAdd;
}
/**
* Create a \stdClass icon object.
*
* @param string $url Icon URL.
* @param string $name Language string or label.
* @param string $image Image filename.
* @param string $alt Alt text.
*
* @return \stdClass
* @since 5.1.1
*/
protected function createIconObject(string $url, string $name, string $image, string $alt): \stdClass
{
$icon = new \stdClass;
$icon->url = $url;
$icon->name = $name;
$icon->image = $image;
$icon->alt = $alt;
return $icon;
}###DASH_MODEL_METHODS###
}

View File

@@ -28,6 +28,60 @@ namespace ###NAMESPACEPREFIX###\Component\###ComponentNamespace###\Administrator
#[\AllowDynamicProperties]
class HtmlView extends BaseHtmlView
{
/**
* @var array<string> List of icon identifiers to render in the dashboard view.
* @since 1.6
*/
public array $icons = [];
/**
* @var array<string> List of CSS file URLs to be added to the page.
* @since 4.3
*/
public array $styles = [];
/**
* @var array<string> List of JavaScript file URLs to be included on the page.
* @since 4.3
*/
public array $scripts = [];
/**
* @var array<int, object> List of contributor objects fetched via the helper.
* @since 1.6
*/
public array $contributors = [];
/**
* @var object|null The manifest metadata of the component as returned by `ComponentbuilderHelper::manifest()`.
* @since 1.6
*/
public $manifest = null;
/**
* @var string|null Markdown content of the component's wiki page.
* @since 1.6
*/
public ?string $wiki = null;
/**
* @var string|null The rendered or raw README markdown of the component.
* @since 1.6
*/
public ?string $readme = null;
/**
* @var string|null The current version of the component.
* @since 1.6
*/
public ?string $version = null;
/**
* @var string|null Help URL for the component dashboard view, if available.
* @since 1.6
*/
public ?string $help_url = null;
/**
* View display method
*
@@ -96,8 +150,12 @@ class HtmlView extends BaseHtmlView
{
// set page title
$this->getDocument()->setTitle(Joomla___ba6326ef_cb79_4348_80f4_ab086082e3c5___Power::_('COM_###COMPONENT###_DASHBOARD'));
// add manifest to page JavaScript
$this->getDocument()->addScriptDeclaration("var manifest = JSON.parse(" . json_encode($this->manifest) . ");", "text/javascript");
/** \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = $this->getDocument()->getWebAssetManager();
// Register the inline script with properly encoded JSON
$wa->addInlineScript(
'var manifest = ' . json_encode($this->manifest, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) . ';'
);
// add styles
foreach ($this->styles as $style)
{

View File

@@ -3293,7 +3293,7 @@ COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_STATE_DESCRIPTION="Set the release
COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_STATE_HINT="stable"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_STATE_LABEL="Release State"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_TARGET_VERSION_DESCRIPTION="Set the release target version"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_TARGET_VERSION_HINT="5\.[012]"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_TARGET_VERSION_HINT="5\.[0123]"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_UPDATE_TARGET_VERSION_LABEL="Update Server Release Target Version"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_URL_DESCRIPTION="Enter Download Link"
COM_COMPONENTBUILDER_COMPONENT_UPDATES_URL_HINT="http://www.example.com/file.zip"
@@ -5258,11 +5258,10 @@ COM_COMPONENTBUILDER_FREEOPEN="Free/Open"
COM_COMPONENTBUILDER_FULL_WIDTH_IN_TAB="Full Width in Tab"
COM_COMPONENTBUILDER_FUNCTION_NAME_ALREADY_TAKEN_PLEASE_TRY_AGAIN="Function name already taken, please try again."
COM_COMPONENTBUILDER_GET_PACKAGE="Get Package"
COM_COMPONENTBUILDER_GET_TOKEN="Get Token"
COM_COMPONENTBUILDER_GET_TOKEN_FROM_VDM_TO_GET_UPDATE_NOTICE_AND_ADD_IT_TO_YOUR_GLOBAL_OPTIONS="Get token from VDM to get update notice, and add it to your global options."
COM_COMPONENTBUILDER_GIVE_TO_JCB="Give to JCB"
COM_COMPONENTBUILDER_GLOBAL="Global"
COM_COMPONENTBUILDER_GLUECODE="Glue/Code"
COM_COMPONENTBUILDER_GRAB_THE_LATEST_S_TESTING_RELEASE="Grab the latest %s testing release!"
COM_COMPONENTBUILDER_GREAT_THIS_FUNCTION_NAME_WILL_WORK="Great, this function name will work!"
COM_COMPONENTBUILDER_GREAT_THIS_PLACEHOLDER_WILL_WORK="Great, this placeholder will work!"
COM_COMPONENTBUILDER_GREAT_THIS_VALIDATION_RULE_NAME_S_WILL_WORK="Great, this validation rule name (%s) will work!"
@@ -5370,6 +5369,7 @@ COM_COMPONENTBUILDER_HELP_DOCUMENT_VERSION_DESC="A count of the number of times
COM_COMPONENTBUILDER_HELP_DOCUMENT_VERSION_LABEL="Version"
COM_COMPONENTBUILDER_HELP_JCB_GROW="Help JCB Grow"
COM_COMPONENTBUILDER_HELP_MANAGER="Help"
COM_COMPONENTBUILDER_HELP_US_TEST_THE_UPCOMING_RELEASE="Help us test the upcoming release!"
COM_COMPONENTBUILDER_HERE_YOU_CAN_ENTER_THE_REPLACE_TEXT_THAT_YOU_WOULD_LIKE_TO_USE_AS_REPLACEMENT_FOR_THE_SEARCH_TEXT_FOUND="Here you can enter the replace text that you would like to use as replacement for the search text found."
COM_COMPONENTBUILDER_HERE_YOU_CAN_ENTER_YOUR_SEARCH_TEXT="Here you can enter your search text."
COM_COMPONENTBUILDER_HERE_YOU_CAN_SET_THE_PATH_TO_THE_SUPER_POWERS_LOCAL_REPOSITORY_FOLDER_WHERE_BLAYERCOREB_AND_ALL_TARGETED_BLAYEROWNB_SUB_PATHS_WILL_BE_PLACED_WITH_THEIR_SELECTIVE_BSWITCHAPPROVEDB_POWERS="Here you can set the path to the super powers local repository folder, where <b>[layer:core]</b> and all targeted <b>[layer:own]</b> sub paths will be placed with their selective <b>[switch:approved]</b> powers."
@@ -7630,7 +7630,6 @@ COM_COMPONENTBUILDER_NO_ADMIN_VIEWS_FOUND="No Admin Views Found"
COM_COMPONENTBUILDER_NO_CHANGE_S_ITEM_S_IN_REPO_S_IS_ALREADY_IN_SYNC="NO CHANGE: %s item [%s] in repo (%s) is already in sync."
COM_COMPONENTBUILDER_NO_COMPONENTS_FOUND="No Components Found"
COM_COMPONENTBUILDER_NO_COMPONENT_DETAILS_FOUND_SO_IT_IS_NOT_SAFE_TO_CONTINUE="No component details found, so it is not safe to continue!"
COM_COMPONENTBUILDER_NO_CRONJOB_PATHS_WAS_REMOVED_WE_WILL_CHANGE_TO_WORKFLOWS_SOON="No cronjob paths was removed, we will change to workflows soon."
COM_COMPONENTBUILDER_NO_DESCRIPTION_FOUND="No description found."
COM_COMPONENTBUILDER_NO_FIELDS_WHERE_SELECTED="No fields where selected!"
COM_COMPONENTBUILDER_NO_FILES_LINKED="No Files Linked"
@@ -8035,7 +8034,7 @@ COM_COMPONENTBUILDER_REPOSITORIES_N_ITEMS_UNPUBLISHED_1="%s Repository unpublish
COM_COMPONENTBUILDER_REPOSITORIES_SUBMENU="Repositories Submenu"
COM_COMPONENTBUILDER_REPOSITORIES_SUBMENU_DESC="Allows the users in this group to submenu of repository"
COM_COMPONENTBUILDER_REPOSITORY="Repository"
COM_COMPONENTBUILDER_REPOSITORY_ACCESS_REPO_DESCRIPTION="Set the access options to this repository. Global is only applicable to <b>git.vdm.dev</b> repos."
COM_COMPONENTBUILDER_REPOSITORY_ACCESS_REPO_DESCRIPTION="Set the access options to this repository. Global is only applicable to <b>github.com</b> and <b>git.vdm.dev</b> repos."
COM_COMPONENTBUILDER_REPOSITORY_ACCESS_REPO_LABEL="Access"
COM_COMPONENTBUILDER_REPOSITORY_ADDPLACEHOLDERS_DESCRIPTION="Set dnamic placeholders for this component."
COM_COMPONENTBUILDER_REPOSITORY_ADDPLACEHOLDERS_LABEL="Placeholders"
@@ -9144,6 +9143,7 @@ COM_COMPONENTBUILDER_TEMPLATE_TEMPLATE_LABEL="Template"
COM_COMPONENTBUILDER_TEMPLATE_VERSION_DESC="A count of the number of times this Template has been revised."
COM_COMPONENTBUILDER_TEMPLATE_VERSION_LABEL="Version"
COM_COMPONENTBUILDER_TEMPLATE_YES="Yes"
COM_COMPONENTBUILDER_THANK_YOU_FOR_TESTING_THE_S_RELEASE_YOURE_A_JCB_HERO="Thank you for testing the %s release — you're a JCB hero!"
COM_COMPONENTBUILDER_THERE_HAS_BEEN_AN_ERROR_IF_THIS_CONTINUES_PLEASE_INFORM_YOUR_SYSTEM_ADMINISTRATOR_OF_A_TYPE_ERROR_IN_THE_FIELDS_DISPLAY_REQUEST="There has been an error, if this continues please inform your system administrator of a type error in the fields display request!"
COM_COMPONENTBUILDER_THERE_HAS_BEEN_AN_ERROR_PLEASE_TRY_AGAIN="There has been an error please try again"
COM_COMPONENTBUILDER_THERE_WAS_AN_ERROR_GETTING_THE_PACKAGE_INFO="There was an error getting the package info."

View File

@@ -3022,8 +3022,8 @@ INSERT INTO `#__componentbuilder_repository` (`id`, `system_name`, `organisation
(17, 'Openai (codeberg - mirror)', 'joomla', 'openai', 1, 1, 'https://codeberg.org', 'c625381a-7795-4b9f-8b4e-997c9291e3fc', 'master', 1, 17, 1, '2025-06-17 21:47:49', '2024-06-10 11:03:19', '', '{}'),
(18, 'Joomla Powers (codeberg - mirror)', 'joomla', 'joomla-powers', 2, 1, 'https://codeberg.org', '8ac595d4-0b1d-4877-ba3e-2b815c1c7e3c', 'master', 1, 18, 1, '2025-06-17 21:47:22', '2024-07-08 14:07:31', '', '{}'),
(19, 'Joomla Field Types (codeberg - mirror)', 'joomla', 'joomla-fieldtypes', 3, 1, 'https://codeberg.org', 'bf4a1d77-e3a4-4aa8-a07f-2b01872bf7e9', 'master', 1, 19, 1, '2025-06-17 21:48:25', '2024-08-23 16:21:35', '', '{}'),
(20, 'Official Packages', 'joomengine', 'packages', 4, 2, 'https://api.github.com', '562624ab-48bf-4979-9a14-6b10cf3635de', 'master', 1, 20, 1, '2025-06-18 10:39:24', '2025-05-31 08:47:01', '', '{}'),
(21, 'Official Snippets', 'joomengine', 'snippets', 5, 2, 'https://api.github.com', '70e85588-bc28-4459-9b29-858f68faae8f', 'master', 1, 21, 1, '2025-06-18 18:46:05', '2025-06-18 10:35:14', '', '{}');
(20, 'Official Packages (github - mirror)', 'joomengine', 'packages', 4, 2, 'https://api.github.com', '562624ab-48bf-4979-9a14-6b10cf3635de', 'master', 1, 20, 1, '2025-06-23 16:46:09', '2025-05-31 08:47:01', '', '{}'),
(21, 'Official Packages (github - mirror)', 'joomengine', 'snippets', 5, 2, 'https://api.github.com', '70e85588-bc28-4459-9b29-858f68faae8f', 'master', 1, 21, 1, '2025-06-23 16:46:13', '2025-06-18 10:35:14', '', '{}');
--
-- Dumping data for table `#__componentbuilder_help_document`

View File

@@ -50,7 +50,6 @@ class AjaxController extends BaseController
$this->app->setHeader('Access-Control-Allow-Origin', '*');
// load the tasks
$this->registerTask('getComponentDetails', 'ajax');
$this->registerTask('getCronPath', 'ajax');
$this->registerTask('getWiki', 'ajax');
$this->registerTask('getVersion', 'ajax');
$this->registerTask('getJCBpackageInfo', 'ajax');
@@ -168,55 +167,6 @@ class AjaxController extends BaseController
}
}
break;
case 'getCronPath':
try
{
$getTypeValue = $jinput->get('getType', NULL, 'WORD');
if($getTypeValue && $user->id != 0)
{
$ajaxModule = $this->getModel('ajax', 'Administrator');
if ($ajaxModule)
{
$result = $ajaxModule->getCronPath($getTypeValue);
}
else
{
$result = ['error' => 'There was an error! [149]'];
}
}
else
{
$result = ['error' => 'There was an error! [149]'];
}
if($callback)
{
echo $callback . "(".json_encode($result).");";
}
elseif($returnRaw)
{
echo json_encode($result);
}
else
{
echo "(".json_encode($result).");";
}
}
catch(\Exception $e)
{
if($callback)
{
echo $callback."(".json_encode($e).");";
}
elseif($returnRaw)
{
echo json_encode($e);
}
else
{
echo "(".json_encode($e).");";
}
}
break;
case 'getWiki':
try
{

View File

@@ -33,6 +33,8 @@ use VDM\Joomla\Utilities\JsonHelper;
use VDM\Joomla\Utilities\StringHelper;
use VDM\Joomla\Componentbuilder\Search\Factory as SearchFactory;
use VDM\Joomla\Utilities\GuidHelper;
use VDM\Joomla\Componentbuilder\Remote\Version;
use VDM\Joomla\Github\Factory as GithubFactory;
use VDM\Joomla\Utilities\ArrayHelper as UtilitiesArrayHelper;
use VDM\Joomla\Utilities\GetHelper;
use VDM\Joomla\Utilities\SessionHelper;
@@ -276,172 +278,46 @@ class AjaxModel extends ListModel
return implode("\n", $html);
}
/**
* Will be removed, since we will change to workflows soon :)
*/
public function getCronPath($type)
{
return ['error' => '<span style="color: red;">' . Text::_('COM_COMPONENTBUILDER_NO_CRONJOB_PATHS_WAS_REMOVED_WE_WILL_CHANGE_TO_WORKFLOWS_SOON') . '</span>'];
}
/**
* get Current Version
* Get the current version notice.
*
* @param string|null $message The error messages if any.
* Compares the installed version of the component with the latest available
* version from the repository tags and returns an appropriate message.
*
* @return array The array of the notice or error message
* @param string|null $version Optional version to compare if manifest version not found.
*
* @return array The array with 'notice' or 'error' and optional 'github-error' / 'gitea-error'.
* @since 2.3.0
* @since 5.1.1 Improved with support for pre-releases and intelligent tag grouping.
*/
public function getVersion($version = null)
public function getVersion(?string $version = null): array
{
try
{
// get the repository tags
$tags = GiteaFactory::_('Gitea.Repository.Tags')->list('joomla', 'Component-Builder');
}
catch (DomainException $e)
{
return $this->getTokenForVersion($e->getMessage());
}
catch (InvalidArgumentException $e)
{
return $this->getTokenForVersion($e->getMessage());
}
catch (Exception $e)
{
return $this->getTokenForVersion($e->getMessage());
}
// do we have tags returned
if (isset($tags[0]) && isset($tags[0]->name))
{
// get the local version
$manifest = ComponentbuilderHelper::manifest();
$local_version = (string) $manifest->version;
$latest_version = '1.0.0';
$download_link = "https://git.vdm.dev/api/v1/joomla/Component-Builder";
// Filter tags by major version matching the local version's major number
$major_version = explode('.', $local_version)[0];
$filtered_tags = array_filter($tags, function($tag) use ($major_version) {
return strpos($tag->name, "v$major_version") === 0;
});
if (!empty($filtered_tags))
{
// Sort versions to find the latest one
usort($filtered_tags, function($a, $b) {
return \version_compare($b->name, $a->name);
});
$latest_version = trim($filtered_tags[0]->name, 'vV');
// download link of the latest version
$download_link = $filtered_tags[0]->zipball_url;
}
// now check if this version is out dated
if (\version_compare($local_version, $latest_version) === 0)
{
return ['notice' => '<small><span style="color:green;"><span class="icon-shield"></span>&nbsp;' . Text::_('COM_COMPONENTBUILDER_UP_TO_DATE') . '</span></small>'];
}
else
{
// check if this is beta version
if (\version_compare($local_version, $latest_version) > 0)
{
return ['notice' => '<small><span style="color:#F7B033;"><span class="icon-wrench"></span>&nbsp;' . Text::_('COM_COMPONENTBUILDER_PRE_RELEASE') . '</span></small>'];
}
else
{
return ['notice' => '<small><span style="color:red;"><span class="icon-warning-circle"></span>&nbsp;' . Text::_('COM_COMPONENTBUILDER_OUT_OF_DATE') . '!</span> <a style="color:green;" href="' .
$download_link . '" title="' . Text::_('COM_COMPONENTBUILDER_YOU_CAN_DIRECTLY_DOWNLOAD_THE_LATEST_UPDATE_OR_USE_THE_JOOMLA_UPDATE_AREA') . '">' . Text::_('COM_COMPONENTBUILDER_DOWNLOAD_UPDATE') . '!</a></small>'];
}
}
}
return $this->getTokenForVersion();
return (new Version(
'joomengine', 'pkg-component-builder',
'joomla', 'pkg-component-builder'
))->get($version);
}
/**
* Instructions to get Token for version
* Get the content of a GitHub wiki page.
*
* @param string|null $message The error messages if any.
* @param string $name The name of the wiki page (default: 'Home').
*
* @return array The array of the error message
* @since 2.3.0
*/
protected function getTokenForVersion(?string $message = null): array
{
// the URL
$url = 'https://git.vdm.dev/user/settings/applications';
// create link
$a = '<small><a style="color:#F7B033;" href="' . $url . '" title="';
$a_ = '">';
$_a = '</a></small>';
if ($message)
{
return ['error' => $a . $message . $a_ . Text::_('COM_COMPONENTBUILDER_GET_TOKEN') . $_a];
}
return ['error' => $a . Text::_('COM_COMPONENTBUILDER_GET_TOKEN_FROM_VDM_TO_GET_UPDATE_NOTICE_AND_ADD_IT_TO_YOUR_GLOBAL_OPTIONS') . $a_ . Text::_('COM_COMPONENTBUILDER_GET_TOKEN') . $_a];
}
/**
* get Wiki Page
*
* @param string|null $message The error messages if any.
*
* @return array The array of the page or error message
* @return array Associative array with 'page' or 'error' key.
* @since 2.3.0
*/
public function getWiki(string $name = 'Home'): array
{
try
{
// get the gitea wiki page im markdown
$wiki = GiteaFactory::_('Gitea.Repository.Wiki')->get('joomla', 'Component-Builder', $name);
try {
$wiki = GithubFactory::_('Github.Repository.Wiki')
->get('joomengine', 'Joomla-Component-Builder', $name);
// now render the page in HTML
$page = $wiki->content ?? null;
}
catch (\DomainException $e)
{
return $this->getTokenForWiki($e->getMessage());
}
catch (\InvalidArgumentException $e)
{
return $this->getTokenForWiki($e->getMessage());
}
catch (\Exception $e)
{
return $this->getTokenForWiki($e->getMessage());
}
// get the html
if (isset($page))
{
return ['page' => $page];
}
return $this->getTokenForWiki();
}
/**
* Instructions to get Token for wiki
*
* @param string|null $message The error messages if any.
*
* @return array The array of the error message
* @since 2.3.0
*/
protected function getTokenForWiki(?string $message = null): array
{
if ($message)
{
return ['error' => $message];
if (!empty($wiki->content)) {
return ['page' => base64_decode($wiki->content)];
}
} catch (\Throwable $e) {
return ['error' => $e->getMessage()];
}
return ['error' => Text::_('COM_COMPONENTBUILDER_THE_WIKI_CAN_ONLY_BE_LOADED_WHEN_YOUR_JCB_SYSTEM_HAS_INTERNET_CONNECTION')];

View File

@@ -38,6 +38,233 @@ use VDM\Joomla\Utilities\StringHelper;
*/
class ComponentbuilderModel extends ListModel
{
/**
* Represents the current user object.
*
* @var User The user object representing the current user.
* @since 3.2.0
*/
protected User $user;
/**
* View groups of this component
*
* @var array<string, string>
* @since 5.1.1
*/
protected array $viewGroups = [
'main' => ['png.compiler', 'png.joomla_components', 'png.joomla_modules', 'png.joomla_plugins', 'png.powers', 'png.search', 'png.admin_views', 'png.custom_admin_views', 'png.site_views', 'png.template.add', 'png.templates', 'png.layouts', 'png.dynamic_get.add', 'png.dynamic_gets', 'png.custom_codes', 'png.placeholders', 'png.libraries', 'png.snippets', 'png.validation_rules', 'png.field.add', 'png.fields', 'png.fields.catid_qpo0O0oqp_com_componentbuilder_po0O0oq_field', 'png.fieldtypes', 'png.fieldtypes.catid_qpo0O0oqp_com_componentbuilder_po0O0oq_fieldtype', 'png.language_translations', 'png.languages', 'png.servers', 'png.repositories', 'png.help_documents'],
];
/**
* View access array.
*
* @var array<string, string>
* @since 5.1.1
*/
protected array $viewAccess = [
'compiler.submenu' => 'compiler.submenu',
'compiler.dashboard_list' => 'compiler.dashboard_list',
'search.access' => 'search.access',
'search.submenu' => 'search.submenu',
'search.dashboard_list' => 'search.dashboard_list',
'joomla_component.create' => 'joomla_component.create',
'joomla_components.access' => 'joomla_component.access',
'joomla_component.access' => 'joomla_component.access',
'joomla_components.submenu' => 'joomla_component.submenu',
'joomla_components.dashboard_list' => 'joomla_component.dashboard_list',
'joomla_module.create' => 'joomla_module.create',
'joomla_modules.access' => 'joomla_module.access',
'joomla_module.access' => 'joomla_module.access',
'joomla_modules.submenu' => 'joomla_module.submenu',
'joomla_modules.dashboard_list' => 'joomla_module.dashboard_list',
'joomla_plugin.create' => 'joomla_plugin.create',
'joomla_plugins.access' => 'joomla_plugin.access',
'joomla_plugin.access' => 'joomla_plugin.access',
'joomla_plugins.submenu' => 'joomla_plugin.submenu',
'joomla_plugins.dashboard_list' => 'joomla_plugin.dashboard_list',
'joomla_power.create' => 'joomla_power.create',
'joomla_powers.access' => 'joomla_power.access',
'joomla_power.access' => 'joomla_power.access',
'joomla_powers.submenu' => 'joomla_power.submenu',
'power.create' => 'power.create',
'powers.access' => 'power.access',
'power.access' => 'power.access',
'powers.submenu' => 'power.submenu',
'powers.dashboard_list' => 'power.dashboard_list',
'admin_view.create' => 'admin_view.create',
'admin_views.access' => 'admin_view.access',
'admin_view.access' => 'admin_view.access',
'admin_views.submenu' => 'admin_view.submenu',
'admin_views.dashboard_list' => 'admin_view.dashboard_list',
'custom_admin_views.access' => 'custom_admin_view.access',
'custom_admin_view.access' => 'custom_admin_view.access',
'custom_admin_views.submenu' => 'custom_admin_view.submenu',
'custom_admin_views.dashboard_list' => 'custom_admin_view.dashboard_list',
'site_views.access' => 'site_view.access',
'site_view.access' => 'site_view.access',
'site_views.submenu' => 'site_view.submenu',
'site_views.dashboard_list' => 'site_view.dashboard_list',
'templates.access' => 'template.access',
'template.access' => 'template.access',
'templates.submenu' => 'template.submenu',
'templates.dashboard_list' => 'template.dashboard_list',
'template.dashboard_add' => 'template.dashboard_add',
'layouts.access' => 'layout.access',
'layout.access' => 'layout.access',
'layouts.submenu' => 'layout.submenu',
'layouts.dashboard_list' => 'layout.dashboard_list',
'dynamic_get.create' => 'dynamic_get.create',
'dynamic_gets.access' => 'dynamic_get.access',
'dynamic_get.access' => 'dynamic_get.access',
'dynamic_gets.submenu' => 'dynamic_get.submenu',
'dynamic_gets.dashboard_list' => 'dynamic_get.dashboard_list',
'dynamic_get.dashboard_add' => 'dynamic_get.dashboard_add',
'custom_code.create' => 'custom_code.create',
'custom_codes.access' => 'custom_code.access',
'custom_code.access' => 'custom_code.access',
'custom_codes.submenu' => 'custom_code.submenu',
'custom_codes.dashboard_list' => 'custom_code.dashboard_list',
'class_extends.create' => 'class_extends.create',
'class_extendings.access' => 'class_extends.access',
'class_extends.access' => 'class_extends.access',
'class_property.create' => 'class_property.create',
'class_properties.access' => 'class_property.access',
'class_property.access' => 'class_property.access',
'class_method.create' => 'class_method.create',
'class_methods.access' => 'class_method.access',
'class_method.access' => 'class_method.access',
'placeholder.create' => 'placeholder.create',
'placeholders.access' => 'placeholder.access',
'placeholder.access' => 'placeholder.access',
'placeholders.submenu' => 'placeholder.submenu',
'placeholders.dashboard_list' => 'placeholder.dashboard_list',
'library.create' => 'library.create',
'libraries.access' => 'library.access',
'library.access' => 'library.access',
'libraries.submenu' => 'library.submenu',
'libraries.dashboard_list' => 'library.dashboard_list',
'snippets.access' => 'snippet.access',
'snippet.access' => 'snippet.access',
'snippets.submenu' => 'snippet.submenu',
'snippets.dashboard_list' => 'snippet.dashboard_list',
'validation_rule.create' => 'validation_rule.create',
'validation_rules.access' => 'validation_rule.access',
'validation_rule.access' => 'validation_rule.access',
'validation_rules.submenu' => 'validation_rule.submenu',
'validation_rules.dashboard_list' => 'validation_rule.dashboard_list',
'field.create' => 'field.create',
'fields.access' => 'field.access',
'field.access' => 'field.access',
'fields.submenu' => 'field.submenu',
'fields.dashboard_list' => 'field.dashboard_list',
'field.dashboard_add' => 'field.dashboard_add',
'fieldtype.create' => 'fieldtype.create',
'fieldtypes.access' => 'fieldtype.access',
'fieldtype.access' => 'fieldtype.access',
'fieldtypes.submenu' => 'fieldtype.submenu',
'fieldtypes.dashboard_list' => 'fieldtype.dashboard_list',
'language_translation.create' => 'language_translation.create',
'language_translations.access' => 'language_translation.access',
'language_translation.access' => 'language_translation.access',
'language_translations.submenu' => 'language_translation.submenu',
'language_translations.dashboard_list' => 'language_translation.dashboard_list',
'language.create' => 'language.create',
'languages.access' => 'language.access',
'language.access' => 'language.access',
'languages.submenu' => 'language.submenu',
'languages.dashboard_list' => 'language.dashboard_list',
'server.create' => 'server.create',
'servers.access' => 'server.access',
'server.access' => 'server.access',
'servers.submenu' => 'server.submenu',
'servers.dashboard_list' => 'server.dashboard_list',
'repository.create' => 'repository.create',
'repositories.access' => 'repository.access',
'repository.access' => 'repository.access',
'repositories.submenu' => 'repository.submenu',
'repositories.dashboard_list' => 'repository.dashboard_list',
'help_document.create' => 'help_document.create',
'help_documents.access' => 'help_document.access',
'help_document.access' => 'help_document.access',
'help_documents.submenu' => 'help_document.submenu',
'help_documents.dashboard_list' => 'help_document.dashboard_list',
'admin_fields.create' => 'admin_fields.create',
'admins_fields.access' => 'admin_fields.access',
'admin_fields.access' => 'admin_fields.access',
'admin_fields_conditions.create' => 'admin_fields_conditions.create',
'admins_fields_conditions.access' => 'admin_fields_conditions.access',
'admin_fields_conditions.access' => 'admin_fields_conditions.access',
'admin_fields_relations.create' => 'admin_fields_relations.create',
'admins_fields_relations.access' => 'admin_fields_relations.access',
'admin_fields_relations.access' => 'admin_fields_relations.access',
'admin_custom_tabs.create' => 'admin_custom_tabs.create',
'admins_custom_tabs.access' => 'admin_custom_tabs.access',
'admin_custom_tabs.access' => 'admin_custom_tabs.access',
'component_admin_views.create' => 'component_admin_views.create',
'components_admin_views.access' => 'component_admin_views.access',
'component_admin_views.access' => 'component_admin_views.access',
'component_site_views.create' => 'component_site_views.create',
'components_site_views.access' => 'component_site_views.access',
'component_site_views.access' => 'component_site_views.access',
'component_custom_admin_views.create' => 'component_custom_admin_views.create',
'components_custom_admin_views.access' => 'component_custom_admin_views.access',
'component_custom_admin_views.access' => 'component_custom_admin_views.access',
'component_updates.create' => 'component_updates.create',
'components_updates.access' => 'component_updates.access',
'component_updates.access' => 'component_updates.access',
'component_mysql_tweaks.create' => 'component_mysql_tweaks.create',
'components_mysql_tweaks.access' => 'component_mysql_tweaks.access',
'component_mysql_tweaks.access' => 'component_mysql_tweaks.access',
'component_custom_admin_menus.create' => 'component_custom_admin_menus.create',
'components_custom_admin_menus.access' => 'component_custom_admin_menus.access',
'component_custom_admin_menus.access' => 'component_custom_admin_menus.access',
'component_router.create' => 'component_router.create',
'components_routers.access' => 'component_router.access',
'component_router.access' => 'component_router.access',
'component_config.create' => 'component_config.create',
'components_config.access' => 'component_config.access',
'component_config.access' => 'component_config.access',
'component_dashboard.create' => 'component_dashboard.create',
'components_dashboard.access' => 'component_dashboard.access',
'component_dashboard.access' => 'component_dashboard.access',
'component_files_folders.create' => 'component_files_folders.create',
'components_files_folders.access' => 'component_files_folders.access',
'component_files_folders.access' => 'component_files_folders.access',
'component_placeholders.create' => 'component_placeholders.create',
'components_placeholders.access' => 'component_placeholders.access',
'component_placeholders.access' => 'component_placeholders.access',
'component_plugins.create' => 'component_plugins.create',
'components_plugins.access' => 'component_plugins.access',
'component_plugins.access' => 'component_plugins.access',
'component_modules.create' => 'component_modules.create',
'components_modules.access' => 'component_modules.access',
'component_modules.access' => 'component_modules.access',
'snippet_type.create' => 'snippet_type.create',
'snippet_types.access' => 'snippet_type.access',
'snippet_type.access' => 'snippet_type.access',
'library_config.create' => 'library_config.create',
'libraries_config.access' => 'library_config.access',
'library_config.access' => 'library_config.access',
'library_files_folders_urls.create' => 'library_files_folders_urls.create',
'libraries_files_folders_urls.access' => 'library_files_folders_urls.access',
'library_files_folders_urls.access' => 'library_files_folders_urls.access',
'joomla_module_updates.create' => 'joomla_module_updates.create',
'joomla_modules_updates.access' => 'joomla_module_updates.access',
'joomla_module_updates.access' => 'joomla_module_updates.access',
'joomla_module_files_folders_urls.create' => 'joomla_module_files_folders_urls.create',
'joomla_modules_files_folders_urls.access' => 'joomla_module_files_folders_urls.access',
'joomla_module_files_folders_urls.access' => 'joomla_module_files_folders_urls.access',
'joomla_plugin_groups.access' => 'joomla_plugin_group.access',
'joomla_plugin_group.access' => 'joomla_plugin_group.access',
'joomla_plugin_updates.create' => 'joomla_plugin_updates.create',
'joomla_plugins_updates.access' => 'joomla_plugin_updates.access',
'joomla_plugin_updates.access' => 'joomla_plugin_updates.access',
'joomla_plugin_files_folders_urls.create' => 'joomla_plugin_files_folders_urls.create',
'joomla_plugins_files_folders_urls.access' => 'joomla_plugin_files_folders_urls.access',
'joomla_plugin_files_folders_urls.access' => 'joomla_plugin_files_folders_urls.access',
];
/**
* The styles array.
*
@@ -59,402 +286,50 @@ class ComponentbuilderModel extends ListModel
'administrator/components/com_componentbuilder/assets/js/admin.js'
];
public function getIcons()
/**
* Constructor
*
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
* @param ?MVCFactoryInterface $factory The factory.
*
* @since 1.6
* @throws \Exception
*/
public function __construct($config = [], MVCFactoryInterface $factory = null)
{
// load user for access menus
$user = Factory::getApplication()->getIdentity();
// reset icon array
$icons = [];
// view groups array
$viewGroups = array(
'main' => array('png.compiler', 'png.joomla_components', 'png.joomla_modules', 'png.joomla_plugins', 'png.powers', 'png.search', 'png.admin_views', 'png.custom_admin_views', 'png.site_views', 'png.template.add', 'png.templates', 'png.layouts', 'png.dynamic_get.add', 'png.dynamic_gets', 'png.custom_codes', 'png.placeholders', 'png.libraries', 'png.snippets', 'png.validation_rules', 'png.field.add', 'png.fields', 'png.fields.catid_qpo0O0oqp_com_componentbuilder_po0O0oq_field', 'png.fieldtypes', 'png.fieldtypes.catid_qpo0O0oqp_com_componentbuilder_po0O0oq_fieldtype', 'png.language_translations', 'png.languages', 'png.servers', 'png.repositories', 'png.help_documents')
);
// view access array
$viewAccess = [
'compiler.submenu' => 'compiler.submenu',
'compiler.dashboard_list' => 'compiler.dashboard_list',
'search.access' => 'search.access',
'search.submenu' => 'search.submenu',
'search.dashboard_list' => 'search.dashboard_list',
'joomla_component.create' => 'joomla_component.create',
'joomla_components.access' => 'joomla_component.access',
'joomla_component.access' => 'joomla_component.access',
'joomla_components.submenu' => 'joomla_component.submenu',
'joomla_components.dashboard_list' => 'joomla_component.dashboard_list',
'joomla_module.create' => 'joomla_module.create',
'joomla_modules.access' => 'joomla_module.access',
'joomla_module.access' => 'joomla_module.access',
'joomla_modules.submenu' => 'joomla_module.submenu',
'joomla_modules.dashboard_list' => 'joomla_module.dashboard_list',
'joomla_plugin.create' => 'joomla_plugin.create',
'joomla_plugins.access' => 'joomla_plugin.access',
'joomla_plugin.access' => 'joomla_plugin.access',
'joomla_plugins.submenu' => 'joomla_plugin.submenu',
'joomla_plugins.dashboard_list' => 'joomla_plugin.dashboard_list',
'joomla_power.create' => 'joomla_power.create',
'joomla_powers.access' => 'joomla_power.access',
'joomla_power.access' => 'joomla_power.access',
'joomla_powers.submenu' => 'joomla_power.submenu',
'power.create' => 'power.create',
'powers.access' => 'power.access',
'power.access' => 'power.access',
'powers.submenu' => 'power.submenu',
'powers.dashboard_list' => 'power.dashboard_list',
'admin_view.create' => 'admin_view.create',
'admin_views.access' => 'admin_view.access',
'admin_view.access' => 'admin_view.access',
'admin_views.submenu' => 'admin_view.submenu',
'admin_views.dashboard_list' => 'admin_view.dashboard_list',
'custom_admin_views.access' => 'custom_admin_view.access',
'custom_admin_view.access' => 'custom_admin_view.access',
'custom_admin_views.submenu' => 'custom_admin_view.submenu',
'custom_admin_views.dashboard_list' => 'custom_admin_view.dashboard_list',
'site_views.access' => 'site_view.access',
'site_view.access' => 'site_view.access',
'site_views.submenu' => 'site_view.submenu',
'site_views.dashboard_list' => 'site_view.dashboard_list',
'templates.access' => 'template.access',
'template.access' => 'template.access',
'templates.submenu' => 'template.submenu',
'templates.dashboard_list' => 'template.dashboard_list',
'template.dashboard_add' => 'template.dashboard_add',
'layouts.access' => 'layout.access',
'layout.access' => 'layout.access',
'layouts.submenu' => 'layout.submenu',
'layouts.dashboard_list' => 'layout.dashboard_list',
'dynamic_get.create' => 'dynamic_get.create',
'dynamic_gets.access' => 'dynamic_get.access',
'dynamic_get.access' => 'dynamic_get.access',
'dynamic_gets.submenu' => 'dynamic_get.submenu',
'dynamic_gets.dashboard_list' => 'dynamic_get.dashboard_list',
'dynamic_get.dashboard_add' => 'dynamic_get.dashboard_add',
'custom_code.create' => 'custom_code.create',
'custom_codes.access' => 'custom_code.access',
'custom_code.access' => 'custom_code.access',
'custom_codes.submenu' => 'custom_code.submenu',
'custom_codes.dashboard_list' => 'custom_code.dashboard_list',
'class_extends.create' => 'class_extends.create',
'class_extendings.access' => 'class_extends.access',
'class_extends.access' => 'class_extends.access',
'class_property.create' => 'class_property.create',
'class_properties.access' => 'class_property.access',
'class_property.access' => 'class_property.access',
'class_method.create' => 'class_method.create',
'class_methods.access' => 'class_method.access',
'class_method.access' => 'class_method.access',
'placeholder.create' => 'placeholder.create',
'placeholders.access' => 'placeholder.access',
'placeholder.access' => 'placeholder.access',
'placeholders.submenu' => 'placeholder.submenu',
'placeholders.dashboard_list' => 'placeholder.dashboard_list',
'library.create' => 'library.create',
'libraries.access' => 'library.access',
'library.access' => 'library.access',
'libraries.submenu' => 'library.submenu',
'libraries.dashboard_list' => 'library.dashboard_list',
'snippets.access' => 'snippet.access',
'snippet.access' => 'snippet.access',
'snippets.submenu' => 'snippet.submenu',
'snippets.dashboard_list' => 'snippet.dashboard_list',
'validation_rule.create' => 'validation_rule.create',
'validation_rules.access' => 'validation_rule.access',
'validation_rule.access' => 'validation_rule.access',
'validation_rules.submenu' => 'validation_rule.submenu',
'validation_rules.dashboard_list' => 'validation_rule.dashboard_list',
'field.create' => 'field.create',
'fields.access' => 'field.access',
'field.access' => 'field.access',
'fields.submenu' => 'field.submenu',
'fields.dashboard_list' => 'field.dashboard_list',
'field.dashboard_add' => 'field.dashboard_add',
'fieldtype.create' => 'fieldtype.create',
'fieldtypes.access' => 'fieldtype.access',
'fieldtype.access' => 'fieldtype.access',
'fieldtypes.submenu' => 'fieldtype.submenu',
'fieldtypes.dashboard_list' => 'fieldtype.dashboard_list',
'language_translation.create' => 'language_translation.create',
'language_translations.access' => 'language_translation.access',
'language_translation.access' => 'language_translation.access',
'language_translations.submenu' => 'language_translation.submenu',
'language_translations.dashboard_list' => 'language_translation.dashboard_list',
'language.create' => 'language.create',
'languages.access' => 'language.access',
'language.access' => 'language.access',
'languages.submenu' => 'language.submenu',
'languages.dashboard_list' => 'language.dashboard_list',
'server.create' => 'server.create',
'servers.access' => 'server.access',
'server.access' => 'server.access',
'servers.submenu' => 'server.submenu',
'servers.dashboard_list' => 'server.dashboard_list',
'repository.create' => 'repository.create',
'repositories.access' => 'repository.access',
'repository.access' => 'repository.access',
'repositories.submenu' => 'repository.submenu',
'repositories.dashboard_list' => 'repository.dashboard_list',
'help_document.create' => 'help_document.create',
'help_documents.access' => 'help_document.access',
'help_document.access' => 'help_document.access',
'help_documents.submenu' => 'help_document.submenu',
'help_documents.dashboard_list' => 'help_document.dashboard_list',
'admin_fields.create' => 'admin_fields.create',
'admins_fields.access' => 'admin_fields.access',
'admin_fields.access' => 'admin_fields.access',
'admin_fields_conditions.create' => 'admin_fields_conditions.create',
'admins_fields_conditions.access' => 'admin_fields_conditions.access',
'admin_fields_conditions.access' => 'admin_fields_conditions.access',
'admin_fields_relations.create' => 'admin_fields_relations.create',
'admins_fields_relations.access' => 'admin_fields_relations.access',
'admin_fields_relations.access' => 'admin_fields_relations.access',
'admin_custom_tabs.create' => 'admin_custom_tabs.create',
'admins_custom_tabs.access' => 'admin_custom_tabs.access',
'admin_custom_tabs.access' => 'admin_custom_tabs.access',
'component_admin_views.create' => 'component_admin_views.create',
'components_admin_views.access' => 'component_admin_views.access',
'component_admin_views.access' => 'component_admin_views.access',
'component_site_views.create' => 'component_site_views.create',
'components_site_views.access' => 'component_site_views.access',
'component_site_views.access' => 'component_site_views.access',
'component_custom_admin_views.create' => 'component_custom_admin_views.create',
'components_custom_admin_views.access' => 'component_custom_admin_views.access',
'component_custom_admin_views.access' => 'component_custom_admin_views.access',
'component_updates.create' => 'component_updates.create',
'components_updates.access' => 'component_updates.access',
'component_updates.access' => 'component_updates.access',
'component_mysql_tweaks.create' => 'component_mysql_tweaks.create',
'components_mysql_tweaks.access' => 'component_mysql_tweaks.access',
'component_mysql_tweaks.access' => 'component_mysql_tweaks.access',
'component_custom_admin_menus.create' => 'component_custom_admin_menus.create',
'components_custom_admin_menus.access' => 'component_custom_admin_menus.access',
'component_custom_admin_menus.access' => 'component_custom_admin_menus.access',
'component_router.create' => 'component_router.create',
'components_routers.access' => 'component_router.access',
'component_router.access' => 'component_router.access',
'component_config.create' => 'component_config.create',
'components_config.access' => 'component_config.access',
'component_config.access' => 'component_config.access',
'component_dashboard.create' => 'component_dashboard.create',
'components_dashboard.access' => 'component_dashboard.access',
'component_dashboard.access' => 'component_dashboard.access',
'component_files_folders.create' => 'component_files_folders.create',
'components_files_folders.access' => 'component_files_folders.access',
'component_files_folders.access' => 'component_files_folders.access',
'component_placeholders.create' => 'component_placeholders.create',
'components_placeholders.access' => 'component_placeholders.access',
'component_placeholders.access' => 'component_placeholders.access',
'component_plugins.create' => 'component_plugins.create',
'components_plugins.access' => 'component_plugins.access',
'component_plugins.access' => 'component_plugins.access',
'component_modules.create' => 'component_modules.create',
'components_modules.access' => 'component_modules.access',
'component_modules.access' => 'component_modules.access',
'snippet_type.create' => 'snippet_type.create',
'snippet_types.access' => 'snippet_type.access',
'snippet_type.access' => 'snippet_type.access',
'library_config.create' => 'library_config.create',
'libraries_config.access' => 'library_config.access',
'library_config.access' => 'library_config.access',
'library_files_folders_urls.create' => 'library_files_folders_urls.create',
'libraries_files_folders_urls.access' => 'library_files_folders_urls.access',
'library_files_folders_urls.access' => 'library_files_folders_urls.access',
'joomla_module_updates.create' => 'joomla_module_updates.create',
'joomla_modules_updates.access' => 'joomla_module_updates.access',
'joomla_module_updates.access' => 'joomla_module_updates.access',
'joomla_module_files_folders_urls.create' => 'joomla_module_files_folders_urls.create',
'joomla_modules_files_folders_urls.access' => 'joomla_module_files_folders_urls.access',
'joomla_module_files_folders_urls.access' => 'joomla_module_files_folders_urls.access',
'joomla_plugin_groups.access' => 'joomla_plugin_group.access',
'joomla_plugin_group.access' => 'joomla_plugin_group.access',
'joomla_plugin_updates.create' => 'joomla_plugin_updates.create',
'joomla_plugins_updates.access' => 'joomla_plugin_updates.access',
'joomla_plugin_updates.access' => 'joomla_plugin_updates.access',
'joomla_plugin_files_folders_urls.create' => 'joomla_plugin_files_folders_urls.create',
'joomla_plugins_files_folders_urls.access' => 'joomla_plugin_files_folders_urls.access',
'joomla_plugin_files_folders_urls.access' => 'joomla_plugin_files_folders_urls.access',
];
// loop over the $views
foreach($viewGroups as $group => $views)
parent::__construct($config, $factory);
$this->user ??= $this->getCurrentUser();
}
/**
* Get dashboard icons, grouped by view sections.
*
* @return array<string, array<int, \stdClass|false>>
* @since 5.1.1
*/
public function getIcons(): array
{
$icons = [];
foreach ($this->viewGroups as $group => $views)
{
$i = 0;
if (UtilitiesArrayHelper::check($views))
if (!UtilitiesArrayHelper::check($views))
{
foreach($views as $view)
$icons[$group][] = false;
continue;
}
foreach ($views as $view)
{
$icon = $this->buildIconObject($view);
if ($icon !== null)
{
$add = false;
// external views (links)
if (strpos($view,'||') !== false)
{
$dwd = explode('||', $view);
if (count($dwd) == 3)
{
list($type, $name, $url) = $dwd;
$viewName = $name;
$alt = $name;
$url = $url;
$image = $name . '.' . $type;
$name = 'COM_COMPONENTBUILDER_DASHBOARD_' . StringHelper::safe($name,'U');
}
}
// internal views
elseif (strpos($view,'.') !== false)
{
$dwd = explode('.', $view);
if (count($dwd) == 3)
{
list($type, $name, $action) = $dwd;
}
elseif (count($dwd) == 2)
{
list($type, $name) = $dwd;
$action = false;
}
if ($action)
{
$viewName = $name;
switch($action)
{
case 'add':
$url = 'index.php?option=com_componentbuilder&view=' . $name . '&layout=edit';
$image = $name . '_' . $action. '.' . $type;
$alt = $name . '&nbsp;' . $action;
$name = 'COM_COMPONENTBUILDER_DASHBOARD_'.StringHelper::safe($name,'U').'_ADD';
$add = true;
break;
default:
// check for new convention (more stable)
if (strpos($action, '_qpo0O0oqp_') !== false)
{
list($action, $extension) = (array) explode('_qpo0O0oqp_', $action);
$extension = str_replace('_po0O0oq_', '.', $extension);
}
else
{
$extension = 'com_componentbuilder.' . $name;
}
$url = 'index.php?option=com_categories&view=categories&extension=' . $extension;
$image = $name . '_' . $action . '.' . $type;
$alt = $viewName . '&nbsp;' . $action;
$name = 'COM_COMPONENTBUILDER_DASHBOARD_' . StringHelper::safe($name,'U') . '_' . StringHelper::safe($action,'U');
break;
}
}
else
{
$viewName = $name;
$alt = $name;
$url = 'index.php?option=com_componentbuilder&view=' . $name;
$image = $name . '.' . $type;
$name = 'COM_COMPONENTBUILDER_DASHBOARD_' . StringHelper::safe($name,'U');
$hover = false;
}
}
else
{
$viewName = $view;
$alt = $view;
$url = 'index.php?option=com_componentbuilder&view=' . $view;
$image = $view . '.png';
$name = ucwords($view).'<br /><br />';
$hover = false;
}
// first make sure the view access is set
if (UtilitiesArrayHelper::check($viewAccess))
{
// setup some defaults
$dashboard_add = false;
$dashboard_list = false;
$accessTo = '';
$accessAdd = '';
// access checking start
$accessCreate = (isset($viewAccess[$viewName.'.create'])) ? StringHelper::check($viewAccess[$viewName.'.create']):false;
$accessAccess = (isset($viewAccess[$viewName.'.access'])) ? StringHelper::check($viewAccess[$viewName.'.access']):false;
// set main controllers
$accessDashboard_add = (isset($viewAccess[$viewName.'.dashboard_add'])) ? StringHelper::check($viewAccess[$viewName.'.dashboard_add']):false;
$accessDashboard_list = (isset($viewAccess[$viewName.'.dashboard_list'])) ? StringHelper::check($viewAccess[$viewName.'.dashboard_list']):false;
// check for adding access
if ($add && $accessCreate)
{
$accessAdd = $viewAccess[$viewName.'.create'];
}
elseif ($add)
{
$accessAdd = 'core.create';
}
// check if access to view is set
if ($accessAccess)
{
$accessTo = $viewAccess[$viewName.'.access'];
}
// set main access controllers
if ($accessDashboard_add)
{
$dashboard_add = $user->authorise($viewAccess[$viewName.'.dashboard_add'], 'com_componentbuilder');
}
if ($accessDashboard_list)
{
$dashboard_list = $user->authorise($viewAccess[$viewName.'.dashboard_list'], 'com_componentbuilder');
}
if (StringHelper::check($accessAdd) && StringHelper::check($accessTo))
{
// check access
if($user->authorise($accessAdd, 'com_componentbuilder') && $user->authorise($accessTo, 'com_componentbuilder') && $dashboard_add)
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
elseif (StringHelper::check($accessTo))
{
// check access
if($user->authorise($accessTo, 'com_componentbuilder') && $dashboard_list)
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
elseif (StringHelper::check($accessAdd))
{
// check access
if($user->authorise($accessAdd, 'com_componentbuilder') && $dashboard_add)
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
else
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
}
else
{
$icons[$group][$i] = new \StdClass;
$icons[$group][$i]->url = $url;
$icons[$group][$i]->name = $name;
$icons[$group][$i]->image = $image;
$icons[$group][$i]->alt = $alt;
}
$i++;
$icons[$group][] = $icon;
}
}
else
{
$icons[$group][$i] = false;
}
}
return $icons;
}
@@ -502,13 +377,208 @@ class ComponentbuilderModel extends ListModel
$this->scripts[] = $path;
}
/**
* Build a single dashboard icon if access is granted.
*
* @param string $view The view string to parse.
*
* @return \stdClass|null The icon object or null if access denied.
* @since 5.1.1
*/
protected function buildIconObject(string $view): ?\stdClass
{
$parsed = $this->parseViewDefinition($view);
if (!$parsed)
{
return null;
}
[
'type' => $type,
'name' => $name,
'url' => $url,
'image' => $image,
'alt' => $alt,
'viewName' => $viewName,
'add' => $add,
] = $parsed;
if (!$this->hasAccessToView($viewName, $add))
{
return null;
}
return $this->createIconObject($url, $name, $image, $alt);
}
/**
* Parse a view string into structured components.
*
* @param string $view The view definition string.
*
* @return array<string, mixed>|null Parsed values or null on failure.
* @since 5.1.1
*/
protected function parseViewDefinition(string $view): ?array
{
$add = false;
if (strpos($view, '||') !== false)
{
$parts = explode('||', $view);
if (count($parts) === 3)
{
[$type, $name, $url] = $parts;
return [
'type' => $type,
'name' => 'COM_COMPONENTBUILDER_DASHBOARD_' . StringHelper::safe($name, 'U'),
'url' => $url,
'image' => "{$name}.{$type}",
'alt' => $name,
'viewName' => $name,
'add' => false,
];
}
}
if (strpos($view, '.') !== false)
{
$parts = explode('.', $view);
$type = $parts[0] ?? '';
$name = $parts[1] ?? '';
$action = $parts[2] ?? null;
$viewName = $name;
if ($action)
{
if ($action === 'add')
{
$url = "index.php?option=com_componentbuilder&view={$name}&layout=edit";
$image = "{$name}_{$action}.{$type}";
$alt = "{$name}&nbsp;{$action}";
$name = 'COM_COMPONENTBUILDER_DASHBOARD_' .
StringHelper::safe($name, 'U') . '_ADD';
$add = true;
}
else
{
if (strpos($action, '_qpo0O0oqp_') !== false)
{
[$action, $ext] = explode('_qpo0O0oqp_', $action);
$extension = str_replace('_po0O0oq_', '.', $ext);
}
else
{
$extension = "com_componentbuilder.{$name}";
}
$url = "index.php?option=com_categories&view=categories&extension={$extension}";
$image = "{$name}_{$action}.{$type}";
$alt = "{$name}&nbsp;{$action}";
$name = 'COM_COMPONENTBUILDER_DASHBOARD_' .
StringHelper::safe($name, 'U') . '_' .
StringHelper::safe($action, 'U');
}
}
else
{
$url = "index.php?option=com_componentbuilder&view={$name}";
$image = "{$name}.{$type}";
$alt = $name;
$name = 'COM_COMPONENTBUILDER_DASHBOARD_' .
StringHelper::safe($name, 'U');
}
return compact('type', 'name', 'url', 'image', 'alt', 'viewName', 'add');
}
return [
'type' => 'png',
'name' => ucwords($view) . '<br /><br />',
'url' => "index.php?option=com_componentbuilder&view={$view}",
'image' => "{$view}.png",
'alt' => $view,
'viewName' => $view,
'add' => false,
];
}
/**
* Determine if the user has access to view or create the item.
*
* @param string $viewName The base name of the view.
* @param bool $add If this is an add-action.
*
* @return bool
* @since 5.1.1
*/
protected function hasAccessToView(string $viewName, bool $add): bool
{
$viewAccess = $this->viewAccess;
$accessAdd = $add && isset($viewAccess["{$viewName}.create"])
? $viewAccess["{$viewName}.create"]
: ($add ? 'core.create' : '');
$accessTo = $viewAccess["{$viewName}.access"] ?? '';
$dashboardAdd = isset($viewAccess["{$viewName}.dashboard_add"]) &&
$this->user->authorise($viewAccess["{$viewName}.dashboard_add"], 'com_componentbuilder');
$dashboardList = isset($viewAccess["{$viewName}.dashboard_list"]) &&
$this->user->authorise($viewAccess["{$viewName}.dashboard_list"], 'com_componentbuilder');
if ($add && StringHelper::check($accessAdd))
{
return $this->user->authorise($accessAdd, 'com_componentbuilder') && $dashboardAdd;
}
if (StringHelper::check($accessTo))
{
return $this->user->authorise($accessTo, 'com_componentbuilder') && $dashboardList;
}
return !$accessTo && !$accessAdd;
}
/**
* Create a \stdClass icon object.
*
* @param string $url Icon URL.
* @param string $name Language string or label.
* @param string $image Image filename.
* @param string $alt Alt text.
*
* @return \stdClass
* @since 5.1.1
*/
protected function createIconObject(string $url, string $name, string $image, string $alt): \stdClass
{
$icon = new \stdClass;
$icon->url = $url;
$icon->name = $name;
$icon->image = $image;
$icon->alt = $alt;
return $icon;
}
/**
* Load and display the wiki page content using an AJAX call to the component endpoint.
*
* This method injects an inline JavaScript script that asynchronously fetches the wiki page content
* via a JSON API endpoint in the component. It uses the `marked` library to render markdown content
* and inserts the result into the `wiki-md` container. Errors are displayed in a separate element.
*
* @return string HTML markup including a container for the wiki content and an error message area.
* @since 3.9.0
*/
public function getWiki()
{
// the call URL
// call the ajax get wiki endpoint
$call_url = Uri::base() . 'index.php?option=com_componentbuilder&task=ajax.getWiki&format=json&raw=true&' . Session::getFormToken() . '=1&name=Home';
$document = Factory::getDocument();
$document->addScriptDeclaration('
/** \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = Factory::getApplication()->getDocument()->getWebAssetManager();
$wa->addInlineScript('
function getWikiPage(){
fetch("' . $call_url . '").then((response) => {
if (response.ok) {
@@ -528,13 +598,27 @@ class ComponentbuilderModel extends ListModel
}
/**
* Load and display the component's README file using JavaScript fetch and markdown rendering.
*
* This method injects an inline script into the document that, once the DOM is fully loaded,
* fetches the README.txt file located in the administrator component directory, parses it using
* the `marked` JavaScript library, and inserts the HTML into the `readme-md` div.
*
* @return string HTML markup including a container for the README content and a loading message.
* @since 3.9.0
*/
public function getReadme()
{
$document = Factory::getDocument();
$document->addScriptDeclaration('
var getreadme = "'. Uri::root() . 'administrator/components/com_componentbuilder/README.txt";
// get readme text path
$call_url = Uri::root() . 'administrator/components/com_componentbuilder/README.txt';
/** \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = Factory::getApplication()->getDocument()->getWebAssetManager();
$wa->addInlineScript('
document.addEventListener("DOMContentLoaded", function () {
fetch(getreadme)
fetch("'. $call_url . '")
.then(response => {
if (!response.ok) {
throw new Error("Network response was not ok");
@@ -554,31 +638,45 @@ class ComponentbuilderModel extends ListModel
}
/**
* get Current Version Bay adding JavaScript to the Page
* Inject JavaScript that fetches and displays the current component version status.
*
* @return void
* @since 2.3.0
* This method adds an inline script to the page which asynchronously calls the component's
* AJAX endpoint to check the latest version. It updates the `#component-update-notice` element
* with the fetched version notice or error message.
*
* @return void
* @since 2.3.0
*/
public function getVersion()
{
// the call URL
$call_url = Uri::base() . 'index.php?option=com_componentbuilder&task=ajax.getVersion&format=json&raw=true&' . Session::getFormToken() . '=1&version=1';
$document = Factory::getDocument();
$document->addScriptDeclaration('
function getComponentVersionStatus() {
fetch("' . $call_url . '").then((response) => {
if (response.ok) {
return response.json();
}
}).then((result) => {
if (typeof result.notice !== "undefined") {
document.getElementById("component-update-notice").innerHTML = result.notice;
} else if (typeof result.error !== "undefined") {
document.getElementById("component-update-notice").innerHTML = result.error;
}
});
// call the ajax get version endpoint
$call_url = Uri::base()
. 'index.php?option=com_componentbuilder&task=ajax.getVersion&format=json&raw=true&'
. Session::getFormToken() . '=1&version=1.0.0';
try {
/** \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = Factory::getApplication()->getDocument()->getWebAssetManager();
$wa->addInlineScript('
function getComponentVersionStatus() {
fetch("' . $call_url . '").then((response) => {
if (response.ok) {
return response.json();
}
}).then((result) => {
const target = document.getElementById("component-update-notice");
if (!target) return;
if (typeof result.notice !== "undefined") {
target.innerHTML = result.notice;
} else if (typeof result.error !== "undefined") {
target.innerHTML = result.error;
}
});
}
setTimeout(getComponentVersionStatus, 800);');
} catch (\Throwable $e) {
// we do nothing....
}
setTimeout(getComponentVersionStatus, 800);');
}
}
}

View File

@@ -30,6 +30,60 @@ use VDM\Joomla\Utilities\StringHelper;
#[\AllowDynamicProperties]
class HtmlView extends BaseHtmlView
{
/**
* @var array<string> List of icon identifiers to render in the dashboard view.
* @since 1.6
*/
public array $icons = [];
/**
* @var array<string> List of CSS file URLs to be added to the page.
* @since 4.3
*/
public array $styles = [];
/**
* @var array<string> List of JavaScript file URLs to be included on the page.
* @since 4.3
*/
public array $scripts = [];
/**
* @var array<int, object> List of contributor objects fetched via the helper.
* @since 1.6
*/
public array $contributors = [];
/**
* @var object|null The manifest metadata of the component as returned by `ComponentbuilderHelper::manifest()`.
* @since 1.6
*/
public $manifest = null;
/**
* @var string|null Markdown content of the component's wiki page.
* @since 1.6
*/
public ?string $wiki = null;
/**
* @var string|null The rendered or raw README markdown of the component.
* @since 1.6
*/
public ?string $readme = null;
/**
* @var string|null The current version of the component.
* @since 1.6
*/
public ?string $version = null;
/**
* @var string|null Help URL for the component dashboard view, if available.
* @since 1.6
*/
public ?string $help_url = null;
/**
* View display method
*
@@ -101,8 +155,12 @@ class HtmlView extends BaseHtmlView
{
// set page title
$this->getDocument()->setTitle(Text::_('COM_COMPONENTBUILDER_DASHBOARD'));
// add manifest to page JavaScript
$this->getDocument()->addScriptDeclaration("var manifest = JSON.parse(" . json_encode($this->manifest) . ");", "text/javascript");
/** \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = $this->getDocument()->getWebAssetManager();
// Register the inline script with properly encoded JSON
$wa->addInlineScript(
'var manifest = ' . json_encode($this->manifest, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) . ';'
);
// add styles
foreach ($this->styles as $style)
{