| Methods |
public
|
__construct()
|
#
|
public
static
|
instantiateContexted(Auth_Info_User $context, array $constructorArgs = []): Module_Skeleton
|
#
|
public
|
setContext(Auth_Info_User $context): Module_Skeleton
|
#
|
public
|
getExportedFunctions(): array
Merge interface methods
|
#
|
public
static
|
blacklisted(string $app): bool
Vendor blocked app
|
#
|
public
static
|
allApps(): array
All apps known to panel
All apps known to panel
Excludes blacklisted apps. @see knownApps
|
#
|
public
static
|
knownApps(): array
List known apps, factoring in exclusions
List known apps, factoring in exclusions
|
#
|
public
|
fortify(string $hostname, string $path = '', string $mode = 'max', array $args = []): bool
Restrict write-access by the app
Restrict write-access by the app
Parameters
| $mode |
app-specific mode or magic mode: ['learn', 'write', 'reset']
|
| $args |
optional args, for mode-based: "create" (bool), create fortified paths as directories
|
|
#
|
public
|
setOptions(string $docroot, ?array $options)
|
#
|
public
|
getOptions($docroot): Options
Get webapp options
|
#
|
public
|
failed(string $docroot, null|bool $failedFlag = null): bool
Get or set failed status
|
#
|
public
|
getVersionLock(string $docroot): null|string
Get application version lock
Get application version lock
|
#
|
public
|
has_fortification(string $hostname, string $path = '', string|null $mode = null): bool
Web application supports fortification
Web application supports fortification
Parameters
| $mode |
optional mode (min, max)
|
|
#
|
public
|
fortification_modes(string $hostname, string $path = ''): array
Supported Fortification modes
Supported Fortification modes
|
#
|
public
|
unfortify(string $hostname, string $path = ''): bool
Relax permissions to allow write-access
Relax permissions to allow write-access
|
#
|
public
|
uninstall(string $hostname, string $path = '', string $delete = 'all'): bool
Remove an installed web application
Remove an installed web application
Parameters
| $delete |
"all", "db", or "files"
|
|
#
|
public
|
next_version(string $version, string $maximalbranch = '99999999.99999999.99999999'): null|string
Get next version in hierarchy
Get next version in hierarchy
|
#
|
public
|
is_current(null|string $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
Parameters
| $branchcomp |
branch to compare against
|
|
#
|
public
static
|
getAllHostnames(Auth_Info_User $ctx): array
Get all hostnamers on site
Get all hostnamers on site
|
#
|
public
static
|
connectorFromCredentials(array|DatabaseGenerator $credentials): PDO
Instantiate PDO connection from credentials
Instantiate PDO connection from credentials
|
#
|
public
static
|
getAllPartitionedHostnames(Auth_Info_User $ctx, bool $showWWW = true, bool $sort = false): array|array[]
Get hostnames grouped by subdomain and domain
Get hostnames grouped by subdomain and domain
|
#
|
public
|
valid(string $hostname, string $path = ''): bool
Application root contains expected app type
Application root contains expected app type
NB: when $hostname is a path and the invoked module uses PublicRelocatable,
the approot is assumed 1 below
Parameters
| $hostname |
hostname or direct path
|
|
#
|
public
|
theme_status(string $hostname, string $path = '', string $theme = null)
|
#
|
public
|
install_theme(string $hostname, string $path, string $theme, string $version = null): bool
|
#
|
public
|
uninstall_theme(string $hostname, string $path, string $theme, bool $force = false): bool
|
#
|
public
|
plugin_status(string $hostname, string $path = '', string $plugin = null)
|
#
|
public
|
install_plugin(string $hostname, string $path, string $plugin, string $version = ''): bool
|
#
|
public
|
uninstall_plugin(string $hostname, string $path, string $plugin, bool $force = false): bool
|
#
|
public
|
disable_all_plugins(string $hostname, string $path = ''): bool
|
#
|
public
|
db_config(string $hostname, string $path = '')
|
#
|
public
|
change_admin(string $hostname, string $path, array $fields): bool
|
#
|
public
|
get_admin(string $hostname, string $path = ''): ?string
|
#
|
public
|
update_all(string $hostname, string $path = '', string $version = null): bool
|
#
|
public
|
update(string $hostname, string $path = '', string $version = null): bool
|
#
|
public
|
update_plugins(string $hostname, string $path = '', array $plugins = []): bool
|
#
|
public
|
update_themes(string $hostname, string $path = '', array $themes = []): bool
|
#
|
public
|
asset_skipped(string $hostname, string $path, string $name, string|null $type): bool
Asset skipped for update
Parameters
| $hostname |
hostname
|
| $path |
path
|
| $name |
asset name
|
| $type |
asset subtype
|
|
#
|
public
|
reconfigure(string $hostname, string $path, string|array $param, mixed $value = null): bool
Reconfigure a webapp
Parameters
| $hostname |
hostname
|
| $path |
optional path
|
| $param |
array of reconfigurables or single value
|
| $value |
value to set in single-value mode
|
|
#
|
public
|
reconfigurables(string $hostname, string $path = ''): array
List of reconfigurable elements
List of reconfigurable elements
|
#
|
public
|
get_reconfigurable(string $hostname, string $path, string|string[] $setting): mixed
Get reconfigurable setting
Get reconfigurable setting
|
#
|
public
static
|
registerApplication(string $app, string $handler): bool
Register new web application
Register new web application
|
#
|
public
|
snapshot(string $hostname, string $path = '', string $comment = 'snapshot'): bool
Snapshot a web application
Snapshot a web application
|
#
|
public
|
rollback(string $hostname, string $path = '', string|null $commit = null): bool
Rollback specified snapshot
Rollback specified snapshot
Parameters
|
#
|
public
static
|
handlerFromApplication(string $app): string
Get handler from application
Get handler from application
|
#
|