PHP Class VersionPress\ChangeInfos\ChangeInfoEnvelope

Inheritance: implements VersionPress\ChangeInfos\ChangeInfo
Afficher le fichier Open project: versionpress/versionpress Class Usage Examples

Méthodes publiques

Méthode 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

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

Method Details

__construct() public méthode

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

getChangeDescription() public méthode

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
Résultat string

getChangeInfoList() public méthode

Returns all ChangeInfo objects encapsulated in ChangeInfoEnvelope.
public getChangeInfoList ( ) : TrackedChangeInfo[]
Résultat TrackedChangeInfo[]

getCommitMessage() public méthode

Creates a commit message from this ChangeInfo. Used by Committer.
See also: Committer::commit()
public getCommitMessage ( ) : CommitMessage
Résultat VersionPress\Git\CommitMessage

getEnvironment() public méthode

public getEnvironment ( ) : null | string
Résultat null | string

getPriority() public méthode

public getPriority ( )

getReorganizedInfoList() public méthode

Returns sorted list of ChangeInfo objects with bulk actions encapsulated into BulkChangeInfo objects.
public getReorganizedInfoList ( ) : TrackedChangeInfo[]
Résultat TrackedChangeInfo[]