Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions resources/functionMap.php
Original file line number Diff line number Diff line change
Expand Up @@ -1423,7 +1423,7 @@
'define_syslog_variables' => ['void'],
'defined' => ['bool', 'name'=>'string'],
'deflate_add' => ['string|false', 'context'=>'resource', 'data'=>'string', 'flush_mode='=>'int'],
'deflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array'],
'deflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array|object'],
'deg2rad' => ['float', 'number'=>'float'],
'dgettext' => ['string', 'domain_name'=>'string', 'msgid'=>'string'],
'dio_close' => ['void', 'fd'=>'resource'],
Expand Down Expand Up @@ -4721,7 +4721,7 @@
'inflate_add' => ['string|false', 'context'=>'resource', 'encoded_data'=>'string', 'flush_mode='=>'int'],
'inflate_get_read_len' => ['int|false', 'resource'=>'resource'],
'inflate_get_status' => ['int|false', 'resource'=>'resource'],
'inflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array'],
'inflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array|object'],
'ingres_autocommit' => ['bool', 'link'=>'resource'],
'ingres_autocommit_state' => ['bool', 'link'=>'resource'],
'ingres_charset' => ['string', 'link'=>'resource'],
Expand Down
34 changes: 34 additions & 0 deletions resources/functionMap_php86delta.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php // phpcs:ignoreFile

/**
* This contains the information needed to convert the function signatures for php 8.6 to php 8.5 (and vice versa)
*
* This has two sections.
* The 'new' section contains function/method names from FunctionSignatureMap (And alternates, if applicable) that do not exist in php8.5 or have different signatures in php 8.6.
* If they were just updated, the function/method will be present in the 'added' signatures.
* The 'old' signatures contains the signatures that are different in php 8.5.
* Functions are expected to be removed only in major releases of php.
*
* @see FunctionSignatureMap.php
*
* @phan-file-suppress PhanPluginMixedKeyNoKey (read by Phan when analyzing this file)
*/
return [
'new' => [
// https://wiki.php.net/rfc/deprecations_php_8_6#passing_objects_which_are_interpreted_as_arrays
'array_walk' => ['bool', '&rw_input'=>'array', 'callback'=>'callable', 'userdata='=>'mixed'],
'array_walk_recursive' => ['bool', '&rw_input'=>'array', 'callback'=>'callable', 'userdata='=>'mixed'],
'deflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array'],
'http_build_query' => ['string', 'querydata'=>'array', 'prefix='=>'string', 'arg_separator='=>'string', 'enc_type='=>'int'],
'inflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array'],
'mb_convert_variables' => ['string|false', 'to_encoding'=>'string', 'from_encoding'=>'array|string', '&rw_vars'=>'string|array', '&...rw_vars='=>'string|array'],
],
'old' => [
'array_walk' => ['bool', '&rw_input'=>'array|object', 'callback'=>'callable', 'userdata='=>'mixed'],
'array_walk_recursive' => ['bool', '&rw_input'=>'array|object', 'callback'=>'callable', 'userdata='=>'mixed'],
'deflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array|object'],
'http_build_query' => ['string', 'querydata'=>'array|object', 'prefix='=>'string', 'arg_separator='=>'string', 'enc_type='=>'int'],
'inflate_init' => ['resource|false', 'encoding'=>'int', 'options='=>'array|object'],
'mb_convert_variables' => ['string|false', 'to_encoding'=>'string', 'from_encoding'=>'array|string', '&rw_vars'=>'string|array|object', '&...rw_vars='=>'string|array|object'],
],
];
119 changes: 89 additions & 30 deletions src/Reflection/SignatureMap/FunctionSignatureMapProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
use function array_change_key_case;
use function array_key_exists;
use function array_keys;
use function array_slice;
use function array_values;
use function is_array;
use function sprintf;
use function strtolower;
Expand All @@ -38,6 +40,9 @@ final class FunctionSignatureMapProvider implements SignatureMapProvider
*/
private static array $arenaSignatureRows = [];

/** @var array<string, array<string, list<int>>> */
private static array $parametersChangedByDelta = [];

/** @var array<string, array{hasSideEffects: bool}>|null */
private static ?array $functionMetadata = null;

Expand Down Expand Up @@ -276,60 +281,114 @@ public function getSignatureMap(): array

$signatureMap = array_change_key_case($signatureMap, CASE_LOWER);

if ($this->stricterFunctionMap) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_bleedingEdge.php');
foreach ($this->getSignatureMapDeltaFiles() as $file) {
$signatureMap = $this->computeSignatureMap($signatureMap, $this->loadSignatureMapDelta($file));
}

