This repository has been archived by the owner on Dec 11, 2020. It is now read-only.
optional and boolean api inconsistency #513
Merged
Conversation
This file contains 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
| @@ -292,6 +292,16 @@ $faker->optional($weight = 0.5, $default = false)->randomDigit; // 50% chance of | |||
| $faker->optional($weight = 0.9, $default = 'abc')->word; // 10% chance of 'abc' | |||
| ``` | |||
|
|
|||
| Since v1.5 this method will accept a percentage like the `boolean()` method. | |||
There was a problem hiding this comment.
I think you should just replace the old doc with the new preferred way, which is the integer way. As for the BC break, it's very minimal. I'll just mention it in the release post.
|
Done, let me know if anything else is required |
| @@ -945,6 +945,7 @@ echo $faker->cityName; | |||
| * [AliceFixturesBundle](https://github.com/h4cc/AliceFixturesBundle): A Symfony2 bundle for using Alice and Faker with data fixtures. Abled to use Doctrine ORM as well as Doctrine MongoDB ODM. | |||
| * [Factory Muffin](https://github.com/thephpleague/factory-muffin): enable the rapid creation of objects (PHP port of factory-girl) | |||
| * [CompanyNameGenerator](https://github.com/fzaninotto/CompanyNameGenerator): Generate names for English tech companies with class | |||
| * [PlaceholdItProvider](https://github.com/EmanueleMinotto/PlaceholdItProvider): Generate images using placehold.it | |||
There was a problem hiding this comment.
Pirate change. Requires another PR ;)
There was a problem hiding this comment.
You're right, sorry
|
Needs rebase |
I’m submitting this just to add it to the third-party libraries list
|
@fzaninotto sorry for the months of delay, I hope it isn't too late |
|
ping @fzaninotto |
| * "0" will always return null, "1" will always return the generator. | ||
| * If $weight is an integer value, then the same system works | ||
| * between 0 (always get false) and 100 (always get true). | ||
| * @return mixed|null | ||
| */ | ||
| public function optional($weight = 0.5, $default = null) |
There was a problem hiding this comment.
shouldn't you make the default weight 50 to reflect the new system?
|
It' been open for too long, time to merge! |
fzaninotto
added a commit
that referenced
this pull request
Oct 12, 2015
optional and boolean api inconsistency
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR if for #265.
I'm not 100% sure that the documentation is enough, let me know how to edit it if it isn't good.
Thanks