removed unnecessary PHPDocs, added some types to remaining

daniel-mueller · daniel-mueller · commit a86e6950dcbe · 2015-10-16T18:09:04.000+02:00
diff --git 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
@@ -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
@@ -19,16 +19,16 @@ public function __construct($default = null)
     }
 
     /**
-     * @param $attribute
+     * @param string $attribute
      */
     public function __get($attribute)
     {
         return $this->default;
     }
 
     /**
-     * @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
@@ -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
@@ -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
@@ -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
@@ -12,50 +12,38 @@ 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)
     {
         return $this->{$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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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)
     {

Original file line number	Diff line number	Diff line change
`@@ -19,16 +19,16 @@ public function __construct($default = null)`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * @param $attribute`
	`22`	`+ * @param string $attribute`
`23`	`23`	`*/`
`24`	`24`	`public function __get($attribute)`
`25`	`25`	`{`
`26`	`26`	`return $this->default;`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * @param $method`
`31`		`- * @param $attributes`
	`30`	`+ * @param string $method`
	`31`	`+ * @param array $attributes`
`32`	`32`	`*/`
`33`	`33`	`public function __call($method, $attributes)`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,6 @@ public static function create($locale = self::DEFAULT_LOCALE)`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * @param $provider`
`30`	`29`	`* @param string $locale`
`31`	`30`	`* @return string`
`32`	`31`	`*/`
`@@ -47,7 +46,6 @@ protected static function getProviderClassname($provider, $locale = '')`
`47`	`46`	`}`
`48`	`47`
`49`	`48`	`/**`
`50`		`- * @param $provider`
`51`	`49`	`* @param string $locale`
`52`	`50`	`* @return string`
`53`	`51`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -228,11 +228,18 @@ protected function callFormatWithMatches($matches)`
`228`	`228`	`return $this->format($matches[1]);`
`229`	`229`	`}`
`230`	`230`
	`231`	`+ /**`
	`232`	`+ * @param string $attribute`
	`233`	`+ */`
`231`	`234`	`public function __get($attribute)`
`232`	`235`	`{`
`233`	`236`	`return $this->format($attribute);`
`234`	`237`	`}`
`235`	`238`
	`239`	`+ /**`
	`240`	`+ * @param string $method`
	`241`	`+ * @param array $attributes`
	`242`	`+ */`
`236`	`243`	`public function __call($method, $attributes)`
`237`	`244`	`{`
`238`	`245`	`return $this->format($method, $attributes);`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,6 @@ public function __construct(\Faker\Generator $generator)`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * @param $column`
`16`		`- * @param $table`
`17`	`15`	`* @return \Closure\|null`
`18`	`16`	`*/`
`19`	`17`	`public function guessFormat($column, $table)`
Original file line number	Diff line number	Diff line change
`@@ -12,50 +12,38 @@ class EntityPopulator`
`12`	`12`	`protected $columnFormatters = [];`
`13`	`13`	`protected $modifiers = [];`
`14`	`14`
`15`		`- /**`
`16`		`- * @param $class`
`17`		`- */`
`18`	`15`	`public function __construct($class)`
`19`	`16`	`{`
`20`	`17`	`$this->class = $class;`
`21`	`18`	`}`
`22`	`19`
`23`	`20`	`/**`
`24`		`- * @param $name`
`25`		`- * @return mixed`
	`21`	`+ * @param string $name`
`26`	`22`	`*/`
`27`	`23`	`public function __get($name)`
`28`	`24`	`{`
`29`	`25`	`return $this->{$name};`
`30`	`26`	`}`
`31`	`27`
`32`	`28`	`/**`
`33`		`- * @param $name`
`34`		`- * @param $value`
	`29`	`+ * @param string $name`
`35`	`30`	`*/`
`36`	`31`	`public function __set($name, $value)`
`37`	`32`	`{`
`38`	`33`	`$this->{$name} = $value;`
`39`	`34`	`}`
`40`	`35`
`41`		`- /**`
`42`		`- * @param $columnFormatters`
`43`		`- */`
`44`	`36`	`public function mergeColumnFormattersWith($columnFormatters)`
`45`	`37`	`{`
`46`	`38`	`$this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);`
`47`	`39`	`}`
`48`	`40`
`49`		`- /**`
`50`		`- * @param $modifiers`
`51`		`- */`
`52`	`41`	`public function mergeModifiersWith($modifiers)`
`53`	`42`	`{`
`54`	`43`	`$this->modifiers = array_merge($this->modifiers, $modifiers);`
`55`	`44`	`}`
`56`	`45`
`57`	`46`	`/**`
`58`		`- * @param $populator`
`59`	`47`	`* @return array`
`60`	`48`	`*/`
`61`	`49`	`public function guessColumnFormatters($populator)`
`@@ -134,10 +122,7 @@ public function guessModifiers()`
`134`	`122`	`}`
`135`	`123`
`136`	`124`	`/**`
`137`		`- * @param $class`
`138`		`- * @param $insertedEntities`
`139`	`125`	`* @param array $options`
`140`		`- * @return mixed`
`141`	`126`	`*/`
`142`	`127`	`public function execute($class, $insertedEntities, $options = [])`
`143`	`128`	`{`
`@@ -166,18 +151,11 @@ public function execute($class, $insertedEntities, $options = [])`
`166`	`151`	`return $entity->{$pk[0]};`
`167`	`152`	`}`
`168`	`153`
`169`		`- /**`
`170`		`- * @param $name`
`171`		`- */`
`172`	`154`	`public function setConnection($name)`
`173`	`155`	`{`
`174`	`156`	`$this->connectionName = $name;`
`175`	`157`	`}`
`176`	`158`
`177`		`- /**`
`178`		`- * @param $class`
`179`		`- * @return mixed`
`180`		`- */`
`181`	`159`	`protected function getTable($class)`
`182`	`160`	`{`
`183`	`161`	`$options = [];`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,6 @@ public function __construct(\Faker\Generator $generator)`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`/**`
`20`		`- * @param $fieldName`
`21`	`20`	`* @param ClassMetadata $class`
`22`	`21`	`* @return \Closure\|null`
`23`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -58,9 +58,6 @@ public function getColumnFormatters()`
`58`	`58`	`return $this->columnFormatters;`
`59`	`59`	`}`
`60`	`60`
`61`		`- /**`
`62`		`- * @param $columnFormatters`
`63`		`- */`
`64`	`61`	`public function mergeColumnFormattersWith($columnFormatters)`
`65`	`62`	`{`
`66`	`63`	`$this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);`
`@@ -162,9 +159,8 @@ public function guessColumnFormatters(\Faker\Generator $generator)`
`162`	`159`	`/**`
`163`	`160`	`* Insert one new record using the Entity class.`
`164`	`161`	`* @param ObjectManager $manager`
`165`		`- * @param $insertedEntities`
`166`	`162`	`* @param bool $generateId`
`167`		`- * @return`
	`163`	`+ * @return EntityPopulator`
`168`	`164`	`*/`
`169`	`165`	`public function execute(ObjectManager $manager, $insertedEntities, $generateId = false)`
`170`	`166`	`{`
`@@ -186,10 +182,6 @@ public function execute(ObjectManager $manager, $insertedEntities, $generateId =`
`186`	`182`	`return $obj;`
`187`	`183`	`}`
`188`	`184`
`189`		`- /**`
`190`		`- * @param $obj`
`191`		`- * @param $insertedEntities`
`192`		`- */`
`193`	`185`	`private function fillColumns($obj, $insertedEntities)`
`194`	`186`	`{`
`195`	`187`	`foreach ($this->columnFormatters as $field => $format) {`
`@@ -200,10 +192,6 @@ private function fillColumns($obj, $insertedEntities)`
`200`	`192`	`}`
`201`	`193`	`}`
`202`	`194`
`203`		`- /**`
`204`		`- * @param $obj`
`205`		`- * @param $insertedEntities`
`206`		`- */`
`207`	`195`	`private function callMethods($obj, $insertedEntities)`
`208`	`196`	`{`
`209`	`197`	`foreach ($this->getModifiers() as $modifier) {`
`@@ -212,8 +200,6 @@ private function callMethods($obj, $insertedEntities)`
`212`	`200`	`}`
`213`	`201`
`214`	`202`	`/**`
`215`		`- * @param $obj`
`216`		`- * @param $column`
`217`	`203`	`* @param EntityManagerInterface $manager`
`218`	`204`	`* @return int\|null`
`219`	`205`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function addEntity($entity, $number, $customColumnFormatters = array(), $`
`55`	`55`	`/**`
`56`	`56`	`* Populate the database using all the Entity classes previously added.`
`57`	`57`	`*`
`58`		`- * @param EntityManager $entityManager A Doctrine connection object`
	`58`	`+ * @param null\|EntityManager $entityManager A Doctrine connection object`
`59`	`59`	`*`
`60`	`60`	`* @return array A list of the inserted PKs`
`61`	`61`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ public function __construct(\Faker\Generator $generator)`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * @param $field`
`19`	`18`	`* @return \Closure\|null`
`20`	`19`	`*/`
`21`	`20`	`public function guessFormat($field)`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,6 @@ public function getClass()`
`31`	`31`	`return $this->class;`
`32`	`32`	`}`
`33`	`33`
`34`		`- /**`
`35`		`- * @param $columnFormatters`
`36`		`- */`
`37`	`34`	`public function setColumnFormatters($columnFormatters)`
`38`	`35`	`{`
`39`	`36`	`$this->columnFormatters = $columnFormatters;`
`@@ -47,9 +44,6 @@ public function getColumnFormatters()`
`47`	`44`	`return $this->columnFormatters;`
`48`	`45`	`}`
`49`	`46`
`50`		`- /**`
`51`		`- * @param $columnFormatters`
`52`		`- */`
`53`	`47`	`public function mergeColumnFormattersWith($columnFormatters)`
`54`	`48`	`{`
`55`	`49`	`$this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);`
`@@ -100,8 +94,6 @@ public function guessColumnFormatters(\Faker\Generator $generator, Mandango $man`
`100`	`94`	`/**`
`101`	`95`	`* Insert one new record using the Entity class.`
`102`	`96`	`* @param Mandango $mandango`
`103`		`- * @param $insertedEntities`
`104`		`- * @return`
`105`	`97`	`*/`
`106`	`98`	`public function execute(Mandango $mandango, $insertedEntities)`
`107`	`99`	`{`