Merge pull request #10684 from weirdan/update-master

vimeo · Feb 9, 2024 · c03a8a0 · c03a8a0
2 parents 4b2c698 + 83f04c5
commit c03a8a0
Show file tree

Hide file tree

Showing 62 changed files with 1,053 additions and 314 deletions.
diff --git a/config.xsd b/config.xsd
@@ -42,6 +42,7 @@
         <xs:attribute name="checkForThrowsInGlobalScope" type="xs:boolean" default="false" />
         <xs:attribute name="ensureArrayIntOffsetsExist" type="xs:boolean" default="false" />
         <xs:attribute name="ensureArrayStringOffsetsExist" type="xs:boolean" default="false" />
+        <xs:attribute name="ensureOverrideAttribute" type="xs:boolean" default="false" />
         <xs:attribute name="findUnusedCode" type="xs:boolean" default="false" />
         <xs:attribute name="findUnusedVariablesAndParams" type="xs:boolean" default="false" />
         <xs:attribute name="findUnusedPsalmSuppress" type="xs:boolean" default="false" />
@@ -321,6 +322,7 @@
             <xs:element name="MissingDocblockType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MissingFile" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MissingImmutableAnnotation" type="IssueHandlerType" minOccurs="0" />
+            <xs:element name="MissingOverrideAttribute" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MissingParamType" type="IssueHandlerType" minOccurs="0" />
             <xs:element name="MissingPropertyType" type="PropertyIssueHandlerType" minOccurs="0" />
             <xs:element name="MissingReturnType" type="IssueHandlerType" minOccurs="0" />

diff --git a/dictionaries/CallMap.php b/dictionaries/CallMap.php
@@ -1590,7 +1590,7 @@
 'DirectoryIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'?class-string'],
 'DirectoryIterator::getPathname' => ['string'],
 'DirectoryIterator::getPerms' => ['int'],
-'DirectoryIterator::getRealPath' => ['string'],
+'DirectoryIterator::getRealPath' => ['non-falsy-string'],
 'DirectoryIterator::getSize' => ['int'],
 'DirectoryIterator::getType' => ['string'],
 'DirectoryIterator::isDir' => ['bool'],
@@ -2792,7 +2792,7 @@
 'file' => ['list<string>|false', 'filename'=>'string', 'flags='=>'int', 'context='=>'resource'],
 'file_exists' => ['bool', 'filename'=>'string'],
 'file_get_contents' => ['string|false', 'filename'=>'string', 'use_include_path='=>'bool', 'context='=>'?resource', 'offset='=>'int', 'length='=>'?int'],
-'file_put_contents' => ['int|false', 'filename'=>'string', 'data'=>'string|resource|array<string>', 'flags='=>'int', 'context='=>'resource'],
+'file_put_contents' => ['int<0, max>|false', 'filename'=>'string', 'data'=>'string|resource|array<string>', 'flags='=>'int', 'context='=>'resource'],
 'fileatime' => ['int|false', 'filename'=>'string'],
 'filectime' => ['int|false', 'filename'=>'string'],
 'filegroup' => ['int|false', 'filename'=>'string'],
@@ -2827,7 +2827,7 @@
 'FilesystemIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'?class-string'],
 'FilesystemIterator::getPathname' => ['string'],
 'FilesystemIterator::getPerms' => ['int'],
-'FilesystemIterator::getRealPath' => ['string'],
+'FilesystemIterator::getRealPath' => ['non-falsy-string'],
 'FilesystemIterator::getSize' => ['int'],
 'FilesystemIterator::getType' => ['string'],
 'FilesystemIterator::isDir' => ['bool'],
@@ -3296,7 +3296,7 @@
 'get_resource_type' => ['string', 'resource'=>'resource'],
 'get_resources' => ['array<int,resource>', 'type='=>'?string'],
 'getallheaders' => ['array|false'],
