| Methods |
public
|
__construct()
void __construct(void)
|
#
|
public
|
install(string $hostname, string $path = '', array $opts = []): bool
Install Magento into a pre-existing location
Install Magento into a pre-existing location
Parameters
| $hostname |
domain or subdomain to install Magento
|
| $path |
optional path under hostname
|
| $opts |
additional install options
|
|
#
|
public
|
get_key(): mixed
Get Magento key for use with Magento Connect
Get Magento key for use with Magento Connect
|
#
|
public
|
get_version(string $hostname, string $path = ''): null|string
Get installed version
|
#
|
public
|
valid(string $hostname, string $path = ''): bool
Location is a valid WP install
Location is a valid WP install
Parameters
|
#
|
public
|
install_plugin(string $hostname, string $path, string $plugin, string $version = 'stable'): bool
Install and activate plugin
Install and activate plugin
Parameters
| $hostname |
domain or subdomain of wp install
|
| $path |
optional path component of wp install
|
| $plugin |
plugin name
|
| $version |
optional plugin version
|
|
#
|
public
|
uninstall_plugin(string $hostname, string $path, string $plugin, bool|string $force = false): bool
Uninstall a plugin
Parameters
| $plugin |
plugin name
|
| $force |
delete even if plugin activated
|
|
#
|
public
|
disable_all_plugins(string $hostname, string $path = ''): bool
Recovery mode to disable all plugins
Recovery mode to disable all plugins
Parameters
| $hostname |
subdomain or domain of WP
|
| $path |
optional path
|
|
#
|
public
|
uninstall(string $hostname, string $path = '', string $delete = 'all'): bool
Uninstall WP from a location
Uninstall WP from a location
Parameters
| $delete |
"all", "db", or "files"
|
|
#
|
public
|
db_config(string $hostname, string $path = ''): array|bool
Get database configuration for a blog
Get database configuration for a blog
Parameters
| $hostname |
domain or subdomain of wp blog
|
| $path |
optional path
|
|
#
|
public
|
is_current(string|null $version = null, string|null $branchcomp = null): int|string
Check if version is latest or get latest version
Check if version is latest or get latest version
|
#
|
public
|
change_admin(string $hostname, string $path, array $fields): bool
Change Magento admin credentials
Change Magento admin credentials
$fields is a hash whose indices match password
|
#
|
public
|
get_admin(string $hostname, string|null $path = ''): null|string
Get the primary admin for a Magento instance
Get the primary admin for a Magento instance
Returns
admin or false on failure
|
#
|
public
|
has_fortification(string $hostname, string $path = '', string $mode = null): bool
|
#
|
public
|
fortification_modes(string $hostname, string $path = ''): array
|
#
|
public
|
fortify(string $hostname, string $path = '', string $mode = 'max', null $args = []): bool
|
#
|
public
|
unfortify(string $hostname, string $path = ''): bool
Relax permissions to allow write-access
Relax permissions to allow write-access
|
#
|
public
|
update_all(string $hostname, string $path = '', string $version = null): bool
Update core, plugins, and themes atomically
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 Magento to latest version
Update Magento to latest version
Parameters
| $hostname |
domain or subdomain under which WP is installed
|
| $path |
optional subdirectory
|
|
#
|
public
|
update_plugins(string $hostname, string $path = '', array $plugins = []): bool
Update Magento plugins
Parameters
| $hostname |
domain or subdomain
|
| $path |
optional path within host
|
|
#
|
public
|
update_themes(string $hostname, string $path = '', array $themes = []): bool
Update Magento themes
Parameters
| $hostname |
subdomain or domain
|
| $path |
optional path under hostname
|
|
#
|
public
|
delete_key()
|
#
|
public
|
set_key($publickey, $privatekey)
|
#
|
public
|
_housekeeping(): bool
Install wp-cli if necessary
Install wp-cli if necessary
Throws
|
#
|
public
|
plugin_status(string $hostname, null|string $path = '', null|string $plugin = null): array|bool
Get plugin status
Parameters
| $hostname |
domain or subdomain
|
| $path |
optional path under hostname
|
| $plugin |
specific plugin to query
|
|
#
|
public
|
get_versions(): array
Get all available versions
Get all available versions
|
#
|
public
|
next_version(string $version, string $maximalbranch = '99999999.99999999.99999999'): ?string
|
#
|
public
|
theme_status(string $hostname, string $path = '', string $theme = null)
|
#
|
public
|
install_theme(string $hostname, string $path, string $theme, string $version = null): bool
|
#
|
public
|
reconfigure(string $hostname, string $path, $param, $value = null): bool
|
#
|
public
|
reconfigurables(string $hostname, string $path = ''): array
|
#
|