Person
extends Person
in package
Table of Contents
- GENDER_FEMALE = 'female'
- GENDER_MALE = 'male'
- $femaleNameFormats : mixed
- $firstNameFemale : array<string|int, mixed>
- $firstNameFormat : mixed
- $firstNameMale : array<string|int, mixed>
- $generator : Generator
- $lastName : array<string|int, mixed>
- $maleNameFormats : mixed
- $titleFemale : mixed
- $titleFormat : mixed
- $titleMale : mixed
- $unique : UniqueGenerator
- __construct() : mixed
- asciify() : string
- Replaces * signs with random numbers and letters and special characters
- bothify() : string
- Replaces hash signs ('#') and question marks ('?') with random numbers and letters An asterisk ('*') is replaced with either a random number or a random letter
- firstName() : string
- firstNameFemale() : string
- firstNameMale() : string
- lastName() : string
- lexify() : string
- Replaces all question mark ('?') occurrences with a random letter
- name() : string
- numberBetween() : int
- Returns a random number between $int1 and $int2 (any order)
- numerify() : string
- Replaces all hash sign ('#') occurrences with a random number Replaces all percentage sign ('%') occurrences with a not null number
- optional() : mixed|null
- Chainable method for making any formatter optional.
- passthrough() : mixed
- Returns the passed value
- randomAscii() : string
- Returns a random ASCII character (excluding accents and special chars)
- randomDigit() : int
- Returns a random number between 0 and 9
- randomDigitNot() : int
- Generates a random digit, which cannot be $except
- randomDigitNotNull() : int
- Returns a random number between 1 and 9
- randomElement() : mixed
- Returns a random element from a passed array
- randomElements() : array<string|int, mixed>
- Returns randomly ordered subsequence of $count elements from a provided array
- randomFloat() : float
- Return a random float number
- randomKey() : int|string|null
- Returns a random key from a passed associative array
- randomLetter() : string
- Returns a random letter from a to z
- randomNumber() : int
- Returns a random integer with 0 to $nbDigits digits.
- regexify() : string
- Transforms a basic regular expression into a random string satisfying the expression.
- shuffle() : array<string|int, mixed>|string
- Returns a shuffled version of the argument.
- shuffleArray() : array<string|int, mixed>
- Returns a shuffled version of the array.
- shuffleString() : string
- Returns a shuffled version of the string.
- title() : string
- titleFemale() : string
- titleMale() : string
- toLower() : string
- Converts string to lowercase.
- toUpper() : string
- Converts string to uppercase.
- unique() : UniqueGenerator
- Chainable method for making any formatter unique.
- valid() : ValidGenerator
- Chainable method for forcing any formatter to return only valid values.
- replaceWildcard() : mixed
Constants
GENDER_FEMALE
public
mixed
GENDER_FEMALE
= 'female'
GENDER_MALE
public
mixed
GENDER_MALE
= 'male'
Properties
$femaleNameFormats
protected
static mixed
$femaleNameFormats
= ['{{firstNameFemale}} {{lastName}}']
$firstNameFemale
protected
static array<string|int, mixed>
$firstNameFemale
= ['Ελση', 'Άλκηστις', 'Άννα', 'Άννα Μαρία', 'Έφη', 'Ήβη', 'Αίγλη', 'Αίμιλη', 'Αγάθη', 'Αγάπη', 'Αγγέλα', 'Αγλαϊα', 'Αγνή', 'Αδαμάντια', 'Αθανασία', 'Αθηνά', 'Αλέξια', 'Αλίκη', 'Αλεξάνδρα', 'Αμαλία', 'Αναστασία', 'Ανδρομάχη', 'Ανδρονίκη', 'Ανδρούλα', 'Ανθή', 'Ανθούλα', 'Αννέτα', 'Αννίτα', 'Αντιγόνη', 'Αντωνία', 'Αποστολία', 'Αργυρώ', 'Αρετή', 'Αριάδνη', 'Αριστη', 'Αριστοτέλης', 'Αρτεμισία', 'Ασπασία', 'Αστέρω', 'Αυγή', 'Αυγούστα', 'Αφροδίτη', 'Βέρα', 'Βίκη', 'Βαλέρια', 'Βαλεντίνα', 'Βανθούλα', 'Βαρβάρα', 'Βασιλική', 'Βερονίκη', 'Βικτώρια', 'Βιολέτα', 'Γαβριέλα', 'Γαλάτεια', 'Γεωργία', 'Γεωργιάνα', 'Γιολάντα', 'Γιούλα', 'Γλυκερία', 'Γρηγόρια', 'Δάφνη', 'Δέσποινα', 'Δήμητρα', 'Δήμος', 'Δανάη', 'Δημητριάνα', 'Διαμαντώ', 'Δώρα', 'Εβελίνα', 'Ειρήνη', 'Ελένη', 'Ελίζα', 'Ελίνα', 'Ελεονώρα', 'Ελευθερία', 'Ελισάβετ', 'Ελλάδα', 'Ελπίδα', 'Ελπινίκη', 'Ερίκα', 'Ερασμία', 'Ερατώ', 'Ερμιόνη', 'Ευαγγελία', 'Ευανθία', 'Ευγενία', 'Ευδοκία', 'Ευθυμία', 'Ευρυδίκη', 'Ευσταθία', 'Ευτυχία', 'Ευφροσύνη', 'Εύα', 'Εύη', 'Ζήνα', 'Ζαχαρούλα', 'Ζηνοβία', 'Ζωή', 'Ηλέκτρα', 'Ηλιάδα', 'Ηλιάνα', 'Ηρώ', 'Θάλεια', 'Θέκλα', 'Θέλμα', 'Θέμιδα', 'Θεά', 'Θεανώ', 'Θεογνωσία', 'Θεοδοσία', 'Θεοδώρα', 'Θεονίτσα', 'Θεοπίστη', 'Θεοφανώ', 'Ιουλία', 'Ιρίνα', 'Ισαβέλα', 'Ισμήνη', 'Ιφιγένεια', 'Ιωάννα', 'Κάλλια', 'Κίκα', 'Καλλισθένη', 'Καλλιόπη', 'Καρολίνα', 'Κατερίνα', 'Κλαίρη', 'Κλειώ', 'Κλεονίκη', 'Κλεοπάτρα', 'Κορίνα', 'Κορνήλια', 'Κυπρούλα', 'Κυριακή', 'Κωνσταντίνα', 'Λάουρα', 'Λένα', 'Λένος', 'Λίλια', 'Λίνα', 'Λίτσα', 'Λαρίσα', 'Λευκή', 'Λητώ', 'Λουκία', 'Λουϊζα', 'Λυγία', 'Λύδια', 'Μάγια', 'Μάρθα', 'Μάρκος', 'Μέλανη', 'Μίνα', 'Μαγδαληνή', 'Μαρία', 'Μαρίλια', 'Μαρίνα', 'Μαργαρίτα', 'Μαριάμ', 'Μαριάννα', 'Μαριλένα', 'Μαρκέλλα', 'Μελίνα', 'Μελπομένη', 'Μερόπη', 'Μηλίτσα', 'Μιράντα', 'Μιχαέλλα', 'Μυριάνθη', 'Μυροφόρα', 'Μυρτώ', 'Μόνικα', 'Μύρια', 'Νάγια', 'Νάντια', 'Νάσια', 'Νάσω', 'Νάτια', 'Νέαρχος', 'Νίκη', 'Νίνα', 'Νίτσα', 'Νατάσα', 'Ναταλία', 'Ναυσικά', 'Νεκταρία', 'Νεοφύτα', 'Νεφέλη', 'Νικολέττα', 'Νιόβη', 'Ντίνα', 'Ντανιέλα', 'Νταϊανα', 'Ξάνθη', 'Ξένια', 'Ξενοφών', 'Ολίβια', 'Ολυμπιάδα', 'Ονούφριος', 'Ορθοδοξία', 'Ουρανία', 'Παναγιώτα', 'Παντελίτσα', 'Παρασκευή', 'Παρθενόπη', 'Παυλίνα', 'Περσεφόνη', 'Πετρούλα', 'Πηνελόπη', 'Πολυξένη', 'Πωλίνα', 'Πόλα', 'Πόπη', 'Ρέα', 'Ρίτα', 'Ραάνια', 'Ραφαέλα', 'Ρεββέκα', 'Ροδοθέα', 'Ροδούλα', 'Ρούλα', 'Σάντρα', 'Σάρα', 'Σαββούλα', 'Σαλώμη', 'Σιμόνα', 'Σουζάνα', 'Σοφία', 'Σούλα', 'Σπυρούλα', 'Στάλω', 'Στέφανη', 'Σταυρούλα', 'Στυλιανή', 'Σωτηρούλα', 'Σόνια', 'Σύλβια', 'Τάκης', 'Τάνια', 'Τίνα', 'Τατιάνα', 'Τερέζα', 'Τούλα', 'Τόνια', 'Φαίδρα', 'Φιλιώ', 'Φλωρεντία', 'Φλώρα', 'Φοίβη', 'Φρειδερίκη', 'Φωτεινή', 'Χαρίκλεια', 'Χαραλαμπία', 'Χαριτίνη', 'Χλόη', 'Χρίστια', 'Χριστίνα', 'Χριστιάνα', 'Χριστοδούλα', 'Χριστοθέα', 'Χριστούλα', 'Χρυσάνθη', 'Χρυσή', 'Χρυσοβαλάντω', 'Χρυσούλα', 'Χρυστάλλα', 'Χρυσταλλένη', 'Χρύσα', 'Χρύσω', 'Όλγα']
Tags
$firstNameFormat
protected
static mixed
$firstNameFormat
= ['{{firstNameMale}}', '{{firstNameFemale}}']
$firstNameMale
protected
static array<string|int, mixed>
$firstNameMale
= ['Άγγελος', 'Άδωνης', 'Άκης', 'Άνθιμος', 'Άρης', 'Έκτορας', 'Αβραάμ', 'Αγάπιος', 'Αγαθοκλής', 'Αδαμάντιος', 'Αθανάσιος', 'Αιμίλιος', 'Αλέκος', 'Αλέξανδρος', 'Αλέξης', 'Αλκιβιάδης', 'Αναστάσιος', 'Ανδρέας', 'Ανδρόνικος', 'Ανθούλης', 'Αντώνης', 'Απόστολος', 'Αρέστης', 'Αργύρης', 'Αριστείδης', 'Αριστόδημος', 'Αυγουστής', 'Αυξέντης', 'Αχιλλέας', 'Βίκτωρας', 'Βαλεντίνος', 'Βαρνάβας', 'Βασίλης', 'Βλαδίμηρος', 'Βρυώνης', 'Γαβριήλ', 'Γεννάδιος', 'Γεράσιμος', 'Γιάγκος', 'Γιώργος', 'Γλαύκος', 'Γρηγόρης', 'Δαμιανός', 'Δανιήλ', 'Δημήτρης', 'Δημοσθένης', 'Διομήδης', 'Διονύσης', 'Δώρος', 'Ειρηναίος', 'Εμανουήλ', 'Ερρίκος', 'Ερωτόκριτος', 'Ευάγγελος', 'Ευαγόρας', 'Ευγένιος', 'Ευθύμιος', 'Ευριπίδης', 'Ευστάθιος', 'Ευτύχιος', 'Εφραίμ', 'Ζήνωνας', 'Ζαχαρίας', 'Ηλίας', 'Ηράκλης', 'Ηρόδοτος', 'Θεμιστοκλής', 'Θεοδόσης', 'Θεοφάνης', 'Θεοχάρης', 'Θεόδουλος', 'Θεόδωρος', 'Θεόφιλος', 'Θρασύβουλος', 'Θωμάς', 'Ιάκωβος', 'Ιάκωβος', 'Ιάσωνας', 'Ιορδάνης', 'Ιωάννης', 'Ιωακείμ', 'Ιωνάς', 'Ιωσήφ', 'Κλεάνθης', 'Κλείτος', 'Κοσμάς', 'Κυριάκος', 'Κύπρος', 'Κώστας', 'Λάζαρος', 'Λάκης', 'Λάμπρος', 'Λέανδρος', 'Λευτέρης', 'Λεωνίδας', 'Λεόντιος', 'Λεύκιος', 'Λουκάς', 'Λοϊζος', 'Μάκης', 'Μάμας', 'Μάξιμος', 'Μάριος', 'Μανώλης', 'Μαρίνος', 'Ματθαίος', 'Μενέλαος', 'Μηνάς', 'Μιλτιάδης', 'Μιχάλης', 'Μωυσής', 'Μόδεστος', 'Νέστορας', 'Νεκτάριος', 'Νεοκλής', 'Νεόφυτος', 'Νικήτας', 'Νικόλας', 'Ντένης', 'Ντίνος', 'Ξάνθος', 'Ξένιος', 'Οδυσσέας', 'Ονησιφόρος', 'Ορέστης', 'Πάρης', 'Πέτρος', 'Παναγιώτης', 'Παντελής', 'Παρασκευάς', 'Πασχάλης', 'Παύλος', 'Περικλής', 'Πιερής', 'Πολύβιος', 'Πολύδωρος', 'Πολύκαρπος', 'Προκόπης', 'Πρόδρομος', 'Ρένος', 'Ραφαήλ', 'Ρολάνδος', 'Σάββας', 'Σέργιος', 'Σεβαστιανός', 'Σολωμός', 'Σοφοκλής', 'Σοφρώνης', 'Σπυρίδωνας', 'Στέφανος', 'Σταύρος', 'Στυλιανός', 'Συμεών', 'Σωκράτης', 'Σωτήρης', 'Σόλωνας', 'Τηλέμαχος', 'Τιμόθεος', 'Τρύφωνας', 'Φίλιππος', 'Φαίδωνας', 'Φειδίας', 'Φλώρος', 'Φοίβος', 'Φρίξος', 'Φώτης', 'Χαράλαμπος', 'Χαρίλαος', 'Χρίστος', 'Χριστοφής', 'Χριστόδουλος', 'Χριστόφορος', 'Χρυσήλιος', 'Χρυσόστομος', 'Χρύσανθος', 'Όμηρος']
Tags
$generator
protected
Generator
$generator
$lastName
protected
static array<string|int, mixed>
$lastName
= ['Άκη', 'Αγαθοκλέους', 'Αθανάσιου', 'Αλέκου', 'Αλεξάνδρου', 'Αλκιβιάδη', 'Αναστασίου', 'Ανδρέου', 'Ανδρονίκου', 'Αντωνίου', 'Αργύρη', 'Αριστείδη', 'Αριστοδήμου', 'Αυγουστή', 'Αυξεντίου', 'Αχιλλέα', 'Βίκτωρα', 'Βαλεντίνου', 'Βαρνάβα', 'Βασίλη', 'Γαβριήλ', 'Γεράσιμου', 'Γεωργίου', 'Γιάγκου', 'Γλαύκου', 'Γρηγορίου', 'Δαμιανού', 'Δανιήλ', 'Δημητρίου', 'Δημοσθένους', 'Διομήδη', 'Διονυσίου', 'Ερωτοκρίτου', 'Ευαγγέλου', 'Ευαγόρα', 'Ευγενίου', 'Ευθύμιου', 'Ευριπίδη', 'Ευστάθιου', 'Ευτύχιου', 'Ζήνωνα', 'Ζαχαρία', 'Ηλία', 'Ηρακλέους', 'Θεμιστοκλέους', 'Θεοδούλου', 'Θεοδόση', 'Θεοδώρου', 'Θεοδώρου', 'Θεοφάνους', 'Θεοχάρους', 'Θεόφιλου', 'Θρασύβουλου', 'Θωμά', 'Ιάσωνα', 'Ιακώβου', 'Ιορδάνου', 'Ιωάννη', 'Ιωακείμ', 'Ιωνά', 'Ιωσήφ', 'Κλεάνθη', 'Κλείτου', 'Κοσμά', 'Κυριάκου', 'Κωνσταντίνου', 'Κύπρου', 'Κώστα', 'Λάμπρου', 'Λεάνδρου', 'Λεοντίου', 'Λευτέρη', 'Λεωνίδα', 'Λουκά', 'Λοϊζου', 'Μάμα', 'Μανώλη', 'Μαρίνου', 'Μιλτιάδη', 'Μιχαήλ', 'Μωυσέως', 'Νεκτάριου', 'Νεοκλέους', 'Νεοφύτου', 'Νικήτα', 'Νικολάου', 'Ομήρου', 'Ορέστη', 'Πάρη', 'Πέτρου', 'Παναγιώτη', 'Παντελής', 'Παρασκευά', 'Πασχάλη', 'Παύλου', 'Περικλέους', 'Πιερή', 'Πολύβιου', 'Πολύδωρου', 'Πολύκαρπου', 'Προδρόμου', 'Προκόπη', 'Ραφαήλ', 'Σάββα', 'Σολωμός', 'Σοφοκλέους', 'Σοφρωνίου', 'Σπυρίδωνος', 'Στέφανου', 'Σταύρου', 'Στυλιανού', 'Συμεών', 'Σωκράτη', 'Σωτηρίου', 'Σόλωνα', 'Τηλεμάχου', 'Τιμοθέου', 'Τρύφωνος', 'Φίλιππου', 'Φαίδωνος', 'Φειδία', 'Φοίβου', 'Φώτη', 'Χαραλάμπους', 'Χαριλάου', 'Χρίστου', 'Χριστοδούλου', 'Χριστοφή', 'Χριστοφόρου', 'Χρυσόστομος', 'Χρύσανθου']
Tags
$maleNameFormats
protected
static mixed
$maleNameFormats
= ['{{firstNameMale}} {{lastName}}']
$titleFemale
protected
static mixed
$titleFemale
= ['δις.', 'δνις.', 'κα.']
$titleFormat
protected
static mixed
$titleFormat
= ['{{titleMale}}', '{{titleFemale}}']
$titleMale
protected
static mixed
$titleMale
= ['κος.', 'κ.']
$unique
protected
UniqueGenerator
$unique
Methods
__construct()
public
__construct(Generator $generator) : mixed
Parameters
- $generator : Generator
Return values
mixed —asciify()
Replaces * signs with random numbers and letters and special characters
public
static asciify([string $string = '****' ]) : string
Parameters
- $string : string = '****'
-
String that needs to bet parsed
Tags
Return values
string —bothify()
Replaces hash signs ('#') and question marks ('?') with random numbers and letters An asterisk ('*') is replaced with either a random number or a random letter
public
static bothify([string $string = '## ??' ]) : string
Parameters
- $string : string = '## ??'
-
String that needs to bet parsed
Return values
string —firstName()
public
firstName([string|null $gender = null ]) : string
Parameters
- $gender : string|null = null
-
'male', 'female' or null for any
Tags
Return values
string —firstNameFemale()
public
static firstNameFemale() : string
Return values
string —firstNameMale()
public
static firstNameMale() : string
Return values
string —lastName()
public
lastName() : string
Tags
Return values
string —lexify()
Replaces all question mark ('?') occurrences with a random letter
public
static lexify([string $string = '????' ]) : string
Parameters
- $string : string = '????'
-
String that needs to bet parsed
Return values
string —name()
public
name([string|null $gender = null ]) : string
Parameters
- $gender : string|null = null
-
'male', 'female' or null for any
Tags
Return values
string —numberBetween()
Returns a random number between $int1 and $int2 (any order)
public
static numberBetween(int $int1[, int $int2 = 2147483647 ]) : int
Parameters
- $int1 : int
-
default to 0
- $int2 : int = 2147483647
-
defaults to 32 bit max integer, ie 2147483647
Tags
Return values
int —numerify()
Replaces all hash sign ('#') occurrences with a random number Replaces all percentage sign ('%') occurrences with a not null number
public
static numerify([string $string = '###' ]) : string
Parameters
- $string : string = '###'
-
String that needs to bet parsed
Return values
string —optional()
Chainable method for making any formatter optional.
public
optional([float|int $weight = 0.5 ][, mixed $default = null ]) : mixed|null
Parameters
- $weight : float|int = 0.5
-
Set the probability of receiving a null value. "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).
- $default : mixed = null
Return values
mixed|null —passthrough()
Returns the passed value
public
static passthrough(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —randomAscii()
Returns a random ASCII character (excluding accents and special chars)
public
static randomAscii() : string
Return values
string —randomDigit()
Returns a random number between 0 and 9
public
static randomDigit() : int
Return values
int —randomDigitNot()
Generates a random digit, which cannot be $except
public
static randomDigitNot(int $except) : int
Parameters
- $except : int
Return values
int —randomDigitNotNull()
Returns a random number between 1 and 9
public
static randomDigitNotNull() : int
Return values
int —randomElement()
Returns a random element from a passed array
public
static randomElement([array<string|int, mixed> $array = ['a', 'b', 'c'] ]) : mixed
Parameters
- $array : array<string|int, mixed> = ['a', 'b', 'c']
Return values
mixed —randomElements()
Returns randomly ordered subsequence of $count elements from a provided array
public
static randomElements([array<string|int, mixed> $array = ['a', 'b', 'c'] ][, int $count = 1 ][, bool $allowDuplicates = false ]) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed> = ['a', 'b', 'c']
-
Array to take elements from. Defaults to a-c
- $count : int = 1
-
Number of elements to take.
- $allowDuplicates : bool = false
-
Allow elements to be picked several times. Defaults to false
Tags
Return values
array<string|int, mixed> —New array with $count elements from $array
randomFloat()
Return a random float number
public
static randomFloat([int $nbMaxDecimals = null ], float|int $min[, float|int $max = null ]) : float
Parameters
- $nbMaxDecimals : int = null
- $min : float|int
- $max : float|int = null
Tags
Return values
float —randomKey()
Returns a random key from a passed associative array
public
static randomKey([array<string|int, mixed> $array = [] ]) : int|string|null
Parameters
- $array : array<string|int, mixed> = []
Return values
int|string|null —randomLetter()
Returns a random letter from a to z
public
static randomLetter() : string
Return values
string —randomNumber()
Returns a random integer with 0 to $nbDigits digits.
public
static randomNumber([int $nbDigits = null ][, bool $strict = false ]) : int
The maximum value returned is mt_getrandmax()
Parameters
- $nbDigits : int = null
-
Defaults to a random number between 1 and 9
- $strict : bool = false
-
Whether the returned number should have exactly $nbDigits
Tags
Return values
int —regexify()
Transforms a basic regular expression into a random string satisfying the expression.
public
static regexify([string $regex = '' ]) : string
Parameters
- $regex : string = ''
-
A regular expression (delimiters are optional)
Tags
Return values
string —shuffle()
Returns a shuffled version of the argument.
public
static shuffle([array<string|int, mixed>|string $arg = '' ]) : array<string|int, mixed>|string
This function accepts either an array, or a string.
Parameters
- $arg : array<string|int, mixed>|string = ''
-
The set to shuffle
Tags
Return values
array<string|int, mixed>|string —The shuffled set
shuffleArray()
Returns a shuffled version of the array.
public
static shuffleArray([array<string|int, mixed> $array = [] ]) : array<string|int, mixed>
This function does not mutate the original array. It uses the Fisher–Yates algorithm, which is unbiased, together with a Mersenne twister random generator. This function is therefore more random than PHP's shuffle() function, and it is seedable.
Parameters
- $array : array<string|int, mixed> = []
-
The set to shuffle
Tags
Return values
array<string|int, mixed> —The shuffled set
shuffleString()
Returns a shuffled version of the string.
public
static shuffleString([string $string = '' ][, string $encoding = 'UTF-8' ]) : string
This function does not mutate the original string. It uses the Fisher–Yates algorithm, which is unbiased, together with a Mersenne twister random generator. This function is therefore more random than PHP's shuffle() function, and it is seedable. Additionally, it is UTF8 safe if the mb extension is available.
Parameters
- $string : string = ''
-
The set to shuffle
- $encoding : string = 'UTF-8'
-
The string encoding (defaults to UTF-8)
Tags
Return values
string —The shuffled set
title()
public
title([string|null $gender = null ]) : string
Parameters
- $gender : string|null = null
-
'male', 'female' or null for any
Tags
Return values
string —titleFemale()
public
static titleFemale() : string
Tags
Return values
string —titleMale()
public
static titleMale() : string
Tags
Return values
string —toLower()
Converts string to lowercase.
public
static toLower([string $string = '' ]) : string
Uses mb_string extension if available.
Parameters
- $string : string = ''
-
String that should be converted to lowercase
Return values
string —toUpper()
Converts string to uppercase.
public
static toUpper([string $string = '' ]) : string
Uses mb_string extension if available.
Parameters
- $string : string = ''
-
String that should be converted to uppercase
Return values
string —unique()
Chainable method for making any formatter unique.
public
unique([bool $reset = false ][, int $maxRetries = 10000 ]) : UniqueGenerator
// will never return twice the same value
$faker->unique()->randomElement(array(1, 2, 3));
Parameters
- $reset : bool = false
-
If set to true, resets the list of existing values
- $maxRetries : int = 10000
-
Maximum number of retries to find a unique value, After which an OverflowException is thrown.
Tags
Return values
UniqueGenerator —A proxy class returning only non-existing values
valid()
Chainable method for forcing any formatter to return only valid values.
public
valid([Closure $validator = null ][, int $maxRetries = 10000 ]) : ValidGenerator
The value validity is determined by a function passed as first argument.
$values = array();
$evenValidator = function ($digit) {
return $digit % 2 === 0;
};
for ($i=0; $i < 10; $i++) {
$values []= $faker->valid($evenValidator)->randomDigit;
}
print_r($values); // [0, 4, 8, 4, 2, 6, 0, 8, 8, 6]
Parameters
- $validator : Closure = null
-
A function returning true for valid values
- $maxRetries : int = 10000
-
Maximum number of retries to find a unique value, After which an OverflowException is thrown.
Tags
Return values
ValidGenerator —A proxy class returning only valid values
replaceWildcard()
private
static replaceWildcard(mixed $string[, mixed $wildcard = '#' ][, mixed $callback = 'static::randomDigit' ]) : mixed
Parameters
- $string : mixed
- $wildcard : mixed = '#'
- $callback : mixed = 'static::randomDigit'