• Главная
• DNProject

PHP Класс DNProject

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

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

Свойство	Тип	Описание
$_current_member_cache	boolean | Member
$relation_cache	array	In-memory cache for currentBuilds per environment since fetching them from disk is pretty resource hungry.

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

Метод	Описание
APILink ( string $action ) : string
CreateEnvironmentLink ( ) : string | null
CurrentMenu ( ) : DataObject	Return the current object from $this->Menu() Good for making titles and things
DNBranchList ( ) : DNBranchList	Provides a list of the branches in this project.
DNBuildList ( ) : DNReferenceList	Provides a DNBuildList of builds found in this project.
DNData ( ) : DNData
DNEnvironmentList ( ) : ArrayList	Provides a list of environments found in this project.
DNTagList ( ) : DNReferenceList	Provides a list of the tags in this project.
DataArchives ( ) : DataList
DiskQuotaUsagePercent ( ) : integer	Returns the current disk quota usage as a percentage
EnvironmentsByUsage ( string $usage ) : ArrayList
HasDiskQuota ( ) : boolean	Is there a disk quota set for this project?
HasExceededDiskQuota ( ) : boolean	Has the disk quota been exceeded?
IsStarred ( ) : boolean
Link ( $action = '' ) : string
Menu ( ) : ArrayList	Get the menu to be shown on projects
PendingManualUploadDataArchives ( ) : DataList	Return all archives which are "manual upload requests", meaning they don't have a file attached to them (yet).
ToggleStarLink ( ) : string
allowed ( string $code, Member | null $member = null ) : boolean	Convenience wrapper for a single permission code.
allowedAny ( array | string $codes, Member | null $member = null ) : boolean	Check if member has a permission code in this project.
canBackup ( Member | null $member = null ) : boolean
canCreate ( Member $member = null ) : boolean
canCreateEnvironments ( Member | null $member = null ) : boolean	This is a permission check for the front-end only.
canDownloadArchive ( Member | null $member = null ) : boolean
canRestore ( Member | null $member = null ) : boolean
canUploadArchive ( Member | null $member = null ) : boolean
canView ( Member | null $member = null ) : boolean	Restrict access to viewing this project
clearGitCache ( )	This will clear the cache for the git getters and should be called when the local git repo is updated
cloneRepo ( ) : string	Setup a job to clone a git repository.
create_from_path ( string $path ) : DNProject	Used by the sync task
currentBuilds ( ) : false | DNDeployment	Returns a map of envrionment name to build name
getCMSFields ( ) : FieldList
getCommit ( string $sha ) : false | Gitonomy\Git\Commit	This is a proxy call to gitonmy that caches the information per project and sha
getCommitMessage ( Gitonomy\Git\Commit $commit ) : string
getCommitSubjectMessage ( Gitonomy\Git\Commit $commit ) : string	get the commit "subject", getCommitMessage get the full message
getCommitTags ( Gitonomy\Git\Commit $commit ) : mixed
getCompleteInitialEnvironmentCreations ( ) : DataList	Returns a list of completed initial environment creations. This includes failed tasks.
getDiskQuotaMB ( ) : string | integer	Getter for DiskQuotaMB field to provide a default for existing records that have no quota field set, as it will need to default to a globally set size.
getInitialEnvironmentCreations ( ) : DataList	Returns a list of initial environments created for this project.
getKeyDir ( ) : string | null	Returns the location of the projects key dir if one exists.
getLocalCVSPath ( ) : string
getPrivateKeyPath ( ) : string | null	This returns that path of the private key if a key directory is set. It doesn't check whether the file exists.
getProcessEnv ( ) : array	Build an environment variable array to be used with this project.
getPublicKey ( ) : string | void	Fetch the public key for this project.
getPublicKeyPath ( ) : string | null	This returns that path of the public key if a key directory is set. It doesn't check whether the file exists.
getRepository ( ) : false | Gitonomy\Git\Repository
getRepositoryInterface ( ) : ArrayData	Get a ViewableData structure describing the UI tool that lets the user view the repository code
getRepositoryURL ( ) : void | string	Provide current repository URL to the users.
getRunningEnvironmentCreations ( ) : SS_List	Returns a list of environments still being created.
getRunningInitialEnvironmentCreations ( ) : DataList	Only returns initial environments that are being created.
getUsedQuotaMB ( integer $round = 2 ) : double	Return the used quota in MB.
getViewersList ( ) : string	Get a string of people allowed to view this project
get_git_cache ( ) : Zend_Cache_Frontend_Output
groupAllowed ( string $permissionCode, Group $group ) : boolean	Checks if a group is allowed to the project and the permission code
isCurrent ( ) : boolean	Is this project currently at the root level of the controller that handles it?
isProjectReady ( ) : boolean	Checks if the environment has been fully built.
isSection ( ) : boolean	Is this project currently in a controller that is handling it or performing a sub-task?
onAfterDelete ( )	Delete related environments and folders
onAfterWrite ( )
onBeforeWrite ( )
projectFolderExists ( ) : boolean
repoExists ( ) : boolean
resolveRevision ( $value ) : boolean | string	Resolve a git reference like a branch or tag into a SHA.
setCreateProjectFolderField ( FieldList &$fields )	If there isn't a capistrano env project folder, show options to create one
whoIsAllowed ( string $code ) : SS_List	Convenience wrapper for a single permission code.
whoIsAllowedAny ( array | string $codes ) : SS_List	List members who have $codes on this project.

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

Метод	Описание
getProjectFolderPath ( ) : string
setEnvironmentFields ( FieldList &$fields, GridField $environments )	Setup a gridfield for the environment configs
validate ( ) : ValidationResult

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

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