-'getcwd' => ['string|false'],
+'getcwd' => ['non-falsy-string|false'],
 'getdate' => ['array{seconds: int<0, 59>, minutes: int<0, 59>, hours: int<0, 23>, mday: int<1, 31>, wday: int<0, 6>, mon: int<1, 12>, year: int, yday: int<0, 365>, weekday: "Monday"|"Tuesday"|"Wednesday"|"Thursday"|"Friday"|"Saturday"|"Sunday", month: "January"|"February"|"March"|"April"|"May"|"June"|"July"|"August"|"September"|"October"|"November"|"December", 0: int}', 'timestamp='=>'?int'],
 'getenv' => ['string|false', 'name'=>'string', 'local_only='=>'bool'],
 'getenv\'1' => ['array<string,string>'],
@@ -3343,7 +3343,7 @@
 'GlobIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'?class-string'],
 'GlobIterator::getPathname' => ['string'],
 'GlobIterator::getPerms' => ['int'],
-'GlobIterator::getRealPath' => ['string|false'],
+'GlobIterator::getRealPath' => ['non-falsy-string|false'],
 'GlobIterator::getSize' => ['int'],
 'GlobIterator::getType' => ['string|false'],
 'GlobIterator::isDir' => ['bool'],
@@ -8529,7 +8529,7 @@
 'openssl_x509_parse' => ['array|false', 'certificate'=>'OpenSSLCertificate|string', 'short_names='=>'bool'],
 'openssl_x509_read' => ['OpenSSLCertificate|false', 'certificate'=>'OpenSSLCertificate|string'],
 'openssl_x509_verify' => ['int', 'certificate'=>'string|OpenSSLCertificate', 'public_key'=>'string|OpenSSLCertificate|OpenSSLAsymmetricKey|array'],
-'ord' => ['int', 'character'=>'string'],
+'ord' => ['int<0,255>', 'character'=>'string'],
 'OuterIterator::current' => ['mixed'],
 'OuterIterator::getInnerIterator' => ['Iterator'],
 'OuterIterator::key' => ['int|string'],
@@ -9722,8 +9722,8 @@
 'readline_read_history' => ['bool', 'filename='=>'?string'],
 'readline_redisplay' => ['void'],
 'readline_write_history' => ['bool', 'filename='=>'?string'],
-'readlink' => ['string|false', 'path'=>'string'],
-'realpath' => ['string|false', 'path'=>'string'],
+'readlink' => ['non-falsy-string|false', 'path'=>'string'],
+'realpath' => ['non-falsy-string|false', 'path'=>'string'],
 'realpath_cache_get' => ['array'],
 'realpath_cache_size' => ['int'],
 'recode' => ['string', 'request'=>'string', 'string'=>'string'],
@@ -9811,7 +9811,7 @@
 'RecursiveDirectoryIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'?class-string'],
 'RecursiveDirectoryIterator::getPathname' => ['string'],
 'RecursiveDirectoryIterator::getPerms' => ['int'],
-'RecursiveDirectoryIterator::getRealPath' => ['string'],
+'RecursiveDirectoryIterator::getRealPath' => ['non-falsy-string'],
 'RecursiveDirectoryIterator::getSize' => ['int'],
 'RecursiveDirectoryIterator::getSubPath' => ['string'],
 'RecursiveDirectoryIterator::getSubPathname' => ['string'],
@@ -10631,7 +10631,7 @@
 'ReflectionParameter::getDefaultValue' => ['mixed'],
 'ReflectionParameter::getDefaultValueConstantName' => ['?string'],
 'ReflectionParameter::getName' => ['string'],
-'ReflectionParameter::getPosition' => ['int'],
+'ReflectionParameter::getPosition' => ['int<0, max>'],
 'ReflectionParameter::getType' => ['?ReflectionType'],
 'ReflectionParameter::hasType' => ['bool'],
 'ReflectionParameter::isArray' => ['bool'],
@@ -12238,7 +12238,7 @@
 'SplFileInfo::getPathInfo' => ['SplFileInfo|null', 'class='=>'?class-string'],
 'SplFileInfo::getPathname' => ['string'],
 'SplFileInfo::getPerms' => ['int|false'],
