PHP Класс Rocketeer\Services\Connections\ConnectionsHandler

Автор: Maxime Fabre ([email protected])
Наследование: use trait Rocketeer\Traits\HasLocator
Показать файл Открыть проект

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

Свойство Тип Описание
$connection The current connection.
$connections The connections to use.
$currentServer The current server.
$handle The current handle.
$stage The current stage.

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

Метод Описание
disconnect ( ) Flush active connection(s).
getAvailableConnections ( ) : string[][] | string[] Get the available connections.
getConnection ( ) : string Get the active connection.
getConnectionCredentials ( string | null $connection = null ) : string[][] Get the credentials for a particular connection.
getConnections ( ) : string[] Get the connection in use.
getHandle ( string | null $connection = null, integer | null $server = null, string | null $stage = null ) : string Build the current connection's handle.
getRepositoryBranch ( ) : string Get the repository branch to use.
getRepositoryCredentials ( ) : array Get the credentials for the repository.
getRepositoryEndpoint ( ) : string Get the URL to the Git repository.
getServer ( ) : integer
getServerCredentials ( string | null $connection = null, integer | null $server = null ) : mixed Get thecredentials for as server.
getStage ( ) : string Get the current stage.
getStages ( ) : array Get the various stages provided by the User.
isMultiserver ( string $connection ) : boolean Check if a connection is multiserver or not.
isValidConnection ( string $connection ) : boolean Check if a connection has credentials related to it.
needsCredentials ( ) : boolean Whether the repository used is using SSH or HTTPS.
setConnection ( string $connection, integer $server ) Set the current connection.
setConnections ( string | string[] $connections ) Set the active connections.
setStage ( string | null $stage ) Set the stage Tasks will execute on.
syncConnectionCredentials ( string | null $connection = null, array $credentials = [], integer $server ) Sync Rocketeer's credentials with Laravel's.

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

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

Flush active connection(s).
public disconnect ( )

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

Get the available connections.
public getAvailableConnections ( ) : string[][] | string[]
Результат string[][] | string[]

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

Get the active connection.
public getConnection ( ) : string
Результат string

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

Get the credentials for a particular connection.
public getConnectionCredentials ( string | null $connection = null ) : string[][]
$connection string | null
Результат string[][]

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

Get the connection in use.
public getConnections ( ) : string[]
Результат string[]

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

Build the current connection's handle.
public getHandle ( string | null $connection = null, integer | null $server = null, string | null $stage = null ) : string
$connection string | null
$server integer | null
$stage string | null
Результат string

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

Get the repository branch to use.
public getRepositoryBranch ( ) : string
Результат string

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

Get the credentials for the repository.
public getRepositoryCredentials ( ) : array
Результат array

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

Get the URL to the Git repository.
public getRepositoryEndpoint ( ) : string
Результат string

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

public getServer ( ) : integer
Результат integer

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

Get thecredentials for as server.
public getServerCredentials ( string | null $connection = null, integer | null $server = null ) : mixed
$connection string | null
$server integer | null
Результат mixed

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

Get the current stage.
public getStage ( ) : string
Результат string

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

Get the various stages provided by the User.
public getStages ( ) : array
Результат array

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

Check if a connection is multiserver or not.
public isMultiserver ( string $connection ) : boolean
$connection string
Результат boolean

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

Check if a connection has credentials related to it.
public isValidConnection ( string $connection ) : boolean
$connection string
Результат boolean

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

Whether the repository used is using SSH or HTTPS.
public needsCredentials ( ) : boolean
Результат boolean

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

Set the current connection.
public setConnection ( string $connection, integer $server )
$connection string
$server integer

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

Set the active connections.
public setConnections ( string | string[] $connections )
$connections string | string[]

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

Set the stage Tasks will execute on.
public setStage ( string | null $stage )
$stage string | null

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

Sync Rocketeer's credentials with Laravel's.
public syncConnectionCredentials ( string | null $connection = null, array $credentials = [], integer $server )
$connection string | null
$credentials array
$server integer

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

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

The current connection.
protected $connection

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

The connections to use.
protected $connections

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

The current server.
protected $currentServer

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

The current handle.
protected $handle

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

The current stage.
protected $stage