PHP Class DataSift\Storyplayer\CommandLib\SshClient

See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Inheritance: implements DataSift\Storyplayer\CommandLib\CommandClient
Show file Open project: datasift/storyplayer Class Usage Examples

Protected Properties

Property Type Description
$ipAddress string
$scpOptions array
$sshKey string
$sshOptions array
$sshUsername string
$st DataSift\Storyplayer\PlayerLib\StoryTeller

Public Methods

Method Description
__construct ( StoryTeller $st, $sshOptions = [], $scpOptions = [] )
addScpOption ( string $option ) : void
addSshOption ( string $option ) : void
convertParamsForUse ( string $params ) : string
downloadFile ( $sourceFilename, $destFilename )
getDefaultScpOptions ( )
getDefaultSshOptions ( )
getIpAddress ( ) : string
getScpOptions ( ) : array
getScpOptionsForUse ( ) : string
getSshKey ( ) : string
getSshKeyForUse ( ) : string
getSshOptions ( ) : array
getSshOptionsForUse ( ) : string
getSshUsername ( ) : string
hasIpAddress ( ) : boolean
hasSshUsername ( ) : boolean
runCommand ( string $command ) : CommandResult
setIpAddress ( string $ipAddress )
setSshKey ( string $path ) : void
setSshUsername ( string $username ) : void
uploadFile ( $sourceFilename, $destFilename )

Method Details

__construct() public method

public __construct ( StoryTeller $st, $sshOptions = [], $scpOptions = [] )
$st DataSift\Storyplayer\PlayerLib\StoryTeller

addScpOption() public method

public addScpOption ( string $option ) : void
$option string
return void

addSshOption() public method

public addSshOption ( string $option ) : void
$option string
return void

convertParamsForUse() public method

Deprecation:
public convertParamsForUse ( string $params ) : string
$params string
return string

downloadFile() public method

public downloadFile ( $sourceFilename, $destFilename )

getDefaultScpOptions() public method

public getDefaultScpOptions ( )

getDefaultSshOptions() public method

public getDefaultSshOptions ( )

getIpAddress() public method

public getIpAddress ( ) : string
return string

getScpOptions() public method

public getScpOptions ( ) : array
return array

getScpOptionsForUse() public method

public getScpOptionsForUse ( ) : string
return string

getSshKey() public method

public getSshKey ( ) : string
return string

getSshKeyForUse() public method

public getSshKeyForUse ( ) : string
return string

getSshOptions() public method

public getSshOptions ( ) : array
return array

getSshOptionsForUse() public method

public getSshOptionsForUse ( ) : string
return string

getSshUsername() public method

public getSshUsername ( ) : string
return string

hasIpAddress() public method

public hasIpAddress ( ) : boolean
return boolean

hasSshUsername() public method

public hasSshUsername ( ) : boolean
return boolean

runCommand() public method

public runCommand ( string $command ) : CommandResult
$command string
return CommandResult

setIpAddress() public method

public setIpAddress ( string $ipAddress )
$ipAddress string

setSshKey() public method

public setSshKey ( string $path ) : void
$path string
return void

setSshUsername() public method

public setSshUsername ( string $username ) : void
$username string
return void

uploadFile() public method

public uploadFile ( $sourceFilename, $destFilename )

Property Details

$ipAddress protected property

protected string $ipAddress
return string

$scpOptions protected property

protected array $scpOptions
return array

$sshKey protected property

protected string $sshKey
return string

$sshOptions protected property

protected array $sshOptions
return array

$sshUsername protected property

protected string $sshUsername
return string

$st protected property

protected StoryTeller,DataSift\Storyplayer\PlayerLib $st
return DataSift\Storyplayer\PlayerLib\StoryTeller