1. interface
  2. UnitPhpSdk
  3. \
  4. Contracts
  5. \
  6. UnitInterface

UnitInterface

interface UnitInterface

Methods

string
getSocket()

Return Unit socket

string
getAddress()

Return Unit address

StatisticsInterface
getStatistics()

Return Usage Statistics from Unit

array
getCertificates()

Return array of certificates uploaded on Unit

CertificateInterface|null
getCertificate(string $certificateName)

Return Certificate object

bool
uploadCertificate(string $path, string $certificateName)

Upload certificate to Unit server

ConfigInterface
getConfig()

Return full config uploaded on Nginx Unit

bool
uploadConfigFromFile(string $path)

Upload full file config

bool
removeCertificate(string $certificateName)

Remove certificate on Unit server

bool
removeConfig()

Remove all data from config

Details

at line 15
string getSocket()

Return Unit socket

Return Value

string

at line 22
string getAddress()

Return Unit address

Return Value

string

at line 30
StatisticsInterface getStatistics()

Return Usage Statistics from Unit

Return Value

StatisticsInterface

Exceptions

UnitException

at line 37
array getCertificates()

Return array of certificates uploaded on Unit

Return Value

array

at line 45
CertificateInterface|null getCertificate(string $certificateName)

Return Certificate object

Parameters

string $certificateName

Return Value

CertificateInterface|null

at line 55
bool uploadCertificate(string $path, string $certificateName)

Upload certificate to Unit server

Parameters

string $path
string $certificateName

Return Value

bool

Exceptions

UnitException

at line 62
ConfigInterface getConfig()

Return full config uploaded on Nginx Unit

Return Value

ConfigInterface

at line 70
bool uploadConfigFromFile(string $path)

Upload full file config

Parameters

string $path

Return Value

bool

at line 79
bool removeCertificate(string $certificateName)

Remove certificate on Unit server

Parameters

string $certificateName

Return Value

bool

Exceptions

UnitException

at line 86
bool removeConfig()

Remove all data from config

Return Value

bool