Extensions API Documentation - Plesk 18.0
\

\pm_ApiCli

Gateway for execution of CLI utilities

Summary

Methods
Properties
Constants
call()
callSbin()
callDomain()
No public properties found
RESULT_FULL
RESULT_STDOUT
RESULT_STDERR
RESULT_CODE
RESULT_EXCEPTION
No protected methods found
No protected properties found
N/A

Constants

RESULT_FULL

RESULT_FULL

RESULT_STDOUT

RESULT_STDOUT

RESULT_STDERR

RESULT_STDERR

RESULT_CODE

RESULT_CODE

RESULT_EXCEPTION

RESULT_EXCEPTION

Methods

call()

call(string  $command, array  $args = array(), integer  $result = 5, array  $env = array()) : array|integer|string

Execute CLI utility (from set provided by panel)

Parameters

string $command
array $args
integer $result
array $env

Throws

\pm_Exception

Returns

array|integer|string

callSbin()

callSbin(string  $command, array  $args = array(), integer  $result = 5, array  $env = array()) : array|integer|string

Execute privileged CLI utility

Parameters

string $command
array $args
integer $result
array $env

Throws

\pm_Exception

Returns

array|integer|string

callDomain()

callDomain(\pm_Domain  $domain, string  $workingDir, string  $command, array  $args = array(), integer  $result = 5, array  $env = array()) : array|integer|string

Execute specified command as domain user

Parameters

\pm_Domain $domain
string $workingDir
string $command
array $args
integer $result
array $env

Throws

\pm_Exception

Returns

array|integer|string