-'SplFileInfo::getRealPath' => ['string|false'],
+'SplFileInfo::getRealPath' => ['non-falsy-string|false'],
 'SplFileInfo::getSize' => ['int|false'],
 'SplFileInfo::getType' => ['string|false'],
 'SplFileInfo::isDir' => ['bool'],
@@ -12288,7 +12288,7 @@
 'SplFileObject::getPathInfo' => ['SplFileInfo|null', 'class='=>'?class-string'],
 'SplFileObject::getPathname' => ['string'],
 'SplFileObject::getPerms' => ['int|false'],
-'SplFileObject::getRealPath' => ['false|string'],
+'SplFileObject::getRealPath' => ['false|non-falsy-string'],
 'SplFileObject::getSize' => ['int|false'],
 'SplFileObject::getType' => ['string|false'],
 'SplFileObject::hasChildren' => ['false'],
@@ -12475,7 +12475,7 @@
 'SplTempFileObject::getPathInfo' => ['SplFileInfo|null', 'class='=>'?class-string'],
 'SplTempFileObject::getPathname' => ['string'],
 'SplTempFileObject::getPerms' => ['int|false'],
-'SplTempFileObject::getRealPath' => ['false|string'],
+'SplTempFileObject::getRealPath' => ['false|non-falsy-string'],
 'SplTempFileObject::getSize' => ['int|false'],
 'SplTempFileObject::getType' => ['string|false'],
 'SplTempFileObject::hasChildren' => ['false'],
@@ -12690,8 +12690,8 @@
 'ssh2_sftp_chmod' => ['bool', 'sftp'=>'resource', 'filename'=>'string', 'mode'=>'int'],
 'ssh2_sftp_lstat' => ['array{0: int, 1: int, 2: int, 3: int, 4: int, 5: int, 6: int, 7: int, 8: int, 9: int, 10: int, 11: int, 12: int, dev: int, ino: int, mode: int, nlink: int, uid: int, gid: int, rdev: int, size: int, atime: int, mtime: int, ctime: int, blksize: int, blocks: int}|false', 'sftp'=>'resource', 'path'=>'string'],
 'ssh2_sftp_mkdir' => ['bool', 'sftp'=>'resource', 'dirname'=>'string', 'mode='=>'int', 'recursive='=>'bool'],
-'ssh2_sftp_readlink' => ['string|false', 'sftp'=>'resource', 'link'=>'string'],
-'ssh2_sftp_realpath' => ['string|false', 'sftp'=>'resource', 'filename'=>'string'],
+'ssh2_sftp_readlink' => ['non-falsy-string|false', 'sftp'=>'resource', 'link'=>'string'],
+'ssh2_sftp_realpath' => ['non-falsy-string|false', 'sftp'=>'resource', 'filename'=>'string'],
 'ssh2_sftp_rename' => ['bool', 'sftp'=>'resource', 'from'=>'string', 'to'=>'string'],
 'ssh2_sftp_rmdir' => ['bool', 'sftp'=>'resource', 'dirname'=>'string'],
 'ssh2_sftp_stat' => ['array{0: int, 1: int, 2: int, 3: int, 4: int, 5: int, 6: int, 7: int, 8: int, 9: int, 10: int, 11: int, 12: int, dev: int, ino: int, mode: int, nlink: int, uid: int, gid: int, rdev: int, size: int, atime: int, mtime: int, ctime: int, blksize: int, blocks: int}|false', 'sftp'=>'resource', 'path'=>'string'],

diff --git a/dictionaries/CallMap_historical.php b/dictionaries/CallMap_historical.php
@@ -877,7 +877,7 @@
     'DirectoryIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'class-string'],
     'DirectoryIterator::getPathname' => ['string'],
     'DirectoryIterator::getPerms' => ['int'],
-    'DirectoryIterator::getRealPath' => ['string'],
+    'DirectoryIterator::getRealPath' => ['non-falsy-string'],
     'DirectoryIterator::getSize' => ['int'],
     'DirectoryIterator::getType' => ['string'],
     'DirectoryIterator::isDir' => ['bool'],
