1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: <?php
/**
* Copyright (C) Apis Networks, Inc - All Rights Reserved.
*
* Unauthorized copying of this file, via any medium, is
* strictly prohibited without consent. Any dissemination of
* material herein is prohibited.
*
* For licensing inquiries email <licensing@apisnetworks.com>
*
* Written by Matt Saladna <matt@apisnetworks.com>, November 2017
*/
/**
* WebApp Contract
*
*
* @package core
*/
namespace Module\Support\Webapps\Contracts;
/**
* Interface Webapp
*
* @package Module\Support\Webapps\Contracts
*/
interface Webapp
{
/**
* Install application
*
* @param string $hostname domain or subdomain to install application
* @param string $path optional path under hostname
* @param array $opts additional install options
* @return bool
*/
public function install(string $hostname, string $path = '', array $opts = array()): bool;
/**
* Get plugin status
*
* @param string $hostname domain or subdomain
* @param null|string $path optional path under hostname
* @param null|string $plugin specific plugin to query
* @return array|bool
*/
public function plugin_status(string $hostname, string $path = '', string $plugin = null);
/**
* Install and activate plugin
*
* @param string $hostname domain or subdomain of application
* @param string $path optional path component of application
* @param string $plugin plugin name
* @param string $version optional plugin version
* @return bool
*/
public function install_plugin(string $hostname, string $path, string $plugin, string $version = ''): bool;
/**
* Uninstall a plugin
*
* @param string $hostname domain or subdomain of application
* @param string $path optional path component of application
* @param string $plugin plugin name
* @param bool $force delete even if plugin activated
* @return bool
*/
public function uninstall_plugin(
string $hostname,
string $path,
string $plugin,
bool $force = false
): bool;
/**
* Recovery mode to disable all plugins
*
* @param string $hostname subdomain or domain of WP
* @param string $path optional path
* @return bool
*/
public function disable_all_plugins(string $hostname, string $path = ''): bool;
/**
* Install a theme
*
* @param string $hostname
* @param string $path
* @param string $theme theme name
* @param string $version optional version
*
* @return bool
*/
public function install_theme(string $hostname, string $path, string $theme, string $version = null): bool;
/**
* Get plugin status
*
* @param string $hostname domain or subdomain
* @param null|string $path optional path under hostname
* @param null|string $theme specific theme to query
* @return array|bool
*/
public function theme_status(string $hostname, string $path = '', string $theme = null);
/**
* Uninstall WP from a location
*
* @param string $hostname
* @param string $path
* @param string $delete "all", "db", or "files"
* @return bool
*/
public function uninstall(string $hostname, string $path = '', string $delete = 'all'): bool;
/**
* Get database configuration for application
*
* @param string $hostname domain or subdomain of wp blog
* @param string $path optional path
* @return bool|array
*/
public function db_config(string $hostname, string $path = '');
/**
* Check if version is latest or get latest version
*
* @param string|null $version version to query against
* @param string|null $branchcomp
* @return int|string
*/
public function is_current(string $version = null, string $branchcomp = null);
/**
* Get all available versions sorted in ascending semantic version
*
* @return array
*/
public function get_versions(): array;
/**
* Change admin credentials
*
* @param string $hostname domain or subdomain of application
* @param string $path optional path component
* @param array $fields fields to change
* @return bool
*/
public function change_admin(string $hostname, string $path, array $fields): bool;
/**
* Get the primary admin for a WP instance
*
* @param string $hostname
* @param null|string $path
* @return string|null admin or null on failure
*/
public function get_admin(string $hostname, string $path = ''): ?string;
/**
* Get installed version
*
* @param string $hostname
* @param string $path
* @return string|null|bool version number, null if not app or false on failure
*/
public function get_version(string $hostname, string $path = ''): ?string;
/**
* Calculate next version in hierarchy
*
* @param string $version base version
* @param string $maximalbranch max branch to inspect
* @return string|null
*/
public function next_version(string $version, string $maximalbranch = '99999999.99999999.99999999'): ?string;
/**
* Location is a valid webapp install
*
* @param string $hostname or $docroot
* @param string $path
* @return bool
*/
public function valid(string $hostname, string $path = ''): bool;
/**
* Update core, plugins, and themes atomically
*
* @param string $hostname subdomain or domain
* @param string $path optional path under hostname
* @param string $version
* @return bool
*/
public function update_all(string $hostname, string $path = '', string $version = null): bool;
/**
* Update WordPress to latest version
*
* @param string $hostname domain or subdomain under which WP is installed
* @param string $path optional subdirectory
* @param string $version
* @return bool
*/
public function update(string $hostname, string $path = '', string $version = null): bool;
/**
* Update WordPress plugins
*
* @param string $hostname domain or subdomain
* @param string $path optional path within host
* @param array $plugins
* @return bool
*/
public function update_plugins(string $hostname, string $path = '', array $plugins = array()): bool;
/**
* Update themes
*
* @param string $hostname subdomain or domain
* @param string $path optional path under hostname
* @param array $themes
* @return bool
*/
public function update_themes(string $hostname, string $path = '', array $themes = array()): bool;
/**
* Remove a theme
*
* @param string $hostname
* @param string $path
* @param string $theme
* @param bool $force deactivate if necessary before removal
* @return bool
*/
public function uninstall_theme(string $hostname, string $path, string $theme, bool $force = false): bool;
/**
* Web application supports fortification
*
* @param string $hostname
* @param string $path
* @param string|null $mode optional mode (min, max)
* @return bool
*/
public function has_fortification(string $hostname, string $path = '', string $mode = null): bool;
/**
* Supported Fortification modes
*
* @param string $hostname
* @param string $path
* @return array
*/
public function fortification_modes(string $hostname, string $path = ''): array;
/**
* Restrict write-access by the app
*
* @param string $hostname
* @param string $path
* @param string $mode
* @param array $args additional mode settings
* @return bool
*/
public function fortify(string $hostname, string $path = '', string $mode = 'max', $args = []): bool;
/**
* Relax permissions to allow write-access
*
* @param string $hostname
* @param string $path
* @return bool
* @internal param string $mode
*/
public function unfortify(string $hostname, string $path = ''): bool;
/**
* @param string $hostname hostname
* @param string $path optional path
* @param string|array $param array of reconfigurables or single value
* @param mixed $value value to set in single-value mode
* @return bool
*/
public function reconfigure(string $hostname, string $path, $param, $value = null): bool;
/**
* List of reconfigurable parameters
*
* @param string $hostname
* @param string $path
* @return array
*/
public function reconfigurables(string $hostname, string $path = ''): array;
/**
* Get reconfigurable value
*
* @param string $hostname
* @param string $path
* @param string|string[] $setting
* @return mixed
*/
public function get_reconfigurable(string $hostname, string $path, $setting);
/**
* Snapshot web application
*
* @param string $hostname
* @param string $path
* @param string $comment
* @return bool
*/
public function snapshot(string $hostname, string $path = '', string $comment = 'snapshot'): bool;
/**
* Rollback specified snapshot
*
* @param string $hostname
* @param string $path
* @param string|null $commit optional commit
* @return bool
*/
public function rollback(string $hostname, string $path = '', string $commit = null): bool;
}