-
-
Notifications
You must be signed in to change notification settings - Fork 0
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
public __construct(string $version, ?string $date = null, array<string,list<string>> $entries = []): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$version |
string | |
$date |
?string | |
$entries |
array<string,list> |
Returns the section version label.
public getVersion(): stringReturns the release date when present.
public getDate(): ?stringReturns whether this section is the active Unreleased section.
public isUnreleased(): boolReturns all entries keyed by changelog category.
public getEntries(): array<string,list<string>>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 |
Returns whether the section contains at least one meaningful entry.
public hasEntries(): boolReturns a copy with an additional entry appended to the given category.
public withEntry(\FastForward\DevTools\Changelog\Entry\ChangelogEntryType $type, string $entry): selfParameters:
| Parameter | Type | Description |
|---|---|---|
$type |
\FastForward\DevTools\Changelog\Entry\ChangelogEntryType | |
$entry |
string |
Returns a copy with all entries replaced by the supplied map.
public withEntries(array<string,list<string>> $entries): selfParameters:
| Parameter | Type | Description |
|---|---|---|
$entries |
array<string,list> |
Returns a copy with the release date replaced.
public withDate(?string $date): selfParameters:
| Parameter | Type | Description |
|---|---|---|
$date |
?string |