From 8423db001fe18ddeca3fb58eaeaaa1524b2ed5bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <danielmueller@limebird.de>
Date: Fri, 16 Oct 2015 17:27:51 +0200
Subject: [PATCH 1/4] added PHPDocs

---
 src/Faker/Calculator/Iban.php                |  6 ++-
 src/Faker/Calculator/Luhn.php                |  5 ++-
 src/Faker/DefaultGenerator.php               | 10 +++++
 src/Faker/Documentor.php                     |  6 +++
 src/Faker/Factory.php                        | 10 +++++
 src/Faker/Guesser/Name.php                   |  3 ++
 src/Faker/ORM/CakePHP/ColumnTypeGuesser.php  |  5 +++
 src/Faker/ORM/CakePHP/EntityPopulator.php    | 39 ++++++++++++++++++-
 src/Faker/ORM/CakePHP/Populator.php          | 29 ++++++++++++++
 src/Faker/ORM/Doctrine/ColumnTypeGuesser.php |  8 ++++
 src/Faker/ORM/Doctrine/EntityPopulator.php   | 40 ++++++++++++++++++++
 src/Faker/ORM/Doctrine/Populator.php         |  4 ++
 src/Faker/ORM/Mandango/ColumnTypeGuesser.php |  7 ++++
 src/Faker/ORM/Mandango/EntityPopulator.php   | 20 ++++++++++
 src/Faker/ORM/Mandango/Populator.php         |  4 ++
 src/Faker/ORM/Propel/ColumnTypeGuesser.php   |  7 ++++
 src/Faker/ORM/Propel/EntityPopulator.php     | 36 ++++++++++++++++++
 src/Faker/ORM/Propel/Populator.php           |  3 ++
 src/Faker/UniqueGenerator.php                |  4 ++
 19 files changed, 243 insertions(+), 3 deletions(-)

diff --git a/src/Faker/Calculator/Iban.php b/src/Faker/Calculator/Iban.php
index 99c0f0efc7..74a939050f 100644
--- a/src/Faker/Calculator/Iban.php
+++ b/src/Faker/Calculator/Iban.php
@@ -24,6 +24,10 @@ public static function checksum($iban)
         return str_pad($checksum, 2, '0', STR_PAD_LEFT);
     }
 
