added PHPDocs, removed unused variable

src/Faker/Calculator/Iban.php

@@ -24,6 +24,9 @@ public static function checksum($iban)
         return str_pad($checksum, 2, '0', STR_PAD_LEFT);
     }
 
+    /**
+     * @return int
+     */
     private static function alphaToNumberCallback($match)
     {
         return self::alphaToNumber($match[0]);
@@ -44,7 +47,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 +61,7 @@ public static function mod97($number)
     /**
      * Checks whether an IBAN has a valid checksum
      *
+     * @param string $iban
      * @return boolean
      */
     public static function isValid($iban)

src/Faker/Calculator/Luhn.php

@@ -13,6 +13,7 @@
 class Luhn
 {
     /**
+     * @param string $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 string $number
+     * @return bool
      */
     public static function isValid($number)
     {

src/Faker/DefaultGenerator.php

@@ -15,11 +15,18 @@ public function __construct($default = null)
         $this->default = $default;
     }
 
+    /**
+     * @param string $attribute
+     */
     public function __get($attribute)
     {
         return $this->default;
     }
 
+    /**
+     * @param string $method
+     * @param array $attributes
+     */
     public function __call($method, $attributes)
     {
         return $this->default;

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();

src/Faker/Factory.php

@@ -25,6 +25,10 @@ public static function create($locale = self::DEFAULT_LOCALE)
         return $generator;
     }
 
+    /**
+     * @param string $locale
+     * @return string
+     */
     protected static function getProviderClassname($provider, $locale = '')
     {
         if ($providerClass = self::findProviderClassname($provider, $locale)) {
@@ -41,6 +45,10 @@ protected static function getProviderClassname($provider, $locale = '')
         throw new \InvalidArgumentException(sprintf('Unable to find provider "%s" with locale "%s"', $provider, $locale));
     }
 
+    /**
+     * @param string $locale
+     * @return string
+     */
     protected static function findProviderClassname($provider, $locale = '')
     {
         $providerClass = 'Faker\\' . ($locale ? sprintf('Provider\%s\%s', $locale, $provider) : sprintf('Provider\%s', $provider));

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);

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;

src/Faker/ORM/CakePHP/ColumnTypeGuesser.php

@@ -11,6 +11,9 @@ public function __construct(\Faker\Generator $generator)
         $this->generator = $generator;
     }
 
+    /**
+     * @return \Closure|null
+     */
     public function guessFormat($column, $table)
     {
         $generator = $this->generator;

src/Faker/ORM/CakePHP/EntityPopulator.php

@@ -17,11 +17,17 @@ public function __construct($class)
         $this->class = $class;
     }
 
+    /**
+     * @param string $name
+     */
     public function __get($name)
     {
         return $this->{$name};
     }
 
+    /**
+     * @param string $name
+     */
     public function __set($name, $value)
     {
         $this->{$name} = $value;
@@ -37,6 +43,9 @@ public function mergeModifiersWith($modifiers)
         $this->modifiers = array_merge($this->modifiers, $modifiers);
     }
 
+    /**
+     * @return array
+     */
     public function guessColumnFormatters($populator)
     {
         $formatters = [];
@@ -71,7 +80,10 @@ public function guessColumnFormatters($populator)
         return $formatters;
     }
 
-    public function guessModifiers($populator)
+    /**
+     * @return array
+     */
+    public function guessModifiers()
     {
         $modifiers = [];
         $table = $this->getTable($this->class);
@@ -109,6 +121,9 @@ public function guessModifiers($populator)
         return $modifiers;
     }
 
+    /**
+     * @param array $options
+     */
     public function execute($class, $insertedEntities, $options = [])
     {
         $table = $this->getTable($class);

src/Faker/ORM/CakePHP/Populator.php

@@ -10,21 +10,33 @@ 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;
     }
 
+    /**
+     * @return $this
+     */
     public function removeGuesser($name)
     {
         if ($this->guessers[$name]) {
@@ -33,6 +45,10 @@ public function removeGuesser($name)
         return $this;
     }
 
+    /**
+     * @return $this
+     * @throws \Exception
+     */
     public function addGuesser($class)
     {
         if (!is_object($class)) {
@@ -47,7 +63,12 @@ public function addGuesser($class)
         return $this;
     }
 
-    public function addEntity($entity, $number, $customColumnFormatters = [], $customModifiers = [])
+    /**
+     * @param array $customColumnFormatters
+     * @param array $customModifiers
+     * @return $this
+     */
+    public function addEntEntityPopulatority($entity, $number, $customColumnFormatters = [], $customModifiers = [])
     {
         if (!$entity instanceof EntityPopulator) {
             $entity = new EntityPopulator($entity);
@@ -69,6 +90,10 @@ public function addEntity($entity, $number, $customColumnFormatters = [], $custo
         return $this;
     }
 
+    /**
+     * @param array $options
+     * @return array
+     */
     public function execute($options = [])
     {
         $insertedEntities = [];

src/Faker/ORM/Doctrine/ColumnTypeGuesser.php

@@ -8,11 +8,18 @@ class ColumnTypeGuesser
 {
     protected $generator;
 
+    /**
+     * @param \Faker\Generator $generator
+     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
     }
 
+    /**
+     * @param ClassMetadata $class
+     * @return \Closure|null
+     */
     public function guessFormat($fieldName, ClassMetadata $class)
     {
         $generator = $this->generator;

src/Faker/ORM/Doctrine/EntityPopulator.php

@@ -42,11 +42,17 @@ public function getClass()
         return $this->class->getName();
     }
 
+    /**
+     * @param $columnFormatters
+     */
     public function setColumnFormatters($columnFormatters)
     {
         $this->columnFormatters = $columnFormatters;
     }
 
+    /**
+     * @return array
+     */
     public function getColumnFormatters()
     {
         return $this->columnFormatters;
@@ -57,21 +63,34 @@ 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 +158,9 @@ public function guessColumnFormatters(\Faker\Generator $generator)
 
     /**
      * Insert one new record using the Entity class.
+     * @param ObjectManager $manager
+     * @param bool $generateId
+     * @return EntityPopulator
      */
     public function execute(ObjectManager $manager, $insertedEntities, $generateId = false)
     {
@@ -177,6 +199,10 @@ private function callMethods($obj, $insertedEntities)
         }
     }
 
+    /**
+     * @param EntityManagerInterface $manager
+     * @return int|null
+     */
     private function generateId($obj, $column, EntityManagerInterface $manager)
     {
         /* @var $repository \Doctrine\ORM\EntityRepository */

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;
@@ -51,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
      */