@@ -1507,7 +1507,7 @@
     'FilesystemIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'class-string'],
     'FilesystemIterator::getPathname' => ['string'],
     'FilesystemIterator::getPerms' => ['int'],
-    'FilesystemIterator::getRealPath' => ['string'],
+    'FilesystemIterator::getRealPath' => ['non-falsy-string'],
     'FilesystemIterator::getSize' => ['int'],
     'FilesystemIterator::getType' => ['string'],
     'FilesystemIterator::isDir' => ['bool'],
@@ -1762,7 +1762,7 @@
     'GlobIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'class-string'],
     'GlobIterator::getPathname' => ['string'],
     'GlobIterator::getPerms' => ['int'],
-    'GlobIterator::getRealPath' => ['string|false'],
+    'GlobIterator::getRealPath' => ['non-falsy-string|false'],
     'GlobIterator::getSize' => ['int'],
     'GlobIterator::getType' => ['string|false'],
     'GlobIterator::isDir' => ['bool'],
@@ -5155,7 +5155,7 @@
     'RecursiveDirectoryIterator::getPathInfo' => ['?SplFileInfo', 'class='=>'class-string'],
     'RecursiveDirectoryIterator::getPathname' => ['string'],
     'RecursiveDirectoryIterator::getPerms' => ['int'],
-    'RecursiveDirectoryIterator::getRealPath' => ['string'],
+    'RecursiveDirectoryIterator::getRealPath' => ['non-falsy-string'],
     'RecursiveDirectoryIterator::getSize' => ['int'],
     'RecursiveDirectoryIterator::getSubPath' => ['string'],
     'RecursiveDirectoryIterator::getSubPathname' => ['string'],
@@ -5969,7 +5969,7 @@
     'ReflectionParameter::getDefaultValue' => ['mixed'],
     'ReflectionParameter::getDefaultValueConstantName' => ['?string'],
     'ReflectionParameter::getName' => ['string'],
-    'ReflectionParameter::getPosition' => ['int'],
+    'ReflectionParameter::getPosition' => ['int<0, max>'],
     'ReflectionParameter::getType' => ['?ReflectionType'],
     'ReflectionParameter::hasType' => ['bool'],
     'ReflectionParameter::isArray' => ['bool'],
@@ -7481,7 +7481,7 @@
     'SplFileInfo::getPathInfo' => ['SplFileInfo|null', 'class='=>'class-string'],
     'SplFileInfo::getPathname' => ['string'],
     'SplFileInfo::getPerms' => ['int|false'],
-    'SplFileInfo::getRealPath' => ['string|false'],
+    'SplFileInfo::getRealPath' => ['non-falsy-string|false'],
     'SplFileInfo::getSize' => ['int|false'],
     'SplFileInfo::getType' => ['string|false'],
     'SplFileInfo::isDir' => ['bool'],
@@ -7532,7 +7532,7 @@
     'SplFileObject::getPathInfo' => ['SplFileInfo|null', 'class='=>'class-string'],
     'SplFileObject::getPathname' => ['string'],
     'SplFileObject::getPerms' => ['int|false'],
-    'SplFileObject::getRealPath' => ['false|string'],
+    'SplFileObject::getRealPath' => ['false|non-falsy-string'],
     'SplFileObject::getSize' => ['int|false'],
     'SplFileObject::getType' => ['string|false'],
     'SplFileObject::hasChildren' => ['false'],
@@ -7723,7 +7723,7 @@
     'SplTempFileObject::getPathInfo' => ['SplFileInfo|null', 'class='=>'class-string'],
     'SplTempFileObject::getPathname' => ['string'],
     'SplTempFileObject::getPerms' => ['int|false'],
-    'SplTempFileObject::getRealPath' => ['false|string'],
+    'SplTempFileObject::getRealPath' => ['false|non-falsy-string'],
     'SplTempFileObject::getSize' => ['int|false'],
     'SplTempFileObject::getType' => ['string|false'],
     'SplTempFileObject::hasChildren' => ['false'],
