Skip to content

ChangelogRelease

github-actions edited this page Apr 22, 2026 · 1 revision

Represents one Keep a Changelog release section.


  • Full name: \FastForward\DevTools\Changelog\Document\ChangelogRelease
  • This class is marked as final and can't be subclassed
  • This class is a Final class

Methods

__construct

public __construct(string $version, ?string $date = null, array<string,list<string>> $entries = []): mixed

Parameters:

Parameter Type Description
$version string
$date ?string
$entries array<string,list>

getVersion

Returns the section version label.

public getVersion(): string

getDate

Returns the release date when present.

public getDate(): ?string

isUnreleased

Returns whether this section is the active Unreleased section.

public isUnreleased(): bool

getEntries

Returns all entries keyed by changelog category.

public getEntries(): array<string,list<string>>

getEntriesFor

Returns the entries for a specific changelog category.

public getEntriesFor(\FastForward\DevTools\Changelog\Entry\ChangelogEntryType $type): list<string>

Parameters:

Parameter Type Description
$type \FastForward\DevTools\Changelog\Entry\ChangelogEntryType

hasEntries

Returns whether the section contains at least one meaningful entry.

public hasEntries(): bool

withEntry

Returns a copy with an additional entry appended to the given category.

public withEntry(\FastForward\DevTools\Changelog\Entry\ChangelogEntryType $type, string $entry): self

Parameters:

Parameter Type Description
$type \FastForward\DevTools\Changelog\Entry\ChangelogEntryType
$entry string

withEntries

Returns a copy with all entries replaced by the supplied map.

public withEntries(array<string,list<string>> $entries): self

Parameters:

Parameter Type Description
$entries array<string,list>

withDate

Returns a copy with the release date replaced.

public withDate(?string $date): self

Parameters:

Parameter Type Description
$date ?string

Clone this wiki locally