PHP Class Prose\FromHost

See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Inheritance: extends HostBase
Afficher le fichier Open project: datasift/storyplayer

Méthodes publiques

Méthode Description
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

Méthodes protégées

Méthode Description
getLegacyAppSetting ( string $appName, string $settingName ) : mixed

Method Details

downloadFile() public méthode

public downloadFile ( string $sourceFilename, string $destFilename ) : CommandResult
$sourceFilename string
$destFilename string
Résultat DataSift\Storyplayer\CommandLib\CommandResult

getAllScreenSessions() public méthode

public getAllScreenSessions ( ) : array
Résultat array

getAppSetting() public méthode

public getAppSetting ( string $path, string | null $settingName = null ) : mixed
$path string
$settingName string | null
Résultat mixed

getAppSettings() public méthode

public getAppSettings ( string $appName ) : mixed
$appName string
Résultat mixed

getDetails() public méthode

public getDetails ( ) : object
Résultat object

getFileDetails() public méthode

public getFileDetails ( string $filename ) : object
$filename string
Résultat object

getHostIsRunning() public méthode

is a host up and running?
public getHostIsRunning ( ) : boolean
Résultat boolean

getHostname() public méthode

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
Résultat string

getInstalledPackageDetails() public méthode

public getInstalledPackageDetails ( string $packageName ) : object
$packageName string
Résultat object

getIpAddress() public méthode

get the IP address for a host
public getIpAddress ( ) : string
Résultat string

getIsScreenRunning() public méthode

public getIsScreenRunning ( string $sessionName ) : boolean
$sessionName string
Résultat boolean

getLegacyAppSetting() protected méthode

protected getLegacyAppSetting ( string $appName, string $settingName ) : mixed
$appName string
$settingName string
Résultat mixed

getLocalFolder() public méthode

which local folder do we need to be in when working with this host?
public getLocalFolder ( ) : string
Résultat string

getPid() public méthode

public getPid ( string $processName ) : integer
$processName string
Résultat integer

getPidIsRunning() public méthode

public getPidIsRunning ( integer $pid ) : boolean
$pid integer
Résultat boolean

getProcessIsRunning() public méthode

public getProcessIsRunning ( string $processName ) : boolean
$processName string
Résultat boolean

getScreenIsRunning() public méthode

public getScreenIsRunning ( string $sessionName ) : boolean
$sessionName string
Résultat boolean

getScreenSessionDetails() public méthode

public getScreenSessionDetails ( string $sessionName ) : DataSift\Stone\ObjectLib\BaseObject | null
$sessionName string
Résultat DataSift\Stone\ObjectLib\BaseObject | null

getSshKeyFile() public méthode

public getSshKeyFile ( ) : string
Résultat string

getSshUsername() public méthode

public getSshUsername ( ) : string
Résultat string

getStorySetting() public méthode

public getStorySetting ( string $path ) : mixed
$path string
Résultat mixed