Doc #69685 [ReO->Wfx]: gmmktime() does not return boolean false on error

Edit report at https://bugs.php.net/bug.php?id=69685&edit=1

 ID:                 69685
 Updated by:         [email protected]
 Reported by:        alexander dot schuch+php at dezem dot de
 Summary:            gmmktime() does not return boolean false on error
-Status:             Re-Opened
+Status:             Wont fix
 Type:               Documentation Problem
 Package:            Date/time related
 PHP Version:        5.4.41
 Block user comment: N
 Private report:     N

 New Comment:

I'm closing this, as mktime and gmmktime should be considered legacy APIs. If you feel strongly about this, feel free to open a ticket at https://github.com/php/php-src/issues.


Previous Comments:
------------------------------------------------------------------------
[2015-05-21 19:32:24] alexander dot schuch+php at dezem dot de

How can I reopen this issue? The comment given by [email protected] is not related to fixing the documentation of the return code when valid and complete arguments are given.

------------------------------------------------------------------------
[2015-05-21 19:26:17] alexander dot schuch+php at dezem dot de

Why does mktime() document a possible return code of false in case of an error, while gmmktime() does not? When can mktime() fail besides invalid arguments compared to gmmktime()?

This should be documented.

The changelog documents changes in is_dst parameter in PHP 5.1. But it does not document changes in the return code. PHP 5.1.3 - 5.2.5 returns false *with valid parameters*. Later versions seem to always return an integer.

This should be documented.

------------------------------------------------------------------------
[2015-05-21 19:19:03] [email protected]

We generally don't document on each page that invalid parameters result in false being returned: this is a normal expectation for internal functions.

------------------------------------------------------------------------
[2015-05-21 19:16:20] alexander dot schuch+php at dezem dot de

Description:
------------
---
From manual page: http://www.php.net/function.gmmktime
---
The documentation of mktime() says for the return value "mktime() returns the Unix timestamp of the arguments given. If the arguments are invalid, the function returns FALSE (before PHP 5.1 it returned -1)."

However, gmmktime() only ever returns an integer as of documentation.

I checked the PHP source code.

https://github.com/php/php-src/blob/c2ef8a9acc7977d07a9a92b07352cdefa7c4b9a5/ext/date/php_date.c#L1572

mktime() and gmmktime() both use the same internal function php_mktime().

https://github.com/php/php-src/blob/c2ef8a9acc7977d07a9a92b07352cdefa7c4b9a5/ext/date/php_date.c#L1491

This one in all cases returns false on invalid parameters.

The only way for gmmktime()/php_mktime() to fail is in timelib_date_to_int():

https://github.com/php/php-src/blob/f179852f838c1d88cb39097b9557b7d2ba8e5755/ext/date/lib/timelib.c#L186

However, I do not properly understand the difference between timelib_long and timelib_sll:

https://github.com/php/php-src/blob/f179852f838c1d88cb39097b9557b7d2ba8e5755/ext/date/lib/timelib_structs.h#L144

So, when actually can gmmktime() fail in case the arguments are correct or, does it return any errors?

Test script:
---------------
http://3v4l.org/2esJM

<?php
var_dump(PHP_INT_MAX);
var_dump(gmmktime(0,0,0,1,1,PHP_INT_MAX));
?>

Expected result:
----------------
I wish:

- The function should return an error in case of integer overflows or underflows (proleptic Gregorian calender is assumed).

Issues, depending on classification of documentation bug or implementation bug:

- mktime() and gmmktime() should return the same "kind of data". So only integer, or integer or false.
- Documentation of return value of mktime() and gmmktime() should be the same.
- Documentation should mention that errors are/are not detected, so either the returned timestamp is "random" (single or multiple overflows) or an error is indicated.

Actual result:
--------------
Output for 5.2.6 - 5.6.9, php7@20140507 - 20150501
    int(9223372036854775807)
    int(-62198793216) 

Output for 5.1.3 - 5.2.5
    int(9223372036854775807)
    bool(false) 

Output for 5.1.0 - 5.1.2
    int(9223372036854775807)
    Process exited with code 137.

Output for 4.4.0 - 4.4.9, 5.0.5
    int(9223372036854775807)
    int(-62198755200) 


------------------------------------------------------------------------



--
Edit this bug report at https://bugs.php.net/bug.php?id=69685&edit=1