Skip to content
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.

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

Updated array shape of php-ext options #11950

Merged
merged 1 commit into from
Apr 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions res/composer-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,11 @@
"type": "object",
"description": "Settings for PHP extension packages.",
"properties": {
"extension-name": {
"type": "string",
"description": "If specified, this will be used as the name of the extension, where needed by tooling. If this is not specified, the extension name will be derived from the Composer package name (e.g. `vendor/name` would become `ext-name`). The extension name may be specified with or without the `ext-` prefix, and tools that use this must normalise this appropriately.",
"example": "ext-xdebug"
},
"priority": {
"type": "integer",
"description": "This is used to add a prefix to the INI file, e.g. `90-xdebug.ini` which affects the loading order. The priority is a number in the range 10-99 inclusive, with 10 being the highest priority (i.e. will be processed first), and 99 being the lowest priority (i.e. will be processed last). There are two digits so that the files sort correctly on any platform, whether the sorting is natural or not.",
Expand All @@ -300,6 +305,12 @@
"example": 80,
"default": 80
},
"support-zts": {
"type": "boolean",
"description": "Does this package support Zend Thread Safety",
"example": false,
"default": true
},
"configure-options": {
"type": "array",
"description": "These configure options make up the flags that can be passed to ./configure when installing the extension.",
Expand Down
2 changes: 1 addition & 1 deletion src/Composer/Package/Package.php
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@ public function getIncludePaths(): array
/**
* Sets the list of paths added to PHP's include path.
*
* @param array{priority?: int, configure-options?: list<array{name: string, description?: string}>}|null $phpExt List of directories.
* @param array{extension-name?: string, priority?: int, support-zts?: bool, configure-options?: list<array{name: string, description?: string}>}|null $phpExt List of directories.
*/
public function setPhpExt(?array $phpExt): void
{
Expand Down
2 changes: 1 addition & 1 deletion src/Composer/Package/PackageInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ public function getIncludePaths(): array;
/**
* Returns the settings for php extension packages
*
* @return array{priority?: int, configure-options?: list<array{name: string, description?: string}>}|null
* @return array{extension-name?: string, priority?: int, support-zts?: bool, configure-options?: list<array{name: string, description?: string}>}|null
*/
public function getPhpExt(): ?array;

Expand Down