PHP Класс Prose\FromHost

См. ссылку: http://datasift.github.io/storyplayer

Автор: Stuart Herbert ([email protected])

Наследование: extends HostBase

Открытые методы

Метод	Описание
downloadFile ( string $sourceFilename, string $destFilename ) : CommandResult
getAllScreenSessions ( ) : array
getAppSetting ( string $path, string \| null $settingName = null ) : mixed
getAppSettings ( string $appName ) : mixed
getDetails ( ) : object
getFileDetails ( string $filename ) : object
getHostIsRunning ( ) : boolean	is a host up and running?
getHostname ( ) : string	get the hostname for a host
getInstalledPackageDetails ( string $packageName ) : object
getIpAddress ( ) : string	get the IP address for a host
getIsScreenRunning ( string $sessionName ) : boolean
getLocalFolder ( ) : string	which local folder do we need to be in when working with this host?
getPid ( string $processName ) : integer
getPidIsRunning ( integer $pid ) : boolean
getProcessIsRunning ( string $processName ) : boolean
getScreenIsRunning ( string $sessionName ) : boolean
getScreenSessionDetails ( string $sessionName ) : DataSift\Stone\ObjectLib\BaseObject \| null
getSshKeyFile ( ) : string
getSshUsername ( ) : string
getStorySetting ( string $path ) : mixed

Защищенные методы

Метод	Описание
getLegacyAppSetting ( string $appName, string $settingName ) : mixed

Описание методов

downloadFile() публичный Метод

public downloadFile ( string $sourceFilename, string $destFilename ) : CommandResult
$sourceFilename	string
$destFilename	string
Результат	DataSift\Storyplayer\CommandLib\CommandResult

getAllScreenSessions() публичный Метод

public getAllScreenSessions ( ) : array
Результат	array

getAppSetting() публичный Метод

public getAppSetting ( string $path, string \| null $settingName = null ) : mixed
$path	string
$settingName	string \| null
Результат	mixed

getAppSettings() публичный Метод

public getAppSettings ( string $appName ) : mixed
$appName	string
Результат	mixed

getDetails() публичный Метод

public getDetails ( ) : object
Результат	object

getFileDetails() публичный Метод

public getFileDetails ( string $filename ) : object
$filename	string
Результат	object

getHostIsRunning() публичный Метод

is a host up and running?

public getHostIsRunning ( ) : boolean
Результат	boolean

getHostname() публичный Метод

the returned hostname is suitable for use in HTTP/HTTPS URLs if we have been unable to determine the hostname for the host, this will return the host's IP address instead

public getHostname ( ) : string
Результат	string

getInstalledPackageDetails() публичный Метод

public getInstalledPackageDetails ( string $packageName ) : object
$packageName	string
Результат	object

getIpAddress() публичный Метод

get the IP address for a host

public getIpAddress ( ) : string
Результат	string

getIsScreenRunning() публичный Метод

public getIsScreenRunning ( string $sessionName ) : boolean
$sessionName	string
Результат	boolean

getLegacyAppSetting() защищенный Метод

protected getLegacyAppSetting ( string $appName, string $settingName ) : mixed
$appName	string
$settingName	string
Результат	mixed

getLocalFolder() публичный Метод

which local folder do we need to be in when working with this host?

public getLocalFolder ( ) : string
Результат	string

getPid() публичный Метод

public getPid ( string $processName ) : integer
$processName	string
Результат	integer

getPidIsRunning() публичный Метод

public getPidIsRunning ( integer $pid ) : boolean
$pid	integer
Результат	boolean

getProcessIsRunning() публичный Метод

public getProcessIsRunning ( string $processName ) : boolean
$processName	string
Результат	boolean

getScreenIsRunning() публичный Метод

public getScreenIsRunning ( string $sessionName ) : boolean
$sessionName	string
Результат	boolean

getScreenSessionDetails() публичный Метод

public getScreenSessionDetails ( string $sessionName ) : DataSift\Stone\ObjectLib\BaseObject \| null
$sessionName	string
Результат	DataSift\Stone\ObjectLib\BaseObject \| null

getSshKeyFile() публичный Метод

public getSshKeyFile ( ) : string
Результат	string

getSshUsername() публичный Метод

public getSshUsername ( ) : string
Результат	string

getStorySetting() публичный Метод

public getStorySetting ( string $path ) : mixed
$path	string
Результат	mixed