What's Changed

This release resolves a number of bugs introduced by the new expression rendering. See #4012 for details.

• Add test to show correct default value by @jaapio in #4019

• Upgrade reflection to resolve class correctly by @jaapio in #4020

• Chore(deps): bump actions/checkout from 5 to 6 by @dependabot[bot] in #4014

• Chore(deps): bump phpdocumentor/type-resolver from 1.10.0 to 1.11.1 by @dependabot[bot] in #4013

• Chore(deps): bump phpdocumentor/reflection from 6.4.1 to 6.4.2 by @dependabot[bot] in #4015

• Chore(deps): bump league/uri-interfaces from 7.5.0 to 7.6.0 by @dependabot[bot] in #4018

• Chore(deps-dev): bump cypress from 15.6.0 to 15.7.0 by @dependabot[bot] in #4016

Full Changelog: v3.9.0...v3.9.1

What's Changed

Default docker image improvements

phpDocumentor is now running by default on PHP 8.4 via the official Docker image. As usual older code is still
processed correctly. No matter which PHP version you project is written for.

• Docker Optimizations by @NabeelKhanYYC in #3945
• Restrict dependency of php:8.1 to 8.1-bookworm. This is due to missin? by @jaymeh in #3961
• PHP version in docker to 8.4 by @jaapio in #4011

PHP 8.5

Our CI ppipelines are now also testing against PHP 8.5. Which allows you to run phpDocumentor on PHP 8.5 as well.
PHP 8.5 does not have any additional changes that affect phpDocumentor at this time.

• Test against php 8.5 by @sergiy-petrov in #3978

Expression Support

phpDocumentor now supports default expressions in parameters, properties and constants. The used types in these
expressions are also parsed and used in the type resolution. So types within expressions are now linked correctly.

In this examle the Sauce type is linked correctly in the constructor parameter.

function __construct(Sauce $sauce = new Sauce('tomato')) {
    // ...
}

Extension Finder

The extension finder allows users to install extensions using composer. As an alternative to regular packages we do support phar extensions, which can be scoped to avoid conflicts with the main phpdocumentor application.
The finder script is trying to avoid collisions between phpdocumentor and the classes within the project being processed. This might be the case when packages used by phpDocumentor are also used in the project.

• Add extension finder by @jaapio in #3900

Other Changes

• GH Actions: remove GH Token set via env by @jrfnl in #3954
• Fix typo to make it uniform to the rest of the docs by @michaelKaefer in #3982
• Fix the reference doc about visibilities by @stof in #3996
• Silence deprecation notices produced on PHP 8.4+ by @pavetheway91 in #4005
• Add support for default expressions by @jaapio in #4009
• Fix issue on rendering of attributes in file template by @jaapio in #4008
• Fix use-cache config option by @jaapio in #4010

New Contributors

• @jaymeh made their first contribution in #3961
• @michaelKaefer made their first contribution in #3982
• @sergiy-petrov made their first contribution in #3978
• @stof made their first contribution in #3996
• @pavetheway91 made their first contribution in #4005

Full Changelog: v3.8.1...v3.9.0

Bugfix release

Thanks a lot for all contributions.

• Update phpDocumentor Reflection Php resource path by @Saggre in #3939
• Bugfix #3943 - Clean template fails to show @uses if no description is provided in DocBlock by @NabeelKhanYYC in #3944
• Bugfix #3270 by @NabeelKhanYYC in #3948
• Bugfix #3228 - Added XML template support for Enums by @NabeelKhanYYC in #3947

New Contributors

• @Saggre made their first contribution in #3939
• @NabeelKhanYYC made their first contribution in #3944

Full Changelog: v3.8.0...v3.8.1

What's Changed

This release comes with support for asymmetric visibility on properties and support for property hooks. Property hooks were introduced in php 8.4. The system generating your documentation doesn't have to be running php 8.4 to be able to display property hooks.

by @jaapio in #3926

Traits using traits

Since the introduction of traits, you can use traits in traits. However this was never reflected properly in phpDocumentor. By now methods imported by a trait in a trait are shown in the documentatation of your trait.

by @jaapio in #3931

Filter private elements

Inheritance did not work as it should be, by now private elements are not longer inherited by child classes and traits.

by @jaapio in #3932

Fixes bugs

• Magic element filter by @jaapio in #3934
• When path is empty fall back to root by @jaapio in #3875

Documentation

• update the trusted GPG key when using phive by @michalsn in #3876

Other changes

• allow PHP 8.4 by @odinuv in #3912

New Contributors

• @michalsn made their first contribution in #3876
• @odinuv made their first contribution in #3912

Full Changelog: v3.7.1...v3.8.0

What's Changed

• Fix regression in log output by @jaapio in #3874

Full Changelog: v3.7.0...v3.7.1

3.7.0

This release is mostly a maintenance release. With some small improvements on the output of phpDoc on the cli. And internal upgrades of a number of dependencies. Most note worthy changes are listed in these release notes.

