| Methods |
public
|
cp_version(string $field = ''): array|string
Current control panel version
Current control panel version
|
#
|
public
|
flush_cp_version(): bool
Force recheck on next cp_version query
Force recheck on next cp_version query
|
#
|
public
|
platform_version(): string
Get platform version
|
#
|
public
|
dashboard_memory_usage(): int
int dashboard_memory_usage()
int dashboard_memory_usage()
Returns
memory usage, in bytes, that the dashboard is currently
consuming
|
#
|
public
|
apnscpd_memory_usage(): int
int lservice_memory_usage()
int lservice_memory_usage()
Returns
|
#
|
public
|
toggle_procfs(): bool
Toggle procfs presence
|
#
|
public
|
is_mounted(string $svc): bool
Service is mounted
|
#
|
public
|
unmount_service(string $svc): bool
Unmount service from site
Unmount service from site
|
#
|
public
|
mount_service(string $svc): bool
Mount service
|
#
|
public
|
procfs_enabled(): bool
procfs is mounted
|
#
|
public
|
changelog(): array
Get changelog
|
#
|
public
|
notify_installed(string $password): bool
Notify admin panel has been installed
Notify admin panel has been installed
|
#
|
public
|
notify_update_failure(): bool
Scan for update failure notifying admin
Scan for update failure notifying admin
|
#
|
public
|
list_commands(string $filter = ''): array
Get all available module commands
Get all available module commands
Parameters
| $filter |
optional filter following glob-style rules
|
|
#
|
public
|
debug_session(string $id, bool $state = true): bool
Enable debugging for a frontend session
Enable debugging for a frontend session
Parameters
| $id |
session ID
|
| $state |
debug state to set
|
|
#
|
public
|
command_info(string $filter = ''): array
Get command information
Returns
single or multi keyed by name => [doc, parameters, min, max, return, signature]
|
#
|
public
|
l(string $filter = ''): array
Wrapper for list_commands
Wrapper for list_commands
|
#
|
public
|
i(string $filter = ''): array
Wrapper for command_info
|
#
|
public
|
get_job_queue(): array
Get pending/running job queue
Get pending/running job queue
|
#
|
public
|
jobify(string $cmd, array $args = [], string|null $site = null): bool
Run command as a job
Parameters
| $site |
optional site to run as
|
|
#
|
public
|
_edit()
|
#
|
public
|
_delete()
|
#
|
public
|
_cron(Cronus $cron)
|
#
|
public
|
theme_inventory()
|
#
|
public
|
run_cron(mixed $module = null): void
Immediately run marked cron services
Immediately run marked cron services
|
#
|
public
|
_housekeeping()
|
#
|
public
|
release_fsghost(string $bin): bool
Flush sites retaining old inode copy
Flush sites retaining old inode copy
|
#
|