if ($this->phpVersion->getVersionId() >= 70400) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php74delta.php');
self::$signatureMaps[$cacheKey] = $signatureMap;
ArenaCache::publishHash('sigmap-' . $cacheKey, $signatureMap);

return $signatureMap;
}

/**
* Positions of the parameters whose type the last delta replacing the signature changes.
*
* Such a type describes exactly what the parameter accepts, so it may leave out members
* of the native union type, like objects that PHP still accepts but deprecates.
* Other function map types leave them in, because the native type can be newer than them.
*
* @return list<int>
*/
public function getParametersChangedByDelta(string $name): array
{
$cacheKey = sprintf('%d-%d', $this->phpVersion->getVersionId(), $this->stricterFunctionMap ? 1 : 0);
if (!array_key_exists($cacheKey, self::$parametersChangedByDelta)) {
$changedParameters = [];
foreach ($this->getSignatureMapDeltaFiles() as $file) {
$delta = $this->loadSignatureMapDelta($file);
foreach (array_keys($delta['old'] + $delta['new']) as $key) {
unset($changedParameters[strtolower($key)]);
}
foreach ($delta['new'] as $key => $signature) {
if (!array_key_exists($key, $delta['old'])) {
continue;
}

$oldParameterTypes = array_values(array_slice($delta['old'][$key], 1));
$positions = [];
foreach (array_values(array_slice($signature, 1)) as $i => $parameterType) {
if (($oldParameterTypes[$i] ?? null) === $parameterType) {
continue;
}

$positions[] = $i;
}

$changedParameters[strtolower($key)] = $positions;
}
}

self::$parametersChangedByDelta[$cacheKey] = $changedParameters;
}

if ($this->phpVersion->getVersionId() >= 80000) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php80delta.php');
return self::$parametersChangedByDelta[$cacheKey][strtolower($name)] ?? [];
}

/**
* @return list<string>
*/
private function getSignatureMapDeltaFiles(): array
{
$directory = __DIR__ . '/../../../resources';
$versionId = $this->phpVersion->getVersionId();
$files = [];
if ($this->stricterFunctionMap) {
$files[] = $directory . '/functionMap_bleedingEdge.php';
}
if ($versionId >= 70400) {
$files[] = $directory . '/functionMap_php74delta.php';
}
if ($versionId >= 80000) {
$files[] = $directory . '/functionMap_php80delta.php';
if ($this->stricterFunctionMap) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php80delta_bleedingEdge.php');
$files[] = $directory . '/functionMap_php80delta_bleedingEdge.php';
}
}

if ($this->phpVersion->getVersionId() >= 80100) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php81delta.php');
if ($versionId >= 80100) {
$files[] = $directory . '/functionMap_php81delta.php';
}

if ($this->phpVersion->getVersionId() >= 80200) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php82delta.php');
if ($versionId >= 80200) {
$files[] = $directory . '/functionMap_php82delta.php';
}

if ($this->phpVersion->getVersionId() >= 80300) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php83delta.php');
if ($versionId >= 80300) {
$files[] = $directory . '/functionMap_php83delta.php';
}

if ($this->phpVersion->getVersionId() >= 80400) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php84delta.php');
if ($versionId >= 80400) {
$files[] = $directory . '/functionMap_php84delta.php';
}

if ($this->phpVersion->getVersionId() >= 80500) {
$signatureMap = $this->computeSignatureMapFile($signatureMap, __DIR__ . '/../../../resources/functionMap_php85delta.php');
if ($versionId >= 80500) {
$files[] = $directory . '/functionMap_php85delta.php';
}
if ($versionId >= 80600) {
$files[] = $directory . '/functionMap_php86delta.php';
}

self::$signatureMaps[$cacheKey] = $signatureMap;
ArenaCache::publishHash('sigmap-' . $cacheKey, $signatureMap);

return $signatureMap;
return $files;
}

/**
* @param array<string, mixed> $signatureMap
* @return array<string, mixed>
* @return array{new: array<string, mixed[]>, old: array<string, mixed[]>}
*/
private function computeSignatureMapFile(array $signatureMap, string $file): array
private function loadSignatureMapDelta(string $file): array
{
$signatureMapDelta = include $file;
if (!is_array($signatureMapDelta)) {
throw new ShouldNotHappenException(sprintf('Signature map file "%s" could not be loaded.', $file));
}

return $this->computeSignatureMap($signatureMap, $signatureMapDelta);
/** @var array{new: array<string, mixed[]>, old: array<string, mixed[]>} $signatureMapDelta */
return $signatureMapDelta;
}

