PHP Class Deployer\Server\Configuration

Show file Open project: elfet/deployer Class Usage Examples

Public Methods

Method Description
__construct ( string $name, string $host, integer $port = 22 ) Construct
getAuthenticationMethod ( ) : integer Get authentication method
getConfigFile ( ) : string Get configuration file
getHost ( ) : string Get host for connection
getName ( ) : string Get name
getPassPhrase ( ) : string Get pass phrase
getPassword ( ) : string Get password for connection
getPemFile ( ) : string Get pem file
getPort ( ) : integer Get port
getPrivateKey ( ) : string Get private key
getPublicKey ( ) : string Get public key
getSsh2Pty ( ) : mixed Get pty option for ssh2 connection
getUser ( ) : string Get user
setAuthenticationMethod ( integer $authenticationMethod ) : Configuration Set authentication method
setConfigFile ( string $configFile ) : Configuration Set configuration file
setHost ( string $host ) : Configuration Set host for connection
setName ( string $name ) : Configuration Set name
setPassPhrase ( string $passPhrase ) : Configuration Set pass phrase
setPassword ( string $password ) : Configuration Set password for connection
setPemFile ( string $pemFile ) : Configuration To auth with pem file use pemFile() method instead of this.
setPort ( integer $port ) : Configuration Set port for connection
setPrivateKey ( string $path ) : Configuration Set private key
setPublicKey ( string $path ) : Configuration Set public key
setSsh2Pty ( $ssh2Pty ) Set pty for ssh2 connection
setUser ( string $user ) : Configuration Set user

Private Methods

Method Description
getRealPassword ( mixed $password ) : string Get real password
parseHome ( string $path ) : string Parse "~" symbol from path.

Method Details

__construct() public method

Construct
public __construct ( string $name, string $host, integer $port = 22 )
$name string
$host string
$port integer

getAuthenticationMethod() public method

Get authentication method
public getAuthenticationMethod ( ) : integer
return integer

getConfigFile() public method

Get configuration file
public getConfigFile ( ) : string
return string

getHost() public method

Get host for connection
public getHost ( ) : string
return string

getName() public method

Get name
public getName ( ) : string
return string

getPassPhrase() public method

Get pass phrase
public getPassPhrase ( ) : string
return string

getPassword() public method

Get password for connection
public getPassword ( ) : string
return string

getPemFile() public method

Get pem file
public getPemFile ( ) : string
return string

getPort() public method

Get port
public getPort ( ) : integer
return integer

getPrivateKey() public method

Get private key
public getPrivateKey ( ) : string
return string

getPublicKey() public method

Get public key
public getPublicKey ( ) : string
return string

getSsh2Pty() public method

Get pty option for ssh2 connection
public getSsh2Pty ( ) : mixed
return mixed

getUser() public method

Get user
public getUser ( ) : string
return string

setAuthenticationMethod() public method

Set authentication method
public setAuthenticationMethod ( integer $authenticationMethod ) : Configuration
$authenticationMethod integer
return Configuration

setConfigFile() public method

Set configuration file
public setConfigFile ( string $configFile ) : Configuration
$configFile string
return Configuration

setHost() public method

Set host for connection
public setHost ( string $host ) : Configuration
$host string
return Configuration

setName() public method

Set name
public setName ( string $name ) : Configuration
$name string
return Configuration

setPassPhrase() public method

Set pass phrase
public setPassPhrase ( string $passPhrase ) : Configuration
$passPhrase string
return Configuration

setPassword() public method

Set password for connection
public setPassword ( string $password ) : Configuration
$password string
return Configuration

setPemFile() public method

To auth with pem file use pemFile() method instead of this.
public setPemFile ( string $pemFile ) : Configuration
$pemFile string
return Configuration

setPort() public method

Set port for connection
public setPort ( integer $port ) : Configuration
$port integer
return Configuration

setPrivateKey() public method

Set private key
public setPrivateKey ( string $path ) : Configuration
$path string
return Configuration

setPublicKey() public method

Set public key
public setPublicKey ( string $path ) : Configuration
$path string
return Configuration

setSsh2Pty() public method

Set pty for ssh2 connection
public setSsh2Pty ( $ssh2Pty )
$ssh2Pty

setUser() public method

Set user
public setUser ( string $user ) : Configuration
$user string
return Configuration