\DNEnvironment
DNEnvironment
This dataobject represents a target environment that source code can be deployed to.
Permissions are controlled by environment, see the various many-many relationships.
Synopsis
class DNEnvironment
extends DataObject
{
- // members
- private static string $template_file = '';
- private static bool $allow_web_editing = false;
- private static array $casting = ;
- private static array $allowed_backends = ;
- public static array $db = ;
- public static array $has_one = ;
- public static array $has_many = ;
- public static array $many_many = ;
- public static array $summary_fields = ;
- private static string $singular_name = 'Capistrano Environment';
- private static string $plural_name = 'Capistrano Environments';
- public static array $searchable_fields = ;
- private static string $default_sort = 'Name';
- // methods
- public static DNEnvironment create_from_path()
- public DeploymentBackend Backend()
- public string getFullName()
- public boolean HasPipelineSupport()
- public Pipeline GenericPipeline()
- public ArrayData GenericPipelineConfig()
- public array loadPipelineConfig()
- public void DependsOnEnvironment()
- public bool HasCurrentPipeline()
- public Pipeline|null CurrentPipeline()
- public bool CanCancelPipeline()
- public boolean canView()
- public boolean canDeploy()
- public boolean canRestore()
- public boolean canBackup()
- public boolean canUploadArchive()
- public boolean canDownloadArchive()
- public boolean canAbort()
- public boolean canApprove()
- public boolean canDeleteArchive()
- public string getDeployersList()
- public string getCanRestoreMembersList()
- public string getCanBackupMembersList()
- public string getArchiveUploadersList()
- public string getArchiveDownloadersList()
- public string getArchiveDeletersList()
- public string getPipelineApproversList()
- public string getPipelineCancellersList()
- public DNData DNData()
- public string CurrentBuild()
- public ArrayList DeployHistory()
- protected array getCommitData()
- public string Link()
- protected FieldGroup buildPermissionField()
- public FieldList getCMSFields()
- protected void setDeployConfigurationFields()
- protected void setPipelineConfigurationFields()
- public void onBeforeWrite()
- protected void checkEnvironmentPath()
- protected void writeConfigFile()
- protected void writePipelineFile()
- public void onAfterDelete()
- protected string getEnvironmentConfig()
- protected boolean envFileExists()
- public string getConfigFilename()
- public string getPipelineFilename()
- protected boolean pipelineFileExists()
- public static array_to_viewabledata()
- public DataList getDependentFilteredCommits()
- public void enableMaintenace()
- public void disableMaintenance()
- protected void validate()
Hierarchy
Extends
- DataObject
Members
private
- $allow_web_editing
—
bool
Set this to true to allow editing of the environment files via the web admin -
$allowed_backends
Allowed backends. A map of Injector identifier to human-readable label. - $casting
- $default_sort — string
- $plural_name
- $singular_name
- $template_file
—
string
If this is set to a full pathfile, it will be used as template file when creating a new capistrano environment config file.
public
- $db — array
- $has_many — array
- $has_one — array
- $many_many — array
- $searchable_fields — array
- $summary_fields — array
Methods
protected
- buildPermissionField() — Build a set of multi-select fields for assigning permissions to a pair of group and member many_many relations
- checkEnvironmentPath() — Ensure that environment paths are setup on the local filesystem
- envFileExists()
- getCommitData()
- getEnvironmentConfig()
- pipelineFileExists() — Does this environment have a pipeline config file
- setDeployConfigurationFields()
- setPipelineConfigurationFields()
- validate()
- writeConfigFile() — Write the deployment config file to filesystem
- writePipelineFile() — Write the pipeline config file to filesystem
public
- Backend() — Get the deployment backend used for this environment.
- CanCancelPipeline()
- CurrentBuild() — Get the current deployed build for this environment
- CurrentPipeline() — This can be used to determine if there is a currently running pipeline (there can only be one running per {@link DNEnvironment} at once), as well as getting the current pipeline to be shown in templates.
- DNData()
- DependsOnEnvironment() — Returns the {@link DNEnvironment} object relating to the pipeline config for this environment. The environment YAML file (e.g. project1-uat.yml; see docs/en/pipelines.md) contains two variable called `DependsOnProject` and `DependsOnEnvironment` - these are used together to find the {@link DNEnvironment} that this environment should rely on.
- DeployHistory() — A history of all builds deployed to this environment
- GenericPipeline() — Returns a {@link Pipeline} object that is linked to this environment, but isn't saved into the database. This shouldn't be saved into the database unless you plan on starting an actual pipeline.
- GenericPipelineConfig() — Returns the parsed config, based on a {@link Pipeline} being created for this {@link DNEnvironment}.
- HasCurrentPipeline()
- HasPipelineSupport()
- Link()
- array_to_viewabledata() — Helper function to convert a multi-dimensional array (associative or indexed) to an {@link ArrayList} or {@link ArrayData} object structure, so that values can be used in templates.
- canAbort() — Determine if the specified user can abort any pipelines
- canApprove() — Determine if the specified user can approve any pipelines
- canBackup() — Allows only selected {@link Member} objects to backup this {@link DNEnvironment} to a {@link DNDataArchive} file.
- canDeleteArchive() — Allows only selected {@link Member} objects to delete {@link DNDataArchive} objects from this {@link DNEnvironment}.
- canDeploy() — Allow deploy only to some people.
- canDownloadArchive() — Allows only selected {@link Member} objects to download {@link DNDataArchive} objects from this {@link DNEnvironment}.
- canRestore() — Allows only selected {@link Member} objects to restore {@link DNDataArchive} objects into this {@link DNEnvironment}.
- canUploadArchive() — Allows only selected {@link Member} objects to upload {@link DNDataArchive} objects linked to this {@link DNEnvironment}.
- canView() — Environments are only viewable by people that can view the environment.
- create_from_path() — Used by the sync task
- disableMaintenance() — Disable maintenance page
- enableMaintenace() — Enable the maintenance page
- getArchiveDeletersList() — Get a string of groups/people that are allowed to delete {@link DNDataArchive} objects from this environment.
- getArchiveDownloadersList() — Get a string of groups/people that are allowed to download {@link DNDataArchive} objects from this environment.
- getArchiveUploadersList() — Get a string of groups/people that are allowed to upload {@link DNDataArchive} objects linked to this environment.
- getCMSFields()
- getCanBackupMembersList() — Get a string of groups/people that are allowed to backup {@link DNDataArchive} objects from this environment.
- getCanRestoreMembersList() — Get a string of groups/people that are allowed to restore {@link DNDataArchive} objects into this environment.
- getConfigFilename() — Returns the path to the ruby config file
- getDependentFilteredCommits() — Helper function to retrieve filtered commits from an environment this environment depends on
- getDeployersList() — Get a string of groups/people that are allowed to deploy to this environment.
- getFullName() — Return a name for this environment.
- getPipelineApproversList() — Get a string of groups/people that are allowed to approve pipelines
- getPipelineCancellersList() — Get a string of groups/people that are allowed to cancel pipelines
- getPipelineFilename() — Returns the path to the {@link Pipeline} configuration for this environment.
- loadPipelineConfig() — Extract pipeline configuration data from the source yml file
- onAfterDelete() — Delete any related config files
- onBeforeWrite()