GatewayInterface

interface GatewayInterface (View source)

Methods

void connect(string $username)

Connect to the SSH server.

bool connected()

Determine if the gateway is connected.

void run(string $command)

Run a command against the server (non-blocking).

void put(string $local, string $remote)

Upload a local file to the server.

void putString(string $remote, string $contents)

Upload a string to to the given file on the server.

string|null nextLine()

Get the next line of output from the server.

int|bool status()

Get the exit status of the last command.

Details

void connect(string $username)

Connect to the SSH server.

Parameters

string $username

Return Value

void

bool connected()

Determine if the gateway is connected.

Return Value

bool

void run(string $command)

Run a command against the server (non-blocking).

Parameters

string $command

Return Value

void

void put(string $local, string $remote)

Upload a local file to the server.

Parameters

string $local
string $remote

Return Value

void

void putString(string $remote, string $contents)

Upload a string to to the given file on the server.

Parameters

string $remote
string $contents

Return Value

void

string|null nextLine()

Get the next line of output from the server.

Return Value

string|null

int|bool status()

Get the exit status of the last command.

Return Value

int|bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Remote/GatewayInterface.html