Skip to content

Standardize PHPdoc to use bool instead of boolean.#4931

Merged
demiankatz merged 6 commits intovufind-org:devfrom
demiankatz:standardize-boolean-annotations
Dec 4, 2025
Merged

Standardize PHPdoc to use bool instead of boolean.#4931
demiankatz merged 6 commits intovufind-org:devfrom
demiankatz:standardize-boolean-annotations

Conversation

@demiankatz
Copy link
Member

This also adds a test to prevent regressions.

Copy link
Contributor

@ThoWagen ThoWagen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some cases, the test does not catch.

  1. Class attributes: E.g. protected $userHeaders in VuFind/Auth/Shibboleth.php
  2. In merged types: E.g. public function getUser() in VuFind/DigitalContent/FakeOverdriveConnector.php

See below, for a potential fix.

…StringsTest.php

Co-authored-by: Thomas Wagener <wagener@hebis.uni-frankfurt.de>
@demiankatz
Copy link
Member Author

Thanks for the suggestion, @ThoWagen -- good idea! I've just merged it, and we'll see if it triggers any errors that need fixing.

@demiankatz demiankatz requested a review from ThoWagen December 4, 2025 13:37
@demiankatz
Copy link
Member Author

Great improvements, @ThoWagen; I believe everything is fixed up now!

Copy link
Contributor

@ThoWagen ThoWagen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now. Thanks!

@demiankatz demiankatz merged commit 04addfd into vufind-org:dev Dec 4, 2025
6 checks passed
@demiankatz demiankatz deleted the standardize-boolean-annotations branch December 4, 2025 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants