\DNData
Parent class for managing a set of Deploynaut data
Synopsis
class DNData
extends ViewableData
{
- // members
- protected string $environmentDir = '';
- protected string $keyDir = '';
- protected string $dataTransferDir = '';
- protected string|null $gitUser = NULL;
- // methods
- public static DNData inst()
- public void __construct()
- public string getEnvironmentDir()
- public void setEnvironmentDir()
- public string getKeyDir()
- public void setKeyDir()
- public string getGitUser()
- public void setGitUser()
- public string getDataTransferDir()
- public void setDataTransferDir()
- public DataList DNProjectList()
- public array getProjectPaths()
- public void getEnvironmentPaths()
Hierarchy
Extends
- ViewableData
Members
protected
- $dataTransferDir
—
string
Path where data transfers are stored. - $environmentDir
—
string
Path where the environment configurations can be found. - $gitUser
—
string|null
If set, this provides an alternate user to the current one executing the Git shell commands. e.g. if this is set to a user called "composer", any Git commands that Deploynaut will perform will be run as "sudo -u composer git ..." - $keyDir
—
string
Path where the keys are stored.
Methods
public
- __construct()
- DNProjectList() — Provide a list of all projects.
- getDataTransferDir() — Get the directory where data transfers should be saved
- getEnvironmentDir() — Get the directory environment code is saved
- getEnvironmentPaths() — Scan the directory and enumerate all envs founds within.
- getGitUser() — Get the username that git commands should be run as
- getKeyDir() — Get the directory where ssh are stored
- getProjectPaths() — Grabs a list of projects from the env directory. The projects in the builds directory alone will not be picked up.
- inst() — Gets the DNData singleton
- setDataTransferDir() — Set the directory where data transfers should be saved
- setEnvironmentDir() — Set the directory environment code is saved
- setGitUser() — Get the username that git commands should be run as
- setKeyDir() — Set the directory where ssh are stored