PHP Класс DNData

Наследование: extends ViewableData
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$dataTransferDir string Needs to be relative to webroot, and start with assets/ since all files are also referenced in the SilverStripe database through {@link File}.
$environmentDir string Path where the environment configurations can be found.
$gitUser string | null .."
$keyDir string Path where the keys are stored.
$signalDir string Path where the signal files are created.

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

Метод Описание
DNProjectList ( ) : DataList Provide a list of all projects.
__construct ( $environmentDir = null, $keyDir = null, $signalDir = null, $dataTransferDir = null, $gitUser = null )
getDataTransferDir ( ) : string Get the directory where data transfers should be saved
getEnvironmentDir ( ) : string Get the directory environment code is saved
getEnvironmentPaths ( $project ) Scan the directory and enumerate all envs founds within.
getGitUser ( ) : string Get the username that git commands should be run as
getKeyDir ( ) : string Get the directory where ssh are stored
getProjectPaths ( ) : array Grabs a list of projects from the env directory. The projects in the builds directory alone will not be picked up.
getSignalDir ( ) : string
inst ( ) : DNData Gets the DNData singleton
setDataTransferDir ( string $transferDir ) Set the directory where data transfers should be saved
setEnvironmentDir ( string $environmentDir ) Set the directory environment code is saved
setGitUser ( string $user ) Get the username that git commands should be run as
setKeyDir ( string $keyDir ) Set the directory where ssh are stored
setSignalDir ( string $signalDir )

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

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

Provide a list of all projects.
public DNProjectList ( ) : DataList
Результат DataList

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

public __construct ( $environmentDir = null, $keyDir = null, $signalDir = null, $dataTransferDir = null, $gitUser = null )

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

Get the directory where data transfers should be saved
public getDataTransferDir ( ) : string
Результат string

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

Get the directory environment code is saved
public getEnvironmentDir ( ) : string
Результат string

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

Returns an array of paths
public getEnvironmentPaths ( $project )

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

Get the username that git commands should be run as
public getGitUser ( ) : string
Результат string

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

Get the directory where ssh are stored
public getKeyDir ( ) : string
Результат string

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

Returns an array of paths
public getProjectPaths ( ) : array
Результат array

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

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

inst() публичный статический Метод

Gets the DNData singleton
public static inst ( ) : DNData
Результат DNData

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

This should either be an absolute path (beginning with /) or a path that can be appended to the web root safely
public setDataTransferDir ( string $transferDir )
$transferDir string

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

Set the directory environment code is saved
public setEnvironmentDir ( string $environmentDir )
$environmentDir string

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

Get the username that git commands should be run as
public setGitUser ( string $user )
$user string

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

Set the directory where ssh are stored
public setKeyDir ( string $keyDir )
$keyDir string

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

public setSignalDir ( string $signalDir )
$signalDir string

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

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

Needs to be relative to webroot, and start with assets/ since all files are also referenced in the SilverStripe database through {@link File}.
protected string $dataTransferDir
Результат string

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

Path where the environment configurations can be found.
protected string $environmentDir
Результат string

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

.."
protected string|null $gitUser
Результат string | null

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

Path where the keys are stored.
protected string $keyDir
Результат string

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

Path where the signal files are created.
protected string $signalDir
Результат string