/**
Expand Down
31 changes: 21 additions & 10 deletions src/Reflection/SignatureMap/Php8SignatureMapProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
use function array_map;
use function count;
use function explode;
use function in_array;
use function is_string;
use function sprintf;
use function strtolower;
Expand Down Expand Up @@ -274,7 +275,7 @@ private function getMethodSignaturesWithoutTentativeReturnType(string $className
if ($this->functionSignatureMapProvider->hasMethodSignature($className, $methodName)) {
$functionMapSignatures = $this->functionSignatureMapProvider->getMethodSignatures($className, $methodName, $reflectionMethod);

return $this->getMergedSignatures($signature, $functionMapSignatures);
return $this->getMergedSignatures($signature, $functionMapSignatures, $this->functionSignatureMapProvider->getParametersChangedByDelta(sprintf('%s::%s', $className, $methodName)));
}

return ['positional' => [$signature], 'named' => null];
Expand All @@ -293,7 +294,7 @@ public function getFunctionSignatures(string $functionName, ?string $className,
if ($this->functionSignatureMapProvider->hasFunctionSignature($functionName)) {
$functionMapSignatures = $this->functionSignatureMapProvider->getFunctionSignatures($functionName, $className, $reflectionFunction);

return $this->getMergedSignatures($signature, $functionMapSignatures);
return $this->getMergedSignatures($signature, $functionMapSignatures, $this->functionSignatureMapProvider->getParametersChangedByDelta($functionName));
}

return ['positional' => [$signature], 'named' => null];
Expand Down Expand Up @@ -366,12 +367,13 @@ private function hasDeprecatedAttribute(array $attrGroups): bool

/**
* @param array{positional: array<int, FunctionSignature>, named: ?array<int, FunctionSignature>} $functionMapSignatures
* @param list<int> $parametersChangedByDelta
* @return array{positional: array<int, FunctionSignature>, named: ?array<int, FunctionSignature>}
*/
private function getMergedSignatures(FunctionSignature $nativeSignature, array $functionMapSignatures): array
private function getMergedSignatures(FunctionSignature $nativeSignature, array $functionMapSignatures, array $parametersChangedByDelta): array
{
if (count($functionMapSignatures['positional']) === 1) {
return ['positional' => [$this->mergeSignatures($nativeSignature, $functionMapSignatures['positional'][0])], 'named' => null];
return ['positional' => [$this->mergeSignatures($nativeSignature, $functionMapSignatures['positional'][0], $parametersChangedByDelta)], 'named' => null];
}

if (count($functionMapSignatures['positional']) === 0) {
Expand Down Expand Up @@ -425,7 +427,10 @@ private function withUnknownDefaultValues(FunctionSignature $nativeSignature, Fu
);
}

private function mergeSignatures(FunctionSignature $nativeSignature, FunctionSignature $functionMapSignature): FunctionSignature
/**
* @param list<int> $parametersChangedByDelta
*/
private function mergeSignatures(FunctionSignature $nativeSignature, FunctionSignature $functionMapSignature, array $parametersChangedByDelta): FunctionSignature
{
$parameters = [];
foreach ($nativeSignature->getParameters() as $i => $nativeParameter) {
Expand All @@ -436,16 +441,22 @@ private function mergeSignatures(FunctionSignature $nativeSignature, FunctionSig

$functionMapParameter = $functionMapSignature->getParameters()[$i];
$nativeParameterType = $nativeParameter->getNativeType();
$parameters[] = new ParameterSignature(
$nativeParameter->getName(),
$nativeParameter->isOptional(),
TypehintHelper::decideType(
if (in_array($i, $parametersChangedByDelta, true)) {
// unlike decideType(), keeps out members of the native union type the delta leaves out
$parameterType = TypeCombinator::intersect($nativeParameterType, $functionMapParameter->getType());
} else {
$parameterType = TypehintHelper::decideType(
$nativeParameterType,
TypehintHelper::decideType(
$nativeParameter->getType(),
$functionMapParameter->getType(),
),
),
);
}
$parameters[] = new ParameterSignature(
$nativeParameter->getName(),
$nativeParameter->isOptional(),
$parameterType,
$nativeParameterType,
$nativeParameter->passedByReference()->yes() ? $functionMapParameter->passedByReference() : $nativeParameter->passedByReference(),
$nativeParameter->isVariadic(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ function functions(): void
assertType('Closure', mt_rand(?, ...));
assertType('Closure', array_walk(?, ?, ...));
assertType('static-Closure(array, mixed, bool=): list<int|string>', array_keys(?, ?, ...));
assertType('static-Closure(array|object, callable): true', array_walk(?, ?));
assertType('static-Closure(array, callable): true', array_walk(?, ?));

// templates
assertType('static-Closure<T of mixed>(T): T', identity(?));
Expand Down
Loading
Loading