Document createFromTimestamp() for DateTime and DateTimeImmutable - #5103
Open
mathroc wants to merge 2 commits into
Open
Document createFromTimestamp() for DateTime and DateTimeImmutable#5103mathroc wants to merge 2 commits into
mathroc wants to merge 2 commits into
Conversation
Girgias
reviewed
Jan 14, 2026
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Girgias
marked this pull request as ready for review
February 6, 2026 14:11
lacatoire
reviewed
Feb 17, 2026
| @@ -0,0 +1,71 @@ | |||
| <?xml version="1.0" encoding="utf-8"?> | |||
| <!-- $Revision$ --> | |||
| <refentry xml:id="datetimeimmutble.createfromtimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | |||
Member
There was a problem hiding this comment.
Suggested change
| <refentry xml:id="datetimeimmutble.createfromtimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> | |
| <refentry xml:id="datetimeimmutable.createfromtimestamp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> |
lacatoire
reviewed
Feb 17, 2026
| <programlisting role="php" annotations="non-interactive"> | ||
| <![CDATA[ | ||
| <?php | ||
| $dt = DateTime::createFromTimestamp( 1403261100 ); |
Member
There was a problem hiding this comment.
maybe it could be interesting to add an example with a float as a parameter ?
lacatoire
reviewed
Feb 17, 2026
| <programlisting role="php" annotations="non-interactive"> | ||
| <![CDATA[ | ||
| <?php | ||
| $dt = DateTimeImmutable::createFromTimestamp( 1403261100 ); |
Member
There was a problem hiding this comment.
lacatoire
reviewed
Feb 17, 2026
| </simpara> | ||
| </refsect1> | ||
|
|
||
| <refsect1 role="examples"> |
Member
There was a problem hiding this comment.
That would be great to add a section errors and seealso. The implementation throws DateRangeError for NaN or out-of-range float timestamps. Worth documenting it.
kamil-tekiela
requested changes
Apr 21, 2026
| &reftitle.description; | ||
| <methodsynopsis role="DateTime"> | ||
| <modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>DateTime::createFromTimestamp</methodname> | ||
| <methodparam><type>int|float</type><parameter>timestamp</parameter></methodparam> |
Member
There was a problem hiding this comment.
Suggested change
| <methodparam><type>int|float</type><parameter>timestamp</parameter></methodparam> | |
| <methodparam><type class="union"><type>int</type><type>float</type></type><parameter>timestamp</parameter></methodparam> |
| <refsect1 role="examples"> | ||
| &reftitle.examples; | ||
| <example> | ||
| <title>Creating a date time object from a timestamp</title> |
Member
There was a problem hiding this comment.
Suggested change
| <title>Creating a date time object from a timestamp</title> | |
| <title>Creating a <classname>DateTime</classname> object from a timestamp</title> |
| <programlisting role="php" annotations="non-interactive"> | ||
| <![CDATA[ | ||
| <?php | ||
| $dt = DateTime::createFromTimestamp( 1403261100 ); |
Member
There was a problem hiding this comment.
Suggested change
| $dt = DateTime::createFromTimestamp( 1403261100 ); | |
| $dt = DateTime::createFromTimestamp(1403261100); |
| &reftitle.description; | ||
| <methodsynopsis role="DateTimeImmutable"> | ||
| <modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>DateTimeImmutable::createFromTimestamp</methodname> | ||
| <methodparam><type>int|float</type><parameter>timestamp</parameter></methodparam> |
Member
There was a problem hiding this comment.
Suggested change
| <methodparam><type>int|float</type><parameter>timestamp</parameter></methodparam> | |
| <methodparam><type class="union"><type>int</type><type>float</type></type><parameter>timestamp</parameter></methodparam> |
| <refsect1 role="examples"> | ||
| &reftitle.examples; | ||
| <example> | ||
| <title>Creating a date time object from a timestamp</title> |
Member
There was a problem hiding this comment.
Suggested change
| <title>Creating a date time object from a timestamp</title> | |
| <title>Creating a <classname>DateTime</classname> object from a timestamp</title> |
| <programlisting role="php" annotations="non-interactive"> | ||
| <![CDATA[ | ||
| <?php | ||
| $dt = DateTimeImmutable::createFromTimestamp( 1403261100 ); |
Member
There was a problem hiding this comment.
Suggested change
| $dt = DateTimeImmutable::createFromTimestamp( 1403261100 ); | |
| $dt = DateTimeImmutable::createFromTimestamp(1403261100); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
disclaimer: first time contributing here and edited from github web IDE. I didn't check if it's remotely close to be OK yet