PHP Interface Liip\RMT\VCS\VCSInterface

s
Mostrar archivo Open project: liip/rmt Interface Usage Examples

Public Methods

Method Description
createTag ( string $tagName ) Create a new tag at the current position
getAllModificationsSince ( string $tag, boolean $color = true, boolean $noMergeCommits = false ) : array Return the list of all modifications from the given tag until now
getCurrentBranch ( ) Return the current branch
getLocalModifications ( ) : array Return local modification
getModifiedFilesSince ( string $tag ) : array Return the list of all modified files from the given tag until now The result is an array with the filename as key and the status as value.
getTags ( ) : array Return all tags of the project
publishChanges ( string | null $remote = null ) Publish local modification
publishTag ( string $tagName, string | null $remote = null ) Publish a new created tag
saveWorkingCopy ( string $commitMsg = '' ) : mixed Save the local modifications (commit)

Method Details

createTag() public method

Create a new tag at the current position
public createTag ( string $tagName )
$tagName string

getAllModificationsSince() public method

Return the list of all modifications from the given tag until now
public getAllModificationsSince ( string $tag, boolean $color = true, boolean $noMergeCommits = false ) : array
$tag string
$color boolean
$noMergeCommits boolean
return array

getCurrentBranch() public method

Return the current branch
public getCurrentBranch ( )

getLocalModifications() public method

Return local modification
public getLocalModifications ( ) : array
return array of local modification

getModifiedFilesSince() public method

Status is one of the following : M (modified), A (added), R (removed)
public getModifiedFilesSince ( string $tag ) : array
$tag string
return array

getTags() public method

Return all tags of the project
public getTags ( ) : array
return array

publishChanges() public method

Publish local modification
public publishChanges ( string | null $remote = null )
$remote string | null

publishTag() public method

Publish a new created tag
public publishTag ( string $tagName, string | null $remote = null )
$tagName string
$remote string | null

saveWorkingCopy() public method

Save the local modifications (commit)
public saveWorkingCopy ( string $commitMsg = '' ) : mixed
$commitMsg string
return mixed