PHP Класс DataSift\Storyplayer\CommandLib\SshClient

См. ссылку: http://datasift.github.io/storyplayer
Автор: Stuart Herbert ([email protected])
Наследование: implements DataSift\Storyplayer\CommandLib\CommandClient
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$ipAddress string
$scpOptions array
$sshKey string
$sshOptions array
$sshUsername string
$st DataSift\Storyplayer\PlayerLib\StoryTeller

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

Метод Описание
__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 )

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

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

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

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

public addScpOption ( string $option ) : void
$option string
Результат void

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

public addSshOption ( string $option ) : void
$option string
Результат void

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

Устаревший:
public convertParamsForUse ( string $params ) : string
$params string
Результат string

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

public downloadFile ( $sourceFilename, $destFilename )

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

public getDefaultScpOptions ( )

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

public getDefaultSshOptions ( )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public runCommand ( string $command ) : CommandResult
$command string
Результат CommandResult

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

public setIpAddress ( string $ipAddress )
$ipAddress string

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

public setSshKey ( string $path ) : void
$path string
Результат void

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

public setSshUsername ( string $username ) : void
$username string
Результат void

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

public uploadFile ( $sourceFilename, $destFilename )

Описание свойств

$ipAddress защищенное свойство

protected string $ipAddress
Результат string

$scpOptions защищенное свойство

protected array $scpOptions
Результат array

$sshKey защищенное свойство

protected string $sshKey
Результат string

$sshOptions защищенное свойство

protected array $sshOptions
Результат array

$sshUsername защищенное свойство

protected string $sshUsername
Результат string

$st защищенное свойство

protected StoryTeller,DataSift\Storyplayer\PlayerLib $st
Результат DataSift\Storyplayer\PlayerLib\StoryTeller