Skip to content

v2.2.0

Choose a tag to compare

@ElGigi ElGigi released this 13 May 11:56
· 10 commits to main since this release

Added

  • DoctrineRst parser based on doctrine/rst-parser as replacement for the deprecated reStructuredText parser
  • Optional $errorHandler callback to DocCacheGenerator for cache read failures instead of silently swallowing exceptions

Changed

  • Improve docblocks: add @var Entry[] on EntryIterable::$entries, document FileSet::normalizePath() behavior
  • Rename PageSummaryTreatment::getHeaderLevel() to getSummaryDepth() with clarified docblock

Deprecated

  • reStructuredText parser and associated RST\IndexDirective, RST\IndexNode classes; relies on the unmaintained gregwar/rst package — use DoctrineRst parser instead

Removed

  • Dead code in Entry::isVisible() (null check on a bool property)
  • Redundant in_array host check in ExternalLinkTreatment::isExternalLink()
  • Unused $ids variable in PageSummaryTreatment::makePageSummary()

Fixed

  • Fix DocGenerator::parserAcceptFile() calling acceptExtension() instead of acceptMime() for MIME type fallback
  • Fix DocIntegrity::check() silently dropping errors from subsequent pages due to += on numeric arrays
  • Fix DocGenerator::getConfig() mutating internal config array when returning default values (??= replaced by ??)
  • Fix ExternalLinkTreatment::doExternalLinksTreatment() calling setContents() inside the loop instead of once after
  • Fix PageSummaryTreatment::makePageSummary() not deduplicating pre-existing duplicate header ids
  • Fix DocSummary::addPage() crashing with TypeError when summary-order meta contains non-scalar values
  • Fix Page::getPath() not encoding directory segments (only slug was encoded)
  • Fix RawFile::setContents() not rewinding stream after ftruncate, causing NUL-byte corruption
  • Fix DocGenerator not sorting parsers and treatments by priority before execution

Security

  • Bump minimum phpunit version to ^9.6.34