@@ -10417,7 +10417,7 @@
     'file' => ['list<string>|false', 'filename'=>'string', 'flags='=>'int', 'context='=>'resource'],
     'file_exists' => ['bool', 'filename'=>'string'],
     'file_get_contents' => ['string|false', 'filename'=>'string', 'use_include_path='=>'bool', 'context='=>'?resource', 'offset='=>'int', 'length='=>'int'],
-    'file_put_contents' => ['int|false', 'filename'=>'string', 'data'=>'string|resource|array<string>', 'flags='=>'int', 'context='=>'resource'],
+    'file_put_contents' => ['int<0, max>|false', 'filename'=>'string', 'data'=>'string|resource|array<string>', 'flags='=>'int', 'context='=>'resource'],
     'fileatime' => ['int|false', 'filename'=>'string'],
     'filectime' => ['int|false', 'filename'=>'string'],
     'filegroup' => ['int|false', 'filename'=>'string'],
@@ -10661,7 +10661,7 @@
     'get_resource_type' => ['string', 'resource'=>'resource'],
     'get_resources' => ['array<int,resource>', 'type='=>'string'],
     'getallheaders' => ['array|false'],
-    'getcwd' => ['string|false'],
+    'getcwd' => ['non-falsy-string|false'],
     'getdate' => ['array{seconds: int<0, 59>, minutes: int<0, 59>, hours: int<0, 23>, mday: int<1, 31>, wday: int<0, 6>, mon: int<1, 12>, year: int, yday: int<0, 365>, weekday: "Monday"|"Tuesday"|"Wednesday"|"Thursday"|"Friday"|"Saturday"|"Sunday", month: "January"|"February"|"March"|"April"|"May"|"June"|"July"|"August"|"September"|"October"|"November"|"December", 0: int}', 'timestamp='=>'int'],
     'getenv' => ['string|false', 'name'=>'string', 'local_only='=>'bool'],
     'gethostbyaddr' => ['string|false', 'ip'=>'string'],
@@ -13190,7 +13190,7 @@
     'openssl_x509_free' => ['void', 'certificate'=>'resource'],
     'openssl_x509_parse' => ['array|false', 'certificate'=>'string|resource', 'short_names='=>'bool'],
     'openssl_x509_read' => ['resource|false', 'certificate'=>'string|resource'],
-    'ord' => ['int', 'character'=>'string'],
+    'ord' => ['int<0,255>', 'character'=>'string'],
     'output_add_rewrite_var' => ['bool', 'name'=>'string', 'value'=>'string'],
     'output_cache_disable' => ['void'],
     'output_cache_disable_compression' => ['void'],
@@ -13718,8 +13718,8 @@
     'readline_read_history' => ['bool', 'filename='=>'string'],
     'readline_redisplay' => ['void'],
     'readline_write_history' => ['bool', 'filename='=>'string'],
-    'readlink' => ['string|false', 'path'=>'string'],
-    'realpath' => ['string|false', 'path'=>'string'],
+    'readlink' => ['non-falsy-string|false', 'path'=>'string'],
+    'realpath' => ['non-falsy-string|false', 'path'=>'string'],
     'realpath_cache_get' => ['array'],
     'realpath_cache_size' => ['int'],
     'recode' => ['string', 'request'=>'string', 'string'=>'string'],
@@ -14120,8 +14120,8 @@
     'ssh2_sftp_chmod' => ['bool', 'sftp'=>'resource', 'filename'=>'string', 'mode'=>'int'],
     'ssh2_sftp_lstat' => ['array{0: int, 1: int, 2: int, 3: int, 4: int, 5: int, 6: int, 7: int, 8: int, 9: int, 10: int, 11: int, 12: int, dev: int, ino: int, mode: int, nlink: int, uid: int, gid: int, rdev: int, size: int, atime: int, mtime: int, ctime: int, blksize: int, blocks: int}|false', 'sftp'=>'resource', 'path'=>'string'],
     'ssh2_sftp_mkdir' => ['bool', 'sftp'=>'resource', 'dirname'=>'string', 'mode='=>'int', 'recursive='=>'bool'],