+    /**
+     * @param $match
+     * @return int
+     */
     private static function alphaToNumberCallback($match)
     {
         return self::alphaToNumber($match[0]);
@@ -44,7 +48,6 @@ public static function alphaToNumber($char)
      * Calculates mod97 on a numeric string
      *
      * @param string $number Numeric string
-     * @param int
      * @return int
      */
     public static function mod97($number)
@@ -59,6 +62,7 @@ public static function mod97($number)
     /**
      * Checks whether an IBAN has a valid checksum
      *
+     * @param $iban
      * @return boolean
      */
     public static function isValid($iban)
diff --git a/src/Faker/Calculator/Luhn.php b/src/Faker/Calculator/Luhn.php
index 4caad29fb3..6de929fc35 100644
--- a/src/Faker/Calculator/Luhn.php
+++ b/src/Faker/Calculator/Luhn.php
@@ -13,6 +13,7 @@
 class Luhn
 {
     /**
+     * @param $number
      * @return int
      */
     private static function checksum($number)
@@ -31,6 +32,7 @@ private static function checksum($number)
     }
 
     /**
+     * @param $partialNumber
      * @return string
      */
     public static function computeCheckDigit($partialNumber)
@@ -46,7 +48,8 @@ public static function computeCheckDigit($partialNumber)
     /**
      * Checks whether a number (partial number + check digit) is Luhn compliant
      *
-     * @return boolean
+     * @param $number
+     * @return bool
      */
     public static function isValid($number)
     {
diff --git a/src/Faker/DefaultGenerator.php b/src/Faker/DefaultGenerator.php
index 03e3d60d84..7f82e65632 100644
--- a/src/Faker/DefaultGenerator.php
+++ b/src/Faker/DefaultGenerator.php
@@ -10,16 +10,26 @@ class DefaultGenerator
 {
     protected $default;
 
+    /**
+     * @param $default
+     */
     public function __construct($default = null)
     {
         $this->default = $default;
     }
 
+    /**
+     * @param $attribute
+     */
     public function __get($attribute)
     {
         return $this->default;
     }
 
+    /**
+     * @param $method
+     * @param $attributes
+     */
     public function __call($method, $attributes)
     {
         return $this->default;
diff --git a/src/Faker/Documentor.php b/src/Faker/Documentor.php
index 216e208d19..e42bdf40d3 100644
--- a/src/Faker/Documentor.php
+++ b/src/Faker/Documentor.php
@@ -6,11 +6,17 @@ class Documentor
 {
     protected $generator;
 
+    /**
+     * @param Generator $generator
+     */
     public function __construct(Generator $generator)
     {
         $this->generator = $generator;
     }
 
+    /**
+     * @return array
+     */
     public function getFormatters()
     {
         $formatters = array();
diff --git a/src/Faker/Factory.php b/src/Faker/Factory.php
index 756539bd2b..460bf56eaf 100644
--- a/src/Faker/Factory.php
+++ b/src/Faker/Factory.php
@@ -25,6 +25,11 @@ public static function create($locale = self::DEFAULT_LOCALE)
         return $generator;
     }
 
+    /**
+     * @param $provider
+     * @param string $locale
+     * @return string
+     */
     protected static function getProviderClassname($provider, $locale = '')
     {
         if ($providerClass = self::findProviderClassname($provider, $locale)) {
@@ -41,6 +46,11 @@ protected static function getProviderClassname($provider, $locale = '')
         throw new \InvalidArgumentException(sprintf('Unable to find provider "%s" with locale "%s"', $provider, $locale));
     }
 
+    /**
+     * @param $provider
+     * @param string $locale
+     * @return string
+     */
     protected static function findProviderClassname($provider, $locale = '')
     {
         $providerClass = 'Faker\\' . ($locale ? sprintf('Provider\%s\%s', $locale, $provider) : sprintf('Provider\%s', $provider));
diff --git a/src/Faker/Guesser/Name.php b/src/Faker/Guesser/Name.php
index 856920f66d..0b303db160 100644
--- a/src/Faker/Guesser/Name.php
+++ b/src/Faker/Guesser/Name.php
@@ -8,6 +8,9 @@ class Name
 {
     protected $generator;
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
diff --git a/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php b/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php
index 0796c1690e..5fb49bdf8b 100644
--- a/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php
@@ -11,6 +11,11 @@ public function __construct(\Faker\Generator $generator)
         $this->generator = $generator;
     }
 
+    /**
+     * @param $column
+     * @param $table
+     * @return \Closure|null
+     */
     public function guessFormat($column, $table)
     {
         $generator = $this->generator;
diff --git a/src/Faker/ORM/CakePHP/EntityPopulator.php b/src/Faker/ORM/CakePHP/EntityPopulator.php
index b64a1de39e..20fdaa7dae 100644
--- a/src/Faker/ORM/CakePHP/EntityPopulator.php
+++ b/src/Faker/ORM/CakePHP/EntityPopulator.php
@@ -12,31 +12,52 @@ class EntityPopulator
     protected $columnFormatters = [];
     protected $modifiers = [];
 
+    /**
+     * @param $class
+     */
     public function __construct($class)
     {
         $this->class = $class;
     }
 
+    /**
+     * @param $name
+     * @return mixed
+     */
     public function __get($name)
     {
         return $this->{$name};
     }
 
+    /**
+     * @param $name
+     * @param $value
+     */
     public function __set($name, $value)
     {
         $this->{$name} = $value;
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
     }
 
+    /**
+     * @param $modifiers
+     */
     public function mergeModifiersWith($modifiers)
     {
         $this->modifiers = array_merge($this->modifiers, $modifiers);
     }
 
+    /**
+     * @param $populator
+     * @return array
+     */
     public function guessColumnFormatters($populator)
     {
         $formatters = [];
@@ -71,7 +92,10 @@ public function guessColumnFormatters($populator)
         return $formatters;
     }
 
-    public function guessModifiers($populator)
+    /**
+     * @return array
+     */
+    public function guessModifiers()
     {
         $modifiers = [];
         $table = $this->getTable($this->class);
@@ -109,6 +133,12 @@ public function guessModifiers($populator)
         return $modifiers;
     }
 
+    /**
+     * @param $class
+     * @param $insertedEntities
+     * @param array $options
+     * @return mixed
+     */
     public function execute($class, $insertedEntities, $options = [])
     {
         $table = $this->getTable($class);
@@ -136,11 +166,18 @@ public function execute($class, $insertedEntities, $options = [])
         return $entity->{$pk[0]};
     }
 
+    /**
+     * @param $name
+     */
     public function setConnection($name)
     {
         $this->connectionName = $name;
     }
 
+    /**
+     * @param $class
+     * @return mixed
+     */
     protected function getTable($class)
     {
         $options = [];
diff --git a/src/Faker/ORM/CakePHP/Populator.php b/src/Faker/ORM/CakePHP/Populator.php
index 4c42b28148..bfa0aa0814 100644
--- a/src/Faker/ORM/CakePHP/Populator.php
+++ b/src/Faker/ORM/CakePHP/Populator.php
@@ -10,21 +10,34 @@ class Populator
     protected $quantities = [];
     protected $guessers = [];
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
     }
 
+    /**
+     * @return \Faker\Generator
+     */
     public function getGenerator()
     {
         return $this->generator;
     }
 
+    /**
+     * @return array
+     */
     public function getGuessers()
     {
         return $this->guessers;
     }
 
+    /**
+     * @param $name
+     * @return $this
+     */
     public function removeGuesser($name)
     {
         if ($this->guessers[$name]) {
@@ -33,6 +46,11 @@ public function removeGuesser($name)
         return $this;
     }
 
+    /**
+     * @param $class
+     * @return $this
+     * @throws \Exception
+     */
     public function addGuesser($class)
     {
         if (!is_object($class)) {
@@ -47,6 +65,13 @@ public function addGuesser($class)
         return $this;
     }
 
+    /**
+     * @param $entity
+     * @param $number
+     * @param array $customColumnFormatters
+     * @param array $customModifiers
+     * @return $this
+     */
     public function addEntity($entity, $number, $customColumnFormatters = [], $customModifiers = [])
     {
         if (!$entity instanceof EntityPopulator) {
@@ -69,6 +94,10 @@ public function addEntity($entity, $number, $customColumnFormatters = [], $custo
         return $this;
     }
 
+    /**
+     * @param array $options
+     * @return array
+     */
     public function execute($options = [])
     {
         $insertedEntities = [];
diff --git a/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php b/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
index 899dc95b70..7978f74777 100644
--- a/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
@@ -8,11 +8,19 @@ class ColumnTypeGuesser
 {
     protected $generator;
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
     }
 
+    /**
+     * @param $fieldName
+     * @param ClassMetadata $class
+     * @return \Closure|null
+     */
     public function guessFormat($fieldName, ClassMetadata $class)
     {
         $generator = $this->generator;
diff --git a/src/Faker/ORM/Doctrine/EntityPopulator.php b/src/Faker/ORM/Doctrine/EntityPopulator.php
index 3eab1a2423..af73670654 100644
--- a/src/Faker/ORM/Doctrine/EntityPopulator.php
+++ b/src/Faker/ORM/Doctrine/EntityPopulator.php
@@ -42,36 +42,58 @@ public function getClass()
         return $this->class->getName();
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function setColumnFormatters($columnFormatters)
     {
         $this->columnFormatters = $columnFormatters;
     }
 
+    /**
+     * @return array
+     */
     public function getColumnFormatters()
     {
         return $this->columnFormatters;
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
     }
 
+    /**
+     * @param array $modifiers
+     */
     public function setModifiers(array $modifiers)
     {
         $this->modifiers = $modifiers;
     }
 
+    /**
+     * @return array
+     */
     public function getModifiers()
     {
         return $this->modifiers;
     }
 
+    /**
+     * @param array $modifiers
+     */
     public function mergeModifiersWith(array $modifiers)
     {
         $this->modifiers = array_merge($this->modifiers, $modifiers);
     }
 
+    /**
+     * @param \Faker\Generator $generator
+     * @return array
+     */
     public function guessColumnFormatters(\Faker\Generator $generator)
     {
         $formatters = array();
@@ -139,6 +161,10 @@ public function guessColumnFormatters(\Faker\Generator $generator)
 
     /**
      * Insert one new record using the Entity class.
+     * @param ObjectManager $manager
+     * @param $insertedEntities
+     * @param bool $generateId
+     * @return
      */
     public function execute(ObjectManager $manager, $insertedEntities, $generateId = false)
     {
@@ -160,6 +186,10 @@ public function execute(ObjectManager $manager, $insertedEntities, $generateId =
         return $obj;
     }
 
+    /**
+     * @param $obj
+     * @param $insertedEntities
+     */
     private function fillColumns($obj, $insertedEntities)
     {
         foreach ($this->columnFormatters as $field => $format) {
@@ -170,6 +200,10 @@ private function fillColumns($obj, $insertedEntities)
         }
     }
 
+    /**
+     * @param $obj
+     * @param $insertedEntities
+     */
     private function callMethods($obj, $insertedEntities)
     {
         foreach ($this->getModifiers() as $modifier) {
@@ -177,6 +211,12 @@ private function callMethods($obj, $insertedEntities)
         }
     }
 
+    /**
+     * @param $obj
+     * @param $column
+     * @param EntityManagerInterface $manager
+     * @return int|null
+     */
     private function generateId($obj, $column, EntityManagerInterface $manager)
     {
         /* @var $repository \Doctrine\ORM\EntityRepository */
diff --git a/src/Faker/ORM/Doctrine/Populator.php b/src/Faker/ORM/Doctrine/Populator.php
index 27114c03df..9bd483ba07 100644
--- a/src/Faker/ORM/Doctrine/Populator.php
+++ b/src/Faker/ORM/Doctrine/Populator.php
@@ -16,6 +16,10 @@ class Populator
     protected $quantities = array();
     protected $generateId = array();
 
+    /**
+     * @param \Faker\Generator $generator
+     * @param ObjectManager|null $manager
+     */
     public function __construct(\Faker\Generator $generator, ObjectManager $manager = null)
     {
         $this->generator = $generator;
diff --git a/src/Faker/ORM/Mandango/ColumnTypeGuesser.php b/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
index e64dc758f6..18f343fe4f 100644
--- a/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
@@ -6,11 +6,18 @@ class ColumnTypeGuesser
 {
     protected $generator;
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
     }
 
+    /**
+     * @param $field
+     * @return \Closure|null
+     */
     public function guessFormat($field)
     {
         $generator = $this->generator;
diff --git a/src/Faker/ORM/Mandango/EntityPopulator.php b/src/Faker/ORM/Mandango/EntityPopulator.php
index 061df77f66..fc8d01b4d4 100644
--- a/src/Faker/ORM/Mandango/EntityPopulator.php
+++ b/src/Faker/ORM/Mandango/EntityPopulator.php
@@ -23,26 +23,43 @@ public function __construct($class)
         $this->class = $class;
     }
 
+    /**
+     * @return string
+     */
     public function getClass()
     {
         return $this->class;
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function setColumnFormatters($columnFormatters)
     {
         $this->columnFormatters = $columnFormatters;
     }
 
+    /**
+     * @return array
+     */
     public function getColumnFormatters()
     {
         return $this->columnFormatters;
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
     }
 
+    /**
+     * @param \Faker\Generator $generator
+     * @param Mandango $mandango
+     * @return array
+     */
     public function guessColumnFormatters(\Faker\Generator $generator, Mandango $mandango)
     {
         $formatters = array();
@@ -82,6 +99,9 @@ public function guessColumnFormatters(\Faker\Generator $generator, Mandango $man
 
     /**
      * Insert one new record using the Entity class.
+     * @param Mandango $mandango
+     * @param $insertedEntities
+     * @return
      */
     public function execute(Mandango $mandango, $insertedEntities)
     {
diff --git a/src/Faker/ORM/Mandango/Populator.php b/src/Faker/ORM/Mandango/Populator.php
index 57a06a54b8..26736dc4d5 100644
--- a/src/Faker/ORM/Mandango/Populator.php
+++ b/src/Faker/ORM/Mandango/Populator.php
@@ -15,6 +15,10 @@ class Populator
     protected $entities = array();
     protected $quantities = array();
 
+    /**
+     * @param \Faker\Generator $generator
+     * @param Mandango $mandango
+     */
     public function __construct(\Faker\Generator $generator, Mandango $mandango)
     {
         $this->generator = $generator;
diff --git a/src/Faker/ORM/Propel/ColumnTypeGuesser.php b/src/Faker/ORM/Propel/ColumnTypeGuesser.php
index e4067687de..ac9cdb42ea 100644
--- a/src/Faker/ORM/Propel/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/Propel/ColumnTypeGuesser.php
@@ -9,11 +9,18 @@ class ColumnTypeGuesser
 {
     protected $generator;
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
     }
 
+    /**
+     * @param ColumnMap $column
+     * @return \Closure|null
+     */
     public function guessFormat(ColumnMap $column)
     {
         $generator = $this->generator;
diff --git a/src/Faker/ORM/Propel/EntityPopulator.php b/src/Faker/ORM/Propel/EntityPopulator.php
index 5af6810086..90246b7558 100644
--- a/src/Faker/ORM/Propel/EntityPopulator.php
+++ b/src/Faker/ORM/Propel/EntityPopulator.php
@@ -24,26 +24,42 @@ public function __construct($class)
         $this->class = $class;
     }
 
+    /**
+     * @return string
+     */
     public function getClass()
     {
         return $this->class;
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function setColumnFormatters($columnFormatters)
     {
         $this->columnFormatters = $columnFormatters;
     }
 
+    /**
+     * @return array
+     */
     public function getColumnFormatters()
     {
         return $this->columnFormatters;
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
     }
 
+    /**
+     * @param \Faker\Generator $generator
+     * @return array
+     */
     public function guessColumnFormatters(\Faker\Generator $generator)
     {
         $formatters = array();
@@ -80,6 +96,10 @@ public function guessColumnFormatters(\Faker\Generator $generator)
         return $formatters;
     }
 
+    /**
+     * @param ColumnMap $columnMap
+     * @return bool
+     */
     protected function isColumnBehavior(ColumnMap $columnMap)
     {
         foreach ($columnMap->getTable()->getBehaviors() as $name => $params) {
@@ -103,21 +123,34 @@ protected function isColumnBehavior(ColumnMap $columnMap)
         return false;
     }
 
+    /**
+     * @param $modifiers
+     */
     public function setModifiers($modifiers)
     {
         $this->modifiers = $modifiers;
     }
 
+    /**
+     * @return array
+     */
     public function getModifiers()
     {
         return $this->modifiers;
     }
 
+    /**
+     * @param $modifiers
+     */
     public function mergeModifiersWith($modifiers)
     {
         $this->modifiers = array_merge($this->modifiers, $modifiers);
     }
 
+    /**
+     * @param \Faker\Generator $generator
+     * @return array
+     */
     public function guessModifiers(\Faker\Generator $generator)
     {
         $modifiers = array();
@@ -151,6 +184,9 @@ public function guessModifiers(\Faker\Generator $generator)
 
     /**
      * Insert one new record using the Entity class.
+     * @param $con
+     * @param $insertedEntities
+     * @return
      */
     public function execute($con, $insertedEntities)
     {
diff --git a/src/Faker/ORM/Propel/Populator.php b/src/Faker/ORM/Propel/Populator.php
index 067229bc02..4285727805 100644
--- a/src/Faker/ORM/Propel/Populator.php
+++ b/src/Faker/ORM/Propel/Populator.php
@@ -12,6 +12,9 @@ class Populator
     protected $entities = array();
     protected $quantities = array();
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
diff --git a/src/Faker/UniqueGenerator.php b/src/Faker/UniqueGenerator.php
index 335882dd4d..4bfe2fa6d2 100644
--- a/src/Faker/UniqueGenerator.php
+++ b/src/Faker/UniqueGenerator.php
@@ -12,6 +12,10 @@ class UniqueGenerator
     protected $maxRetries;
     protected $uniques = array();
 
+    /**
+     * @param Generator $generator
+     * @param $maxRetries
+     */
     public function __construct(Generator $generator, $maxRetries)
     {
         $this->generator = $generator;

From a86e6950dcbec098bbc93779e475f6bdb119b25f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <danielmueller@limebird.de>
Date: Fri, 16 Oct 2015 18:09:04 +0200
Subject: [PATCH 2/4] removed unnecessary PHPDocs, added some types to
 remaining

---
 src/Faker/Calculator/Iban.php                |  3 +--
 src/Faker/Calculator/Luhn.php                |  4 +--
 src/Faker/DefaultGenerator.php               |  6 ++---
 src/Faker/Factory.php                        |  2 --
 src/Faker/Generator.php                      |  7 ++++++
 src/Faker/ORM/CakePHP/ColumnTypeGuesser.php  |  2 --
 src/Faker/ORM/CakePHP/EntityPopulator.php    | 26 ++------------------
 src/Faker/ORM/CakePHP/Populator.php          |  6 +----
 src/Faker/ORM/Doctrine/ColumnTypeGuesser.php |  1 -
 src/Faker/ORM/Doctrine/EntityPopulator.php   | 16 +-----------
 src/Faker/ORM/Doctrine/Populator.php         |  2 +-
 src/Faker/ORM/Mandango/ColumnTypeGuesser.php |  1 -
 src/Faker/ORM/Mandango/EntityPopulator.php   |  8 ------
 src/Faker/ORM/Propel/EntityPopulator.php     |  3 ---
 src/Faker/UniqueGenerator.php                |  3 +++
 15 files changed, 21 insertions(+), 69 deletions(-)

diff --git a/src/Faker/Calculator/Iban.php b/src/Faker/Calculator/Iban.php
index 74a939050f..ee2c459139 100644
--- a/src/Faker/Calculator/Iban.php
+++ b/src/Faker/Calculator/Iban.php
@@ -25,7 +25,6 @@ public static function checksum($iban)
     }
 
     /**
-     * @param $match
      * @return int
      */
     private static function alphaToNumberCallback($match)
@@ -62,7 +61,7 @@ public static function mod97($number)
     /**
      * Checks whether an IBAN has a valid checksum
      *
-     * @param $iban
+     * @param string $iban
      * @return boolean
      */
     public static function isValid($iban)
diff --git a/src/Faker/Calculator/Luhn.php b/src/Faker/Calculator/Luhn.php
index 6de929fc35..f0a86023d5 100644
--- a/src/Faker/Calculator/Luhn.php
+++ b/src/Faker/Calculator/Luhn.php
@@ -13,7 +13,7 @@
 class Luhn
 {
     /**
-     * @param $number
+     * @param string $number
      * @return int
      */
     private static function checksum($number)
@@ -48,7 +48,7 @@ public static function computeCheckDigit($partialNumber)
     /**
      * Checks whether a number (partial number + check digit) is Luhn compliant
      *
-     * @param $number
+     * @param string $number
      * @return bool
      */
     public static function isValid($number)
diff --git a/src/Faker/DefaultGenerator.php b/src/Faker/DefaultGenerator.php
index 7f82e65632..f5d8153866 100644
--- a/src/Faker/DefaultGenerator.php
+++ b/src/Faker/DefaultGenerator.php
@@ -19,7 +19,7 @@ public function __construct($default = null)
     }
 
     /**
-     * @param $attribute
+     * @param string $attribute
      */
     public function __get($attribute)
     {
@@ -27,8 +27,8 @@ public function __get($attribute)
     }
 
     /**
-     * @param $method
-     * @param $attributes
+     * @param string $method
+     * @param array $attributes
      */
     public function __call($method, $attributes)
     {
diff --git a/src/Faker/Factory.php b/src/Faker/Factory.php
index 460bf56eaf..6264504b61 100644
--- a/src/Faker/Factory.php
+++ b/src/Faker/Factory.php
@@ -26,7 +26,6 @@ public static function create($locale = self::DEFAULT_LOCALE)
     }
 
     /**
-     * @param $provider
      * @param string $locale
      * @return string
      */
@@ -47,7 +46,6 @@ protected static function getProviderClassname($provider, $locale = '')
     }
 
     /**
-     * @param $provider
      * @param string $locale
      * @return string
      */
diff --git a/src/Faker/Generator.php b/src/Faker/Generator.php
index 3378797360..9316a132d2 100644
--- a/src/Faker/Generator.php
+++ b/src/Faker/Generator.php
@@ -228,11 +228,18 @@ protected function callFormatWithMatches($matches)
         return $this->format($matches[1]);
     }
 
+    /**
+     * @param string $attribute
+     */
     public function __get($attribute)
     {
         return $this->format($attribute);
     }
 
+    /**
+     * @param string $method
+     * @param array $attributes
+     */
     public function __call($method, $attributes)
     {
         return $this->format($method, $attributes);
diff --git a/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php b/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php
index 5fb49bdf8b..78412e84c5 100644
--- a/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/CakePHP/ColumnTypeGuesser.php
@@ -12,8 +12,6 @@ public function __construct(\Faker\Generator $generator)
     }
 
     /**
-     * @param $column
-     * @param $table
      * @return \Closure|null
      */
     public function guessFormat($column, $table)
diff --git a/src/Faker/ORM/CakePHP/EntityPopulator.php b/src/Faker/ORM/CakePHP/EntityPopulator.php
index 20fdaa7dae..2873b406c1 100644
--- a/src/Faker/ORM/CakePHP/EntityPopulator.php
+++ b/src/Faker/ORM/CakePHP/EntityPopulator.php
@@ -12,17 +12,13 @@ class EntityPopulator
     protected $columnFormatters = [];
     protected $modifiers = [];
 
-    /**
-     * @param $class
-     */
     public function __construct($class)
     {
         $this->class = $class;
     }
 
     /**
-     * @param $name
-     * @return mixed
+     * @param string $name
      */
     public function __get($name)
     {
@@ -30,32 +26,24 @@ public function __get($name)
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
      */
     public function __set($name, $value)
     {
         $this->{$name} = $value;
     }
 
-    /**
-     * @param $columnFormatters
-     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
     }
 
-    /**
-     * @param $modifiers
-     */
     public function mergeModifiersWith($modifiers)
     {
         $this->modifiers = array_merge($this->modifiers, $modifiers);
     }
 
     /**
-     * @param $populator
      * @return array
      */
     public function guessColumnFormatters($populator)
@@ -134,10 +122,7 @@ public function guessModifiers()
     }
 
     /**
-     * @param $class
-     * @param $insertedEntities
      * @param array $options
-     * @return mixed
      */
     public function execute($class, $insertedEntities, $options = [])
     {
@@ -166,18 +151,11 @@ public function execute($class, $insertedEntities, $options = [])
         return $entity->{$pk[0]};
     }
 
-    /**
-     * @param $name
-     */
     public function setConnection($name)
     {
         $this->connectionName = $name;
     }
 
-    /**
-     * @param $class
-     * @return mixed
-     */
     protected function getTable($class)
     {
         $options = [];
diff --git a/src/Faker/ORM/CakePHP/Populator.php b/src/Faker/ORM/CakePHP/Populator.php
index bfa0aa0814..9744d30d0f 100644
--- a/src/Faker/ORM/CakePHP/Populator.php
+++ b/src/Faker/ORM/CakePHP/Populator.php
@@ -35,7 +35,6 @@ public function getGuessers()
     }
 
     /**
-     * @param $name
      * @return $this
      */
     public function removeGuesser($name)
@@ -47,7 +46,6 @@ public function removeGuesser($name)
     }
 
     /**
-     * @param $class
      * @return $this
      * @throws \Exception
      */
@@ -66,13 +64,11 @@ public function addGuesser($class)
     }
 
     /**
-     * @param $entity
-     * @param $number
      * @param array $customColumnFormatters
      * @param array $customModifiers
      * @return $this
      */
-    public function addEntity($entity, $number, $customColumnFormatters = [], $customModifiers = [])
+    public function addEntEntityPopulatority($entity, $number, $customColumnFormatters = [], $customModifiers = [])
     {
         if (!$entity instanceof EntityPopulator) {
             $entity = new EntityPopulator($entity);
diff --git a/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php b/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
index 7978f74777..824f8c034a 100644
--- a/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
@@ -17,7 +17,6 @@ public function __construct(\Faker\Generator $generator)
     }
 
     /**
-     * @param $fieldName
      * @param ClassMetadata $class
      * @return \Closure|null
      */
diff --git a/src/Faker/ORM/Doctrine/EntityPopulator.php b/src/Faker/ORM/Doctrine/EntityPopulator.php
index af73670654..13e22086f9 100644
--- a/src/Faker/ORM/Doctrine/EntityPopulator.php
+++ b/src/Faker/ORM/Doctrine/EntityPopulator.php
@@ -58,9 +58,6 @@ public function getColumnFormatters()
         return $this->columnFormatters;
     }
 
-    /**
-     * @param $columnFormatters
-     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
@@ -162,9 +159,8 @@ public function guessColumnFormatters(\Faker\Generator $generator)
     /**
      * Insert one new record using the Entity class.
      * @param ObjectManager $manager
-     * @param $insertedEntities
      * @param bool $generateId
-     * @return
+     * @return EntityPopulator
      */
     public function execute(ObjectManager $manager, $insertedEntities, $generateId = false)
     {
@@ -186,10 +182,6 @@ public function execute(ObjectManager $manager, $insertedEntities, $generateId =
         return $obj;
     }
 
-    /**
-     * @param $obj
-     * @param $insertedEntities
-     */
     private function fillColumns($obj, $insertedEntities)
     {
         foreach ($this->columnFormatters as $field => $format) {
@@ -200,10 +192,6 @@ private function fillColumns($obj, $insertedEntities)
         }
     }
 
-    /**
-     * @param $obj
-     * @param $insertedEntities
-     */
     private function callMethods($obj, $insertedEntities)
     {
         foreach ($this->getModifiers() as $modifier) {
@@ -212,8 +200,6 @@ private function callMethods($obj, $insertedEntities)
     }
 
     /**
-     * @param $obj
-     * @param $column
      * @param EntityManagerInterface $manager
      * @return int|null
      */
diff --git a/src/Faker/ORM/Doctrine/Populator.php b/src/Faker/ORM/Doctrine/Populator.php
index 9bd483ba07..d4fe897c61 100644
--- a/src/Faker/ORM/Doctrine/Populator.php
+++ b/src/Faker/ORM/Doctrine/Populator.php
@@ -55,7 +55,7 @@ public function addEntity($entity, $number, $customColumnFormatters = array(), $
     /**
      * Populate the database using all the Entity classes previously added.
      *
-     * @param EntityManager $entityManager A Doctrine connection object
+     * @param null|EntityManager $entityManager A Doctrine connection object
      *
      * @return array A list of the inserted PKs
      */
diff --git a/src/Faker/ORM/Mandango/ColumnTypeGuesser.php b/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
index 18f343fe4f..d318b0aa09 100644
--- a/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
+++ b/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
@@ -15,7 +15,6 @@ public function __construct(\Faker\Generator $generator)
     }
 
     /**
-     * @param $field
      * @return \Closure|null
      */
     public function guessFormat($field)
diff --git a/src/Faker/ORM/Mandango/EntityPopulator.php b/src/Faker/ORM/Mandango/EntityPopulator.php
index fc8d01b4d4..667f5bec36 100644
--- a/src/Faker/ORM/Mandango/EntityPopulator.php
+++ b/src/Faker/ORM/Mandango/EntityPopulator.php
@@ -31,9 +31,6 @@ public function getClass()
         return $this->class;
     }
 
-    /**
-     * @param $columnFormatters
-     */
     public function setColumnFormatters($columnFormatters)
     {
         $this->columnFormatters = $columnFormatters;
@@ -47,9 +44,6 @@ public function getColumnFormatters()
         return $this->columnFormatters;
     }
 
-    /**
-     * @param $columnFormatters
-     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
@@ -100,8 +94,6 @@ public function guessColumnFormatters(\Faker\Generator $generator, Mandango $man
     /**
      * Insert one new record using the Entity class.
      * @param Mandango $mandango
-     * @param $insertedEntities
-     * @return
      */
     public function execute(Mandango $mandango, $insertedEntities)
     {
diff --git a/src/Faker/ORM/Propel/EntityPopulator.php b/src/Faker/ORM/Propel/EntityPopulator.php
index 90246b7558..182dbc7c18 100644
--- a/src/Faker/ORM/Propel/EntityPopulator.php
+++ b/src/Faker/ORM/Propel/EntityPopulator.php
@@ -184,9 +184,6 @@ public function guessModifiers(\Faker\Generator $generator)
 
     /**
      * Insert one new record using the Entity class.
-     * @param $con
-     * @param $insertedEntities
-     * @return
      */
     public function execute($con, $insertedEntities)
     {
diff --git a/src/Faker/UniqueGenerator.php b/src/Faker/UniqueGenerator.php
index 4bfe2fa6d2..8e7727ccaa 100644
--- a/src/Faker/UniqueGenerator.php
+++ b/src/Faker/UniqueGenerator.php
@@ -24,6 +24,7 @@ public function __construct(Generator $generator, $maxRetries)
 
     /**
      * Catch and proxy all generator calls but return only unique values
+     * @param string $attribute
      */
     public function __get($attribute)
     {
@@ -32,6 +33,8 @@ public function __get($attribute)
 
     /**
      * Catch and proxy all generator calls with arguments but return only unique values
+     * @param string $name
+     * @param array $arguments
      */
     public function __call($name, $arguments)
     {

From d60ccf6a560c6ca76951f60d29ef5177f98a8aff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <danielmueller@limebird.de>
Date: Fri, 16 Oct 2015 18:16:15 +0200
Subject: [PATCH 3/4] removed some more param annotations without type

---
 src/Faker/DefaultGenerator.php           |  3 ---
 src/Faker/ORM/Propel/EntityPopulator.php | 12 ------------
 src/Faker/UniqueGenerator.php            |  1 -
 3 files changed, 16 deletions(-)

diff --git a/src/Faker/DefaultGenerator.php b/src/Faker/DefaultGenerator.php
index f5d8153866..4210f93fef 100644
--- a/src/Faker/DefaultGenerator.php
+++ b/src/Faker/DefaultGenerator.php
@@ -10,9 +10,6 @@ class DefaultGenerator
 {
     protected $default;
 
-    /**
-     * @param $default
-     */
     public function __construct($default = null)
     {
         $this->default = $default;
diff --git a/src/Faker/ORM/Propel/EntityPopulator.php b/src/Faker/ORM/Propel/EntityPopulator.php
index 182dbc7c18..7c0b112a56 100644
--- a/src/Faker/ORM/Propel/EntityPopulator.php
+++ b/src/Faker/ORM/Propel/EntityPopulator.php
@@ -32,9 +32,6 @@ public function getClass()
         return $this->class;
     }
 
-    /**
-     * @param $columnFormatters
-     */
     public function setColumnFormatters($columnFormatters)
     {
         $this->columnFormatters = $columnFormatters;
@@ -48,9 +45,6 @@ public function getColumnFormatters()
         return $this->columnFormatters;
     }
 
-    /**
-     * @param $columnFormatters
-     */
     public function mergeColumnFormattersWith($columnFormatters)
     {
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
@@ -123,9 +117,6 @@ protected function isColumnBehavior(ColumnMap $columnMap)
         return false;
     }
 
-    /**
-     * @param $modifiers
-     */
     public function setModifiers($modifiers)
     {
         $this->modifiers = $modifiers;
@@ -139,9 +130,6 @@ public function getModifiers()
         return $this->modifiers;
     }
 
-    /**
-     * @param $modifiers
-     */
     public function mergeModifiersWith($modifiers)
     {
         $this->modifiers = array_merge($this->modifiers, $modifiers);
diff --git a/src/Faker/UniqueGenerator.php b/src/Faker/UniqueGenerator.php
index 8e7727ccaa..536f0dbf83 100644
--- a/src/Faker/UniqueGenerator.php
+++ b/src/Faker/UniqueGenerator.php
@@ -14,7 +14,6 @@ class UniqueGenerator
 
     /**
      * @param Generator $generator
-     * @param $maxRetries
      */
     public function __construct(Generator $generator, $maxRetries)
     {

From 0077ef843652e46f4acc4e8f2c204c32bbe3c437 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <danielmueller@limebird.de>
Date: Sun, 18 Oct 2015 15:11:44 +0200
Subject: [PATCH 4/4] added type annotation

---
 src/Faker/Factory.php | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/Faker/Factory.php b/src/Faker/Factory.php
index 6264504b61..e02bc7d2bb 100644
--- a/src/Faker/Factory.php
+++ b/src/Faker/Factory.php
@@ -26,6 +26,7 @@ public static function create($locale = self::DEFAULT_LOCALE)
     }
 
     /**
+     * @param string $provider
      * @param string $locale
      * @return string
      */
@@ -46,6 +47,7 @@ protected static function getProviderClassname($provider, $locale = '')
     }
 
     /**
+     * @param string $provider
      * @param string $locale
      * @return string
      */