Skip to content

Generate legacy arginfo for older PHP versions #1981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alcaeus wants to merge 4 commits into
base: v2.x
Choose a base branch
from
Open

Generate legacy arginfo for older PHP versions #1981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93f3f36
Add legacy arginfo directive for stub generator
alcaeus Apr 13, 2026
eb3e00d
Update arginfo guidance in contributing docs
alcaeus Apr 13, 2026
a74cc02
Use latest PHP version to generate arginfo
alcaeus Apr 13, 2026
e191798
Update CONTRIBUTING.md
alcaeus Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/arginfo-files.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:
- "feature/*"

env:
PHP_VERSION: "8.2"
PHP_VERSION: "8.5"

jobs:
check-arginfo:
Expand Down
11 changes: 8 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,14 @@ $ php --ri mongodb
## Generating arginfo from stub files

Arginfo structures are generated from stub files using the `gen_stub.php`
file. Note that this requires `phpize` to be run for **PHP 8.2** to make use
of all features. After changing a stub file, run `./build/gen_stub.php`
to regenerate the corresponding arginfo files and commit the results.
file. After changing a stub file, run `./build/gen_stub.php` to regenerate the
corresponding arginfo files and commit the results.

The `gen_stub.php` file is added to the `build` directory when calling `phpize`.
Arginfo structures are generated with the latest version of PHP. The
`@generate-legacy-arginfo` directive ensures that the generated files are
compatible with the indicated version of PHP. When bumping the minimum PHP
requirement, this directive needs to be updated accordingly.

## Generating function maps for static analysis tools

Expand Down
2 changes: 1 addition & 1 deletion src/BSON/Binary.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
4 changes: 2 additions & 2 deletions src/BSON/BinaryInterface.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

/**
* @generate-class-entries static
* @generate-function-entries
* @generate-class-entries
Copy link
Copy Markdown
Member Author

@alcaeus alcaeus Apr 13, 2026

Choose a reason for hiding this comment

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

When using gen_stub.php from PHP 8.5, I noticed that using static with generate-class-entries for interfaces causes invalid files. Haven't yet had time to investigate, but since we're not generating an PHP_METHOD entries we can omit the static keyword for interfaces.

* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
22 changes: 16 additions & 6 deletions src/BSON/BinaryInterface_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions src/BSON/Binary_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/BSON/DBPointer.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
8 changes: 5 additions & 3 deletions src/BSON/DBPointer_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/BSON/Decimal128.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
4 changes: 2 additions & 2 deletions src/BSON/Decimal128Interface.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

/**
* @generate-class-entries static
* @generate-function-entries
* @generate-class-entries
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
10 changes: 6 additions & 4 deletions src/BSON/Decimal128Interface_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions src/BSON/Decimal128_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/BSON/Document.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
8 changes: 5 additions & 3 deletions src/BSON/Document_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/BSON/Int64.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
8 changes: 5 additions & 3 deletions src/BSON/Int64_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/BSON/Iterator.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
8 changes: 5 additions & 3 deletions src/BSON/Iterator_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/BSON/Javascript.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* @generate-class-entries static
* @generate-function-entries static
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
4 changes: 2 additions & 2 deletions src/BSON/JavascriptInterface.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

/**
* @generate-class-entries static
* @generate-function-entries
* @generate-class-entries
* @generate-legacy-arginfo 80100
*/

namespace MongoDB\BSON;
Expand Down
Loading
Loading