mirror_php/Faker
1
0
Fork 0
mirror of https://github.com/fzaninotto/Faker.git synced 2025-03-22 00:09:59 +01:00
Code Issues Releases Wiki Activity

Update optional() method docblock.

Browse Source
This commit is contained in:
Eric Aken Roberts 2014-02-21 13:59:57 -06:00
parent 41f1b6ae74
commit b491b67015
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/Faker/Provider/Base.php
View File

@ -190,7 +190,8 @@ class Base
/**
* Converts string to lowercase.
* Uses mb_string extension if available
* Uses mb_string extension if available.
*
* @param string $string String that should be converted to lowercase
* @return string
*/
@ -201,7 +202,8 @@ class Base
/**
* Converts string to uppercase.
* Uses mb_string extension if available
* Uses mb_string extension if available.
*
* @param string $string String that should be converted to uppercase
* @return string
*/
@ -211,9 +213,10 @@ class Base
}
/**
* Chainable method for making any formatter optional
* @param float $weight Set the percentage that the formatter is empty.
* "0" would always return null, "1" would always return the formatter
* Chainable method for making any formatter optional.
*
* @param float $weight Set the probability of receiving a null value.
* "0" will always return null, "1" will always return the generator.
* @return mixed|null
*/
public function optional($weight = 0.5)