• Главная
• DNEnvironment

PHP Класс 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. Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$db	array
$has_many	array
$has_one	array
$many_many	array
$searchable_fields	array
$summary_fields	array

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

Метод	Описание
Backend ( ) : DeploymentBackend	Get the deployment backend used for this environment.
CurrentBuild ( ) : false | DNDeployment	Get the current deployed build for this environment
CurrentMenu ( )	Return the current object from $this->Menu() Good for making titles and things
DNData ( ) : DNData
DeployHistory ( string $orderBy = '' ) : ArrayList	A list of past deployments.
DeploymentsLink ( ) : string	This provides the link to the deployments depending on whether the feature flag for the new deployment is enabled.
IsNewDeployEnabled ( ) : boolean	Check if the new deployment form is enabled by whether the project has it, falling back to environment variables on whether it's enabled.
Link ( string $action = '' ) : string
Menu ( )
array_to_viewabledata ( array $array ) : object	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.
canBackup ( Member | null $member = null ) : boolean	Allows only selected {@link Member} objects to backup this {@link DNEnvironment} to a {@link DNDataArchive} file.
canDeleteArchive ( Member | null $member = null ) : boolean	Allows only selected {@link Member} objects to delete {@link DNDataArchive} objects from this {@link DNEnvironment}.
canDeploy ( Member | null $member = null ) : boolean	Allow deploy only to some people.
canDownloadArchive ( Member | null $member = null ) : boolean	Allows only selected {@link Member} objects to download {@link DNDataArchive} objects from this {@link DNEnvironment}.
canRestore ( Member | null $member = null ) : boolean	Allows only selected {@link Member} objects to restore {@link DNDataArchive} objects into this {@link DNEnvironment}.
canUploadArchive ( Member | null $member = null ) : boolean	Allows only selected {@link Member} objects to upload {@link DNDataArchive} objects linked to this {@link DNEnvironment}.
canView ( Member | null $member = null ) : boolean	Environments are only viewable by people that can view the environment.
create_from_path ( string $path ) : DNEnvironment	Used by the sync task
getArchiveDeletersList ( ) : string	Get a string of groups/people that are allowed to delete {@link DNDataArchive} objects from this environment.
getArchiveDownloadersList ( ) : string	Get a string of groups/people that are allowed to download {@link DNDataArchive} objects from this environment.
getArchiveUploadersList ( ) : string	Get a string of groups/people that are allowed to upload {@link DNDataArchive} objects linked to this environment.
getBareDefaultURL ( )
getBareURL ( )
getCMSFields ( ) : FieldList
getCanBackupMembersList ( ) : string	Get a string of groups/people that are allowed to backup {@link DNDataArchive} objects from this environment.
getCanRestoreMembersList ( ) : string	Get a string of groups/people that are allowed to restore {@link DNDataArchive} objects into this environment.
getCannotDeployMessage ( ) : string	Provide reason why the user cannot deploy.
getCommit ( string $sha ) : Gitonomy\Git\Commit	This is a proxy call to gitonmy that caches the information per project and sha
getCommitMessage ( Gitonomy\Git\Commit $commit )
getCommitSubjectMessage ( Gitonomy\Git\Commit $commit )
getCommitTags ( Gitonomy\Git\Commit $commit )
getConfigFilename ( ) : string	Returns the path to the ruby config file
getDefaultURL ( )	URL for the environment that can be used if no explicit URL is set.
getDeployStrategy ( SS_HTTPRequest $request ) : DeploymentStrategy
getDeployersList ( ) : string	Get a string of groups/people that are allowed to deploy to this environment.
getFullName ( string $separator = ':' ) : string	Return a name for this environment.
getSupportedOptions ( ) : ArrayList	Return the supported options for this environment.
isCurrent ( ) : boolean	Is this environment currently at the root level of the controller that handles it?
isSection ( ) : boolean	Is this environment currently in a controller that is handling it or performing a sub-task?
onAfterDelete ( )	Delete any related config files
onAfterWrite ( )
onBeforeWrite ( )
runningDeployments ( ) : DataList	Fetchs all deployments in progress. Limits to 1 hour to prevent deployments if an old deployment is stuck.

Защищенные методы

Метод	Описание
buildPermissionField ( string $groupField, string $memberField, array $groups, array $members ) : FieldGroup	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 ( ) : boolean
getCommitData ( string $sha ) : array
getEnvironmentConfig ( ) : string
setDeployConfigurationFields ( FieldList &$fields )
validate ( )
writeConfigFile ( )	Write the deployment config file to filesystem

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

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