added NarrowReturnType extension to remove |false from native functions and methods

Author: dg

extension-narrowReturnType.neon

@@ -0,0 +1,149 @@
+services:
+	-
+		class: Nette\PHPStan\Type\NarrowReturnTypeResolver([
+			# PHP still returns |false, but it's trivial — indicates a programming error or unrealistic state
+			# ---------
+
+			# Regex (false = invalid pattern)
+			preg_match
+			preg_split
+			preg_grep
+
+			# JSON
+			json_encode
+
+			# Output buffering (false = no active buffer)
+			ob_get_clean
+			ob_get_contents
+			ob_get_flush
+			ob_get_length
+
+			# Compression (false = error that won't happen with valid data)
+			gzcompress
+			gzencode
+			gzdeflate
+			zlib_encode
+			deflate_add
+
+			# System information
+			getcwd
+			gethostname
+			getmypid
+			getmyuid
+			getmygid
+			php_ini_loaded_file
+			sys_getloadavg
+
+			# mb_string (false = invalid encoding)
+			mb_chr
+			mb_ord
+			mb_split
+
+			# Operations on a valid file handle
+			fstat
+			ftell
+			fwrite
+			fputs
+			fputcsv
+
+			# Date/Time
+			date_timezone_get
+
+			# Intl
+			normalizer_normalize
+			msgfmt_format
+
+			# GD operations on a valid resource
+			imageaffine
+			imageaffinematrixconcat
+			imageaffinematrixget
+			imagecolorallocate
+			imagecolorallocatealpha
+			imagecolorat
+			imagecrop
+			imagecropauto
+			imageftbbox
+			imagefttext
+			imagettfbbox
+			imagettftext
+			imagerotate
+			imagescale
+			imagegrabscreen
+			imagegrabwindow
+
+			# Curl
+			curl_copy_handle
+			curl_escape
+			curl_unescape
+
+			# Openssl (false = invalid algorithm/parameters)
+			openssl_cipher_iv_length
+			openssl_digest
+
+			# Session (false = no active session)
+			session_id
+			session_name
+			session_module_name
+			session_save_path
+			session_cache_limiter
+			session_encode
+
+			# Other
+			convert_uudecode
+			nl_langinfo
+			image_type_to_extension
+			curl_version
+
+			# Intl
+			Normalizer::normalize
+			NumberFormatter::format
+			NumberFormatter::formatCurrency
+			IntlDateFormatter::format
+			Transliterator::transliterate
+
+			# DOM
+			DOMDocument::save
+			DOMDocument::saveHTML
+			DOMDocument::saveHTMLFile
+			DOMDocument::saveXML
+			DOMText::splitText
+
+
+			# PHPStan reports |false but current PHP no longer returns false
+			# ---------
+
+			hash
+			hash_hmac
+			hash_hkdf
+			hash_pbkdf2
+			array_combine
+			explode
+			str_split
+			mb_strlen
+			mb_encoding_aliases
+			fpassthru
+			date_add
+			date_sub
+			date_date_set
+			date_isodate_set
+			date_time_set
+			date_timestamp_set
+			date_timezone_set
+			imagecolorexact
+			imagecolorexactalpha
+			openssl_random_pseudo_bytes
+			substr_compare
+			sleep
+			long2ip
+			fgetss
+			gzgetss
+			gzpassthru
+			jdtounix
+			apache_request_headers
+			apache_response_headers
+
+			DateInterval::createFromDateString
+			PDOStatement::fetchAll
+			SplFileObject::fgetss
+		])
+		tags: [phpstan.broker.expressionTypeResolverExtension]

extension.neon

@@ -1 +1,4 @@
 parameters:
+
+includes:
+	- extension-narrowReturnType.neon

phpstan.neon

@@ -9,5 +9,10 @@ parameters:
 		analyse:
 			- tests/data/*
 
+	ignoreErrors:
+		-
+			identifiers: [phpstanApi.method]
+			path: src/Type/NarrowReturnTypeResolver.php
+
 includes:
 	- extension.neon