README.md - Generates a random NIR number

fzaninotto · Dec 17, 2016 · 12a62fd · 12a62fd
1 parent a2aa4d8
commit 12a62fd
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/readme.md b/readme.md
@@ -991,6 +991,15 @@ echo $faker->siren; // 082 250 104
 echo $faker->siret; // 347 355 708 00224
 ```
 
+### `Faker\Provider\fr_FR\Person`
+
+```php
+<?php
+
+// Generates a random NIR / Sécurité Sociale number
+echo $faker->nir; // 1 88 07 35 127 571 - 19
+```
+
 ### `Faker\Provider\he_IL\Payment`
 
 ```php

diff --git a/src/Faker/Provider/fr_FR/Person.php b/src/Faker/Provider/fr_FR/Person.php
@@ -69,7 +69,7 @@ public static function prefix()
     }
 
     /**
-     * Generates a NIR number (13 digits + 2 digits for the key)
+     * Generates a NIR / Sécurité Sociale number (13 digits + 2 digits for the key)
      *
      * @see https://fr.wikipedia.org/wiki/Num%C3%A9ro_de_s%C3%A9curit%C3%A9_sociale_en_France
      * @return string
@@ -102,7 +102,7 @@ public function nir($gender = null, $formatted = false)
             $nir .= $this->numerify('##');
         }
 
-        // Born number (dependending of town and month of birth)
+        // Born number (depending of town and month of birth)
         $nir .= $this->numerify('###');
 
         /**