PHP Class VersionPress\ChangeInfos\ChangeInfoEnvelope

Inheritance: implements VersionPress\ChangeInfos\ChangeInfo

Show file Open project: versionpress/versionpress Class Usage Examples

Public Methods

Method	Description
__construct ( TrackedChangeInfo[] $changeInfoList, string \| null $version = null, string \| null $environment = null )
getChangeDescription ( ) : string	Text displayed in the main VersionPress table (see admin/index.php). Also used to construct commit message subject (first line) when the commit is first physically created.
getChangeInfoList ( ) : TrackedChangeInfo[]	Returns all ChangeInfo objects encapsulated in ChangeInfoEnvelope.
getCommitMessage ( ) : CommitMessage	Creates a commit message from this ChangeInfo. Used by Committer.
getEnvironment ( ) : null \| string
getPriority ( )
getReorganizedInfoList ( ) : TrackedChangeInfo[]	Returns sorted list of ChangeInfo objects with bulk actions encapsulated into BulkChangeInfo objects.

Private Methods

Method	Description
containsVersion ( $lastBody )
extractTag ( $tag, $lastBody )
getSortedChangeInfoList ( ) : TrackedChangeInfo[]
groupBulkActions ( $changeInfoList )
sortChangeInfoList ( TrackedChangeInfo[] $changeInfoList ) : TrackedChangeInfo[]

Method Details

__construct() public method

public __construct ( TrackedChangeInfo[] $changeInfoList, string \| null $version = null, string \| null $environment = null )
$changeInfoList	TrackedChangeInfo[]
$version	string \| null
$environment	string \| null

getChangeDescription() public method

Text displayed in the main VersionPress table (see admin/index.php). Also used to construct commit message subject (first line) when the commit is first physically created.

public getChangeDescription ( ) : string
return	string

getChangeInfoList() public method

Returns all ChangeInfo objects encapsulated in ChangeInfoEnvelope.

public getChangeInfoList ( ) : TrackedChangeInfo[]
return	TrackedChangeInfo[]

getCommitMessage() public method

Creates a commit message from this ChangeInfo. Used by Committer.

getEnvironment() public method

public getEnvironment ( ) : null \| string
return	null \| string

getPriority() public method

public getPriority ( )

getReorganizedInfoList() public method

Returns sorted list of ChangeInfo objects with bulk actions encapsulated into BulkChangeInfo objects.

public getReorganizedInfoList ( ) : TrackedChangeInfo[]
return	TrackedChangeInfo[]

public getCommitMessage ( ) : CommitMessage
return	VersionPress\Git\CommitMessage