PHP Class Faker\Provider\fr_FR\Company

Inheritance: extends Faker\Provider\Company
Show file Open project: fzaninotto/faker Class Usage Examples

Protected Properties

Property Type Description
$attribute End of sentences (used by the catch phrase format).
$catchPhraseFormats French catch phrase formats.
$companySuffix Company suffixes.
$formats French company name formats.
$jobTitleFormat
$noun French nouns (used by the catch phrase format).
$siretNicFormats
$verb French verbs (used by the catch phrase format).
$wordsWhichShouldNotAppearTwice An array containing string which should not appear twice in a catch phrase.

Public Methods

Method Description
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.
siren ( $formatted = true ) : string Generates a siren number (9 digits) that passes the Luhn check.
siret ( $formatted = true ) : string Generates a siret number (14 digits) that passes the Luhn check.

Protected Methods

Method Description
isCatchPhraseValid ( string $catchPhrase ) : boolean Validates a french catch phrase.

Method Details

catchPhrase() public method

Generates a french catch phrase.
public catchPhrase ( ) : string
return string

catchPhraseAttribute() public method

Returns a random catch phrase attribute.
public catchPhraseAttribute ( ) : string
return string

catchPhraseNoun() public method

Returns a random catch phrase noun.
public catchPhraseNoun ( ) : string
return string

catchPhraseVerb() public method

Returns a random catch phrase verb.
public catchPhraseVerb ( ) : string
return string

isCatchPhraseValid() protected static method

Validates a french catch phrase.
protected static isCatchPhraseValid ( string $catchPhrase ) : boolean
$catchPhrase string The catch phrase to validate.
return boolean (true if valid, false otherwise)

siren() public method

Generates a siren number (9 digits) that passes the Luhn check.
See also: http://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_entreprises
public siren ( $formatted = true ) : string
return string

siret() public method

Generates a siret number (14 digits) that passes the Luhn check.
See also: http://fr.wikipedia.org/wiki/Syst%C3%A8me_d'identification_du_r%C3%A9pertoire_des_%C3%A9tablissements
public siret ( $formatted = true ) : string
return string

Property Details

$attribute protected static property

End of sentences (used by the catch phrase format).
protected static $attribute

$catchPhraseFormats protected static property

French catch phrase formats.
protected static $catchPhraseFormats

$companySuffix protected static property

Company suffixes.
protected static $companySuffix

$formats protected static property

French company name formats.
protected static $formats

$jobTitleFormat protected static property

protected static $jobTitleFormat

$noun protected static property

French nouns (used by the catch phrase format).
protected static $noun

$siretNicFormats protected static property

protected static $siretNicFormats

$verb protected static property

French verbs (used by the catch phrase format).
protected static $verb

$wordsWhichShouldNotAppearTwice protected static property

An array containing string which should not appear twice in a catch phrase.
protected static $wordsWhichShouldNotAppearTwice