Doc #78142 [Opn]: Function prototype return value does not contain type in case of failure

From: Date: Tue, 11 Jun 2019 14:29:59 +0000
Subject: Doc #78142 [Opn]: Function prototype return value does not contain type in case of failure
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-16732@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=78142&edit=1 ID: 78142 Updated by: girgias@php.net Reported by: mail at marcus dot haase dot name -Summary: wrong return type in docs +Summary: Function prototype return value does not contain type in case of failure Status: Open Type: Documentation Problem Package: *General Issues Operating System: Irrelevant PHP Version: Irrelevant Block user comment: N Private report: N New Comment: This "issue" has been raised multiple times already and the current stance that I'm aware of is that the doc will not be changed to encompass false as a return value in the prototype. The main reason for this is that there are so many functions affected that it is unpractical. Previous Comments: ------------------------------------------------------------------------ [2019-06-11 11:36:55] mail at marcus dot haase dot name Description: ------------ The return type for mb-strpos is declared as int, although it can be either int of false, as is explained in the text of the documentation later on. To somebody reading only the call-description but not the textual description, this is misleading. --- mb_strpos ( string $haystack , string $needle [, int $offset = 0 [, string $encoding = mb_internal_encoding() ]] ) : int --- --- From manual page: https://php.net/function.mb-strpos --- Test script: --------------- Irrelevant Expected result: ---------------- Remove the PHP7.1 return type ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=78142&edit=1

« previous php.doc.bugs (#16732) next »