PHP Interface VersionPress\ChangeInfos\ChangeInfo

ChangeInfo is first created from a hook that observes some action (see versionpress.php, or for {@link VersionPress\ChangeInfos\EntityChangeInfo}s the initiator is usually some {@link VersionPress\Storages\Storage}). The ChangeInfo is then persisted to a commit message by {@link Committer} and later reconstructed from it again when the main VersionPress table is being displayed (see admin/index.php and {@link VersionPress\ChangeInfos\ChangeInfoFactory}). There are two main classes of ChangeInfo objects: tracked and untracked ones, and the tracked change infos further have many specific types to represent various actions (for instance, post changes display different messages than comment messages). More docs on it in {@link VersionPress\ChangeInfos\TrackedChangeInfo}.
Afficher le fichier Open project: versionpress/versionpress Interface Usage Examples

Méthodes publiques

Méthode Description
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.
getCommitMessage ( ) : CommitMessage Creates a commit message from this ChangeInfo. Used by Committer.
getPriority ( )

Method Details

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

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

getPriority() public méthode

public getPriority ( )