Company
extends Company
in package
Table of Contents
- $attribute : array<string|int, mixed>
- $catchPhraseFormats : array<string|int, mixed>
- $companySuffix : array<string|int, mixed>
- $formats : array<string|int, mixed>
- $generator : Generator
- $jobTitleFormat : mixed
- $noun : array<string|int, mixed>
- $siretNicFormats : mixed
- $unique : UniqueGenerator
- $verb : array<string|int, mixed>
- $wordsWhichShouldNotAppearTwice : array<string|int, mixed>
- __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
- catchPhrase() : string
- Generates a french catch phrase.
- catchPhraseAttribute() : string
- Returns a random catch phrase attribute.
- catchPhraseNoun() : string
- Returns a random catch phrase noun.
- catchPhraseVerb() : string
- Returns a random catch phrase verb.
- company() : string
- companySuffix() : string
- jobTitle() : string
- lexify() : string
- Replaces all question mark ('?') occurrences with a random letter
- 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.
- siren() : string
- Generates a siren number (9 digits) that passes the Luhn check.
- siret() : string
- Generates a siret number (14 digits) that passes the Luhn check.
- 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.
- isCatchPhraseValid() : bool
- Validates a french catch phrase.
- replaceWildcard() : mixed
Properties
$attribute
protected
static array<string|int, mixed>
$attribute
= ['de manière efficace', 'plus rapidement', 'plus facilement', 'plus simplement', 'en toute tranquilité', 'avant-tout', 'autrement', 'naturellement', 'à la pointe', 'sans soucis', "à l'état pur", 'à sa source', 'de manière sûre', 'en toute sécurité']
End of sentences (used by the catch phrase format).
$catchPhraseFormats
protected
static array<string|int, mixed>
$catchPhraseFormats
= ['{{catchPhraseNoun}} {{catchPhraseVerb}} {{catchPhraseAttribute}}']
French catch phrase formats.
$companySuffix
protected
static array<string|int, mixed>
$companySuffix
= ['SA', 'S.A.', 'SARL', 'S.A.R.L.', 'SAS', 'S.A.S.', 'et Fils']
Company suffixes.
$formats
protected
static array<string|int, mixed>
$formats
= ['{{lastName}} {{companySuffix}}', '{{lastName}} {{lastName}} {{companySuffix}}', '{{lastName}}', '{{lastName}}']
French company name formats.
$generator
protected
Generator
$generator
$jobTitleFormat
protected
static mixed
$jobTitleFormat
= ['Agent d'accueil', 'Agent d'enquêtes', 'Agent d'entreposage', 'Agent de curage', 'Agro-économiste', 'Aide couvreur', 'Aide à domicile', 'Aide-déménageur', 'Ambassadeur', 'Analyste télématique', 'Animateur d'écomusée', 'Animateur web', 'Appareilleur-gazier', 'Archéologue', 'Armurier d'art', 'Armurier spectacle', 'Artificier spectacle', 'Artiste dramatique', 'Aspigiculteur', 'Assistant de justice', 'Assistant des ventes', 'Assistant logistique', 'Assistant styliste', 'Assurance', 'Auteur-adaptateur', 'Billettiste voyages', 'Brigadier', 'Bruiteur', 'Bâtonnier d'art', 'Bûcheron', 'Cameraman', 'Capitaine de pêche', 'Carrier', 'Caviste', 'Chansonnier', 'Chanteur', 'Chargé de recherche', 'Chasseur-bagagiste', 'Chef de fabrication', 'Chef de scierie', 'Chef des ventes', 'Chef du personnel', 'Chef géographe', 'Chef monteur son', 'Chef porion', 'Chiropraticien', 'Choréologue', 'Chromiste', 'Cintrier-machiniste', 'Clerc hors rang', 'Coach sportif', 'Coffreur béton armé', 'Coffreur-ferrailleur', 'Commandant de police', 'Commandant marine', 'Commis de coupe', 'Comptable unique', 'Conception et études', 'Conducteur de jumbo', 'Conseiller culinaire', 'Conseiller funéraire', 'Conseiller relooking', 'Consultant ergonome', 'Contrebassiste', 'Convoyeur garde', 'Copiste offset', 'Corniste', 'Costumier-habilleur', 'Coutelier d'art', 'Cueilleur de cerises', 'Céramiste concepteur', 'Danse', 'Danseur', 'Data manager', 'Dee-jay', 'Designer produit', 'Diététicien conseil', 'Diététique', 'Doreur sur métaux', 'Décorateur-costumier', 'Défloqueur d'amiante', 'Dégustateur', 'Délégué vétérinaire', 'Délégué à la tutelle', 'Désamianteur', 'Détective', 'Développeur web', 'Ecotoxicologue', 'Elagueur-botteur', 'Elagueur-grimpeur', 'Elastiqueur', 'Eleveur d'insectes', 'Eleveur de chats', 'Eleveur de volailles', 'Embouteilleur', 'Employé d'accueil', 'Employé d'étage', 'Employé de snack-bar', 'Endivier', 'Endocrinologue', 'Epithésiste', 'Essayeur-retoucheur', 'Etainier', 'Etancheur', 'Etancheur-bardeur', 'Etiqueteur', 'Expert back-office', 'Exploitant de tennis', 'Extraction', 'Facteur', 'Facteur de clavecins', 'Facteur de secteur', 'Fantaisiste', 'Façadier-bardeur', 'Façadier-ravaleur', 'Feutier', 'Finance', 'Flaconneur', 'Foreur pétrole', 'Formateur d'italien', 'Fossoyeur', 'Fraiseur', 'Fraiseur mouliste', 'Frigoriste maritime', 'Fromager', 'Galeriste', 'Gardien de résidence', 'Garçon de chenil', 'Garçon de hall', 'Gendarme mobile', 'Guitariste', 'Gynécologue', 'Géodésien', 'Géologue prospecteur', 'Géomètre', 'Géomètre du cadastre', 'Gérant d'hôtel', 'Gérant de tutelle', 'Gériatre', 'Hydrothérapie', 'Hématologue', 'Hôte de caisse', 'Ingénieur bâtiment', 'Ingénieur du son', 'Ingénieur géologue', 'Ingénieur géomètre', 'Ingénieur halieute', 'Ingénieur logistique', 'Instituteur', 'Jointeur de placage', 'Juge des enfants', 'Juriste financier', 'Kiwiculteur', 'Lexicographe', 'Liftier', 'Litigeur transport', 'Logistique', 'Logopède', 'Magicien', 'Manager d'artiste', 'Mannequin détail', 'Maquilleur spectacle', 'Marbrier-poseur', 'Marin grande pêche', 'Matelassier', 'Maçon', 'Maçon-fumiste', 'Maçonnerie', 'Maître de ballet', 'Maïeuticien', 'Menuisier', 'Miroitier', 'Modéliste industriel', 'Moellonneur', 'Moniteur de sport', 'Monteur audiovisuel', 'Monteur de fermettes', 'Monteur de palettes', 'Monteur en siège', 'Monteur prototypiste', 'Monteur-frigoriste', 'Monteur-truquiste', 'Mouleur sable', 'Mouliste drapeur', 'Mécanicien-armurier', 'Médecin du sport', 'Médecin scolaire', 'Médiateur judiciaire', 'Médiathécaire', 'Net surfeur surfeuse', 'Oenologue', 'Opérateur de plateau', 'Opérateur du son', 'Opérateur géomètre', 'Opérateur piquage', 'Opérateur vidéo', 'Ouvrier d'abattoir', 'Ouvrier serriste', 'Ouvrier sidérurgiste', 'Palefrenier', 'Paléontologue', 'Pareur en abattoir', 'Parfumeur', 'Parqueteur', 'Percepteur', 'Photographe d'art', 'Pilote automobile', 'Pilote de soutireuse', 'Pilote fluvial', 'Piqueur en ganterie', 'Pisteur secouriste', 'Pizzaïolo', 'Plaquiste enduiseur', 'Plasticien', 'Plisseur', 'Poissonnier-traiteur', 'Pontonnier', 'Porion', 'Porteur de hottes', 'Porteur de journaux', 'Portier', 'Poseur de granit', 'Posticheur spectacle', 'Potier', 'Praticien dentaire', 'Praticiens médicaux', 'Premier clerc', 'Preneur de son', 'Primeuriste', 'Professeur d'italien', 'Projeteur béton armé', 'Promotion des ventes', 'Présentateur radio', 'Pyrotechnicien', 'Pédicure pour bovin', 'Pédologue', 'Pédopsychiatre', 'Quincaillier', 'Radio chargeur', 'Ramasseur d'asperges', 'Ramasseur d'endives', 'Ravaleur-ragréeur', 'Recherche', 'Recuiseur', 'Relieur-doreur', 'Responsable de salle', 'Responsable télécoms', 'Revenue Manager', 'Rippeur spectacle', 'Rogneur', 'Récupérateur', 'Rédacteur des débats', 'Régleur funéraire', 'Régleur sur tour', 'Sapeur-pompier', 'Scannériste', 'Scripte télévision', 'Sculpteur sur verre', 'Scénariste', 'Second de cuisine', 'Secrétaire juridique', 'Semencier', 'Sertisseur', 'Services funéraires', 'Solier-moquettiste', 'Sommelier', 'Sophrologue', 'Staffeur', 'Story boarder', 'Stratifieur', 'Stucateur', 'Styliste graphiste', 'Surjeteur-raseur', 'Séismologue', 'Technicien agricole', 'Technicien bovin', 'Technicien géomètre', 'Technicien plateau', 'Technicien énergie', 'Terminologue', 'Testeur informatique', 'Toiliste', 'Topographe', 'Toréro', 'Traducteur d'édition', 'Traffic manager', 'Trieur de métaux', 'Turbinier', 'Téléconseiller', 'Tôlier-traceur', 'Vendeur carreau', 'Vendeur en lingerie', 'Vendeur en meubles', 'Vendeur en épicerie', 'Verrier d'art', 'Verrier à la calotte', 'Verrier à la main', 'Verrier à main levée', 'Vidéo-jockey', 'Vitrier']
Tags
$noun
protected
static array<string|int, mixed>
$noun
= ['la sécurité', 'le plaisir', 'le confort', 'la simplicité', "l'assurance", "l'art", 'le pouvoir', 'le droit', 'la possibilité', "l'avantage", 'la liberté']
French nouns (used by the catch phrase format).
$siretNicFormats
protected
static mixed
$siretNicFormats
= ['####', '0###', '00#%']
$unique
protected
UniqueGenerator
$unique
$verb
protected
static array<string|int, mixed>
$verb
= ['de rouler', "d'avancer", "d'évoluer", 'de changer', "d'innover", 'de louer', "d'atteindre vos buts", 'de concrétiser vos projets']
French verbs (used by the catch phrase format).
$wordsWhichShouldNotAppearTwice
protected
static array<string|int, mixed>
$wordsWhichShouldNotAppearTwice
= ['sécurité', 'simpl']
An array containing string which should not appear twice in a catch phrase.
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 —catchPhrase()
Generates a french catch phrase.
public
catchPhrase() : string
Return values
string —catchPhraseAttribute()
Returns a random catch phrase attribute.
public
catchPhraseAttribute() : string
Return values
string —catchPhraseNoun()
Returns a random catch phrase noun.
public
catchPhraseNoun() : string
Return values
string —catchPhraseVerb()
Returns a random catch phrase verb.
public
catchPhraseVerb() : string
Return values
string —company()
public
company() : string
Tags
Return values
string —companySuffix()
public
static companySuffix() : string
Tags
Return values
string —jobTitle()
public
jobTitle() : 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 —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
siren()
Generates a siren number (9 digits) that passes the Luhn check.
public
static siren([mixed $formatted = true ]) : string
Parameters
- $formatted : mixed = true
Tags
Return values
string —siret()
Generates a siret number (14 digits) that passes the Luhn check.
public
siret([mixed $formatted = true ]) : string
Parameters
- $formatted : mixed = true
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
isCatchPhraseValid()
Validates a french catch phrase.
protected
static isCatchPhraseValid(string $catchPhrase) : bool
Parameters
- $catchPhrase : string
-
The catch phrase to validate.
Return values
bool —(true if valid, false otherwise)
replaceWildcard()
private
static replaceWildcard(mixed $string[, mixed $wildcard = '#' ][, mixed $callback = 'static::randomDigit' ]) : mixed
Parameters
- $string : mixed
- $wildcard : mixed = '#'
- $callback : mixed = 'static::randomDigit'