-    'ssh2_sftp_readlink' => ['string|false', 'sftp'=>'resource', 'link'=>'string'],
-    'ssh2_sftp_realpath' => ['string|false', 'sftp'=>'resource', 'filename'=>'string'],
+    'ssh2_sftp_readlink' => ['non-falsy-string|false', 'sftp'=>'resource', 'link'=>'string'],
+    'ssh2_sftp_realpath' => ['non-falsy-string|false', 'sftp'=>'resource', 'filename'=>'string'],
     'ssh2_sftp_rename' => ['bool', 'sftp'=>'resource', 'from'=>'string', 'to'=>'string'],
     'ssh2_sftp_rmdir' => ['bool', 'sftp'=>'resource', 'dirname'=>'string'],
     'ssh2_sftp_stat' => ['array{0: int, 1: int, 2: int, 3: int, 4: int, 5: int, 6: int, 7: int, 8: int, 9: int, 10: int, 11: int, 12: int, dev: int, ino: int, mode: int, nlink: int, uid: int, gid: int, rdev: int, size: int, atime: int, mtime: int, ctime: int, blksize: int, blocks: int}|false', 'sftp'=>'resource', 'path'=>'string'],

diff --git a/docs/running_psalm/configuration.md b/docs/running_psalm/configuration.md
@@ -273,6 +273,14 @@ When `true`, Psalm will complain when referencing an explicit string offset on a
 ```
 When `true`, Psalm will complain when referencing an explicit integer offset on an array e.g. `$arr[7]` without a user first asserting that it exists (either via an `isset` check or via an object-like array). Defaults to `false`.
 
+#### ensureOverrideAttribute
+```xml
+<psalm
+  ensureOverrideAttribute="[bool]"
+>
+```
+When `true`, Psalm will report class and interface methods that override a method on a parent, but do not have an `Override` attribute. Defaults to `false`.
+
 #### phpVersion
 ```xml
 <psalm

diff --git a/docs/running_psalm/error_levels.md b/docs/running_psalm/error_levels.md
@@ -279,6 +279,7 @@ Level 5 and above allows a more non-verifiable code, and higher levels are even
 
 ## Feature-specific errors
 
+ - [MissingOverrideAttribute](issues/MissingOverrideAttribute.md)
  - [PossiblyUndefinedIntArrayOffset](issues/PossiblyUndefinedIntArrayOffset.md)
  - [PossiblyUndefinedStringArrayOffset](issues/PossiblyUndefinedStringArrayOffset.md)
  - [PossiblyUnusedMethod](issues/PossiblyUnusedMethod.md)

diff --git a/docs/running_psalm/issues.md b/docs/running_psalm/issues.md
@@ -121,6 +121,7 @@
  - [MissingDocblockType](issues/MissingDocblockType.md)
  - [MissingFile](issues/MissingFile.md)
  - [MissingImmutableAnnotation](issues/MissingImmutableAnnotation.md)
+ - [MissingOverrideAttribute](issues/MissingOverrideAttribute.md)
  - [MissingParamType](issues/MissingParamType.md)
  - [MissingPropertyType](issues/MissingPropertyType.md)
  - [MissingReturnType](issues/MissingReturnType.md)

diff --git a/docs/running_psalm/issues/MissingOverrideAttribute.md b/docs/running_psalm/issues/MissingOverrideAttribute.md
@@ -0,0 +1,23 @@
+# MissingOverrideAttribute
+
+Emitted when the config flag `ensureOverrideAttribute` is set to `true` and a method on a child class or interface overrides a method on a parent, but no `Override` attribute is present.
+
+```php
+<?php
+
+class A {
+    function receive(): void
+    {
+    }
+}
+
+class B extends A {
+    function receive(): void
+    {
+    }
+}
+```
+
+## Why this is bad
+
+Having an `Override` attribute on overridden methods makes intentions clear. Read the [PHP RFC](https://wiki.php.net/rfc/marking_overriden_methods) for more details.