ChangelogRelease
Represents one Keep a Changelog release section.
Properties
Methods
Returns the release date when present.
Returns all entries keyed by changelog category.
Returns the entries for a specific changelog category.
Returns the section version label.
Returns whether the section contains at least one meaningful entry.
Returns whether this section is the active Unreleased section.
Returns a copy with the release date replaced.
Returns a copy with all entries replaced by the supplied map.
Returns a copy with an additional entry appended to the given category.
public
__construct(
string
$version[,
string|null
$date = null][,
array<string, array<int, string>>
$entries = []]) : mixed
Parameters
$version
:
string
$date
:
string|null
=
null
$entries
:
array<string, array<int, string>>
=
[]
Returns the release date when present.
public
getDate() : string|null
Return values
Returns all entries keyed by changelog category.
public
getEntries() : array<string, array<int, string>>
Return values
Returns the entries for a specific changelog category.
public
getEntriesFor(ChangelogEntryType
$type) : array<int, string>
Parameters
Return values
Returns the section version label.
public
getVersion() : string
Return values
Returns whether the section contains at least one meaningful entry.
public
hasEntries() : bool
Return values
Returns whether this section is the active Unreleased section.
public
isUnreleased() : bool
Return values
Returns a copy with the release date replaced.
public
withDate(
string|null
$date) : self
Parameters
$date
:
string|null
Return values
Returns a copy with all entries replaced by the supplied map.
public
withEntries(
array<string, array<int, string>>
$entries) : self
Parameters
$entries
:
array<string, array<int, string>>
Return values
Returns a copy with an additional entry appended to the given category.
public
withEntry(ChangelogEntryType
$type,
string
$entry) : self
Parameters
$entry
:
string