PHP Class Laravel\Envoy\SSHConfigFile

Show file Open project: laravel/envoy

Protected Properties

Property	Type	Description
$groups	array	The SSH configuration groups.

Public Methods

Method	Description
__construct ( array $groups ) : void	Create a new SSH configuration file.
findConfiguredHost ( string $host ) : string \| null	Get the configured SSH host by name or IP.
parse ( string $file ) : SSHConfigFile	Parse the given configuration file.
parseString ( string $string ) : SSHConfigFile	Parse the given configuration string.

Protected Methods

Method	Description
parseHost ( string $host ) : array	Parse the host into user and host segments.

Private Methods

Method	Description
unquote ( string $string ) : string	Unquote an optionally double quoted string.

Method Details

__construct() public method

Create a new SSH configuration file.

public __construct ( array $groups ) : void
$groups	array
return	void

findConfiguredHost() public method

Get the configured SSH host by name or IP.

public findConfiguredHost ( string $host ) : string \| null
$host	string
return	string \| null

parse() public static method

Parse the given configuration file.

public static parse ( string $file ) : SSHConfigFile
$file	string
return	SSHConfigFile

parseHost() protected method

Parse the host into user and host segments.

protected parseHost ( string $host ) : array
$host	string
return	array

parseString() public static method

Parse the given configuration string.

public static parseString ( string $string ) : SSHConfigFile
$string	string
return	SSHConfigFile

Property Details

$groups protected property

The SSH configuration groups.

protected array $groups
return	array