Document the DateTimeImmutable support - #44
Merged
Conversation
Adds the dateTimeImmutable() method introduced in xefi/faker-php#82, and documents that the fromTimestamp / toTimestamp bounds accept any DateTimeInterface, a unix timestamp or a strtotime string.
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.
Documents
dateTimeImmutable(), added in xefi/faker-php#82 and released since, which was missing from the DateTime extension page.Also documents that
fromTimestamp/toTimestampaccept anyDateTimeInterface— that PR widened them fromDateTimetoDateTimeInterface, so aDateTimeImmutablecan now be passed as a bound too — as well as a unix timestampintor astrtotimestring. That was never spelled out on the page, which only ever showed the string form.Checked each documented call against
main:The other recently merged PRs need no doc change
protectedmethods (addExtension,addLocaleExtension,packageManifestPath) and onValidStrategy::pass(). Nothing changes in the public API, and the Strategies page already documents thevalid()callable as returning a boolean, which is what #88 aligned the annotation to.