Clean template refactoring

Thanks to @omegamvc the clean template has been updated to work better on mobile devices and new features added to the default template for api docs have been added. This is a huge step forward in the clean template. The work has not been finished yet. So more will follow in the future.

• Complete refactoring clean template - First Steep by @omegamvc in #3846
• Fix CSS to improve display on mobile devices by @omegamvc in #3847

PHP 8.3 and PHP 8.4 support

phpDocumentor is now executable on php 8.3 and 8.4 This does not mean we have support for all language additions yet. As we told in the previous release notes the impact of php 8.4 is very big. A lot of changes have to be done to be able to support php 8.4 language features.

• Add php 8.2+ builds by @jaapio in #3843

Improved config options for plantuml

Since a few releases phpDocumentor is using plantuml to generate diagrams. However some users did experience issues when using the phar install of phpDocumentor. While to docker based installations did work as expected. To make it possible again to generate diagrams using the phar based installations we did add some new options. These new options will allow you to install plantuml on your system and point phpdocumentor to the correct location. The options are added to the docs: https://docs.phpdoc.org/guide/guides/generate-diagrams.html#generate-diagrams

• Add better options to configure plantuml by @jaapio in #3854

[BETA] Custom twig extensions

We did introduce an extension system to phpDocumentor a few releases ago. However there was no real working use-case for extensions yet. In this release we did add an example on how to extend phpDocumentor with a custom twig extension. More extension points will be added in the future. If you want to create your own twig extension read the guide on how to do that: https://docs.phpdoc.org/guide/features/extensions/twig-extension.html#twig-extension

• Add support for custom twig extensions by @jaapio in #3868

Other changes

• Improve output formating by @jaapio in #3870
• Bump guides to v1.7 by @jaapio in #3871
• Docs: fix link in generating-documentation.rst by @ThatsJustCheesy in #3851

New Contributors

• @omegamvc made their first contribution in #3846
• @ThatsJustCheesy made their first contribution in #3851

Full Changelog: v3.6.0...v3.7.0

What's Changed

In this release a number of bugfixes have been added and two major new features. We are still working on php 8.3 and 8.4 support to ensure our users are able to upgrade. But due to the large changes that are required with the new property hooks in php 8.4 and async property accessors a lot of work has to be done. Neverless we are very happy to provide you this new release which will definitely help you to document your projects even better.

Markdown support

Most important change in this release is the introduction of markdown support in guides. Before phpDocumentor did only have support for ReStructedText in the manuals. By now we also support markdown. The syntax of markdown is not as extendable as the RST syntax is. Therefor the more advanced features like class listing and automated diagrams are not supported yet. But for most common usecases markdown will work.

Improved class diagrams

In this release we added an improved version of the class diagram generation. We extended the way we generate diagrams, so external classes are now better visible. And also the style of traits in the class diagram has been improved. We are planning to add more options and allow users to get more control over the generated diagram, by filtering out certain elements.

Other changes:

• GH Actions: fix up action runner version by @jrfnl in #3764
• feat: open rendered SVGs in separate tab/window onclick by @dgoosens in #3793
• trait.html.twig: Fix deprecated constant(s) by @adriendupuis in #3840
• Implement new improved class diagram generator by @jaapio in #3839
• Filter empty namespaces from all indexes by @jaapio in #3841
• Add option disable packages from menu by @jaapio in #3842

New Contributors

• @matsuo made their first contribution in #3766
• @dgoosens made their first contribution in #3793
• @agung2001 made their first contribution in #3796

Full Changelog: v3.5.3...v3.6.0

v3.5.3

• [BUG] Resolve issue with invalid image paths in guides
• [BUG] Fix inclosed tag in sidebar template
• [BUG] Resolve visual issue in guides with large code blocks.
• [FEATURE] filter empty namespace by @jaapio in #3740

Full Changelog: v3.5.2...v3.5.3

Fix regression introduced in v3.5.1 regarding command parsing.

#v3.5.1

This bugfix release includes 2 small bugfixes regarding the cli options you can pass to phpdoc. before we supported phpdoc run -d ./src and phpdoc -d ./src both would do exactly the same. During a change in the previous version the first way of doing things was broken. Now this has been restored. Including the option to list possible settings with --list-settings

Also included is a new way of rendering the new php 8.4 #[Deprecated] attribute as well the improved rendering of deprecated methods and classes.

Full change list:

• Fix typo in configuration.rst by @adriendupuis in #3724
• Add support for #[Deprecated] by @jaapio in #3731
• Fix settings:list and --list-settings not working by @Mai-Lapyst in #3732
• Reintroduce multicommand interface by @jaapio in #3736

New Contributors

• @adriendupuis made their first contribution in #3724
• @Mai-Lapyst made their first contribution in #3732

Full Changelog: v3.5.0...v3.5.1