Class Joomla_Module

`extends`	`Webapps`

Joomla! management

Module_Skeleton
- Module\Support\Webapps implements Webapp uses NamespaceUtilitiesTrait, WebappUtilities, PublicRelocatable
  - Joomla_Module

Located at Module/Support/Webapps/App/Type/Joomla/module.php

Methods


					
	public

__construct()

void __construct(void)


					
	public

install(string $hostname, string $path = '', array $opts = []): bool

Install Joomla! into a pre-existing location

Parameters

`$hostname`	domain or subdomain to install Joomla!
`$path`	optional path under hostname
`$opts`	additional install options


					
	public

change_admin(string $hostname, string $path, array $fields): bool

Change Joomla admin credentials

common fields include: username, password, name, email


					
	public

get_admin(string $hostname, null|string $path = ''): string|null

Get the primary admin for a Joomla instance

Returns

admin or false on failure


					
	public

db_config(string $hostname, string $path = ''): array|bool

Get database configuration for a blog

Parameters

`$hostname`	domain or subdomain of joomla
`$path`	optional path


					
	public

install_plugin(string $hostname, string $path, string $plugin, string $version = ''): bool

Install and activate plugin

Parameters

`$hostname`	domain or subdomain of joomla install
`$path`	optional path component of joomla install
`$plugin`	plugin name
`$version`	optional plugin version


					
	public

uninstall_plugin(string $hostname, string $path, string $plugin, bool $force = false): bool

Uninstall a plugin

Parameters

`$plugin`	plugin name
`$force`	delete even if plugin activated


					
	public

plugin_status(string $hostname, string $path = '', string $plugin = null): array


					
	public

disable_all_plugins(string $hostname, string $path = ''): bool

Recovery mode to disable all plugins

Parameters

`$hostname`	subdomain or domain of Joomla
`$path`	optional path


					
	public

update_all(string $hostname, string $path = '', string $version = null): bool

Update core, plugins, and themes atomically

Parameters

`$hostname`	subdomain or domain
`$path`	optional path under hostname


					
	public

update(string $hostname, string $path = '', string $version = null): bool

Update Joomla! to latest version

Parameters

`$hostname`	domain or subdomain under which Joomla is installed
`$path`	optional subdirectory

Throws

HTTP_Request2_Exception


					
	public

get_version(string $hostname, string $path = ''): string|null

Get installed version

Returns

version number


					
	public

valid(string $hostname, string $path = ''): bool

Location is a valid Joomla install

Parameters

$hostname

or $docroot


					
	public

get_versions(): array


					
	public

get_plugin_info($plugin, $ver = null)


					
	public

update_plugins(string $hostname, string $path = '', array $plugins = []): bool

Update Joomla! plugins

Parameters

`$hostname`	domain or subdomain
`$path`	optional path within host


					
	public

update_themes(string $hostname, string $path = '', array $themes = []): bool

Update Joomla! themes

Parameters

`$hostname`	subdomain or domain
`$path`	optional path under hostname


					
	public

_housekeeping(): bool

Install joomlatools if necessary

Methods inherited from Module\Support\Webapps
instantiateContexted(), setContext(), getExportedFunctions(), blacklisted(), allApps(), knownApps(), fortify(), setOptions(), getOptions(), failed(), getVersionLock(), has_fortification(), fortification_modes(), unfortify(), uninstall(), next_version(), is_current(), getAllHostnames(), connectorFromCredentials(), getAllPartitionedHostnames(), theme_status(), install_theme(), uninstall_theme(), asset_skipped(), reconfigure(), reconfigurables(), get_reconfigurable(), registerApplication(), snapshot(), rollback(), handlerFromApplication()

Methods inherited from Module\Support\Webapps

instantiateContexted(), setContext(), getExportedFunctions(), blacklisted(), allApps(), knownApps(), fortify(), setOptions(), getOptions(), failed(), getVersionLock(), has_fortification(), fortification_modes(), unfortify(), uninstall(), next_version(), is_current(), getAllHostnames(), connectorFromCredentials(), getAllPartitionedHostnames(), theme_status(), install_theme(), uninstall_theme(), asset_skipped(), reconfigure(), reconfigurables(), get_reconfigurable(), registerApplication(), snapshot(), rollback(), handlerFromApplication()

Methods used from NamespaceUtilitiesTrait
`getBaseClassName(), getParentClassName(), appendNamespace(), getNamespace()`

Constants
`public`	`APP_NAME = 'Joomla!'`	#
`public`	`JOOMLA_CLI = '/usr/share/pear/joomlatools.phar'`	#
`public`	`UPDATE_URI = 'https://github.com/joomla/joomla-cms/releases/download/%version%/Joomla_%version%-Stable-Update_Package.zip'`	#
`public`	`DEFAULT_FORTIFY_MODE = 'max'`	#
`public`	`JOOMLA_CLI_VERSION = '2.0.3'`	#
`public`	`JOOMLA_MODULE_XML = 'http://update.joomla.org/core/extensions/%extension%.xml'`	#
`public`	`DEFAULT_VERSION_LOCK = 'major'`	#
`public`	`VERSION_MINIMUMS = ['0' => '5.6', '4.0.0' => '7.2.4', '5.0.0' => '8.1.0']`	#
`public`	`JOOMLA_MIRROR = 'https://github.com/joomla/joomla-cms'`	#

Constants inherited from Module\Support\Webapps
`APPLICATION_PREF_KEY, RELOCATED_DOCROOT_NAME, VALIDITY_FILE, BANNED_DIRECTIVES, FAILURE_CALLBACK, INSTALL_CALLBACK, LEARNING_DURATION`

Properties inherited from Module\Support\Webapps
`$exportedFunctions`

Namespaces

Classes

Interfaces

Class Joomla_Module

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Throws

Returns

Parameters

Parameters

Parameters