PHPDoc's @var support (instead of @type).

Author: dunglas

README.md

@@ -61,6 +61,9 @@ debug:                false
 # Generate interfaces and use Doctrine's Resolve Target Entity feature
 useInterface:         false
 
+# Use PSR-5's @type annotation instead of @var in the PHPDoc.
+useType:              false
+
 # Use Doctrine's ArrayCollection instead of standard arrays
 useDoctrineCollection:  true
 

src/SchemaOrgModel/AnnotationGenerator/PhpDocAnnotationGenerator.php

@@ -61,7 +61,8 @@ public function generateFieldAnnotations($className, $fieldName)
 
         $annotations = $this->formatDoc($field['resource']->get('rdfs:comment'), true);
         $annotations[0] = sprintf(
-            '@type %s $%s %s',
+            '@%s %s $%s %s',
+            $this->config['useType'] ? 'type' : 'var',
             $this->toPhpType($field),
             $fieldName,
             $annotations[0]

src/SchemaOrgModel/TypesGeneratorConfiguration.php

@@ -47,6 +47,7 @@ public function getConfigTreeBuilder()
                 ->end()
                 ->booleanNode('debug')->defaultFalse()->info('Debug mode')->end()
                 ->booleanNode('useInterface')->defaultFalse()->info('Generate interfaces and use Doctrine\'s Resolve Target Entity feature')->end()
+                ->booleanNode('useType')->defaultFalse()->info('Use PSR-5\'s @type annotation instead of @var in the PHPDoc.')->end()
                 ->booleanNode('useDoctrineCollection')->defaultTrue()->info('Use Doctrine\'s ArrayCollection instead of standard arrays')->end()
                 ->booleanNode('checkIsGoodRelations')->defaultFalse()->info('Emit a warning if a property is not derived from GoodRelations')->end()
                 ->scalarNode('header')->defaultFalse()->info('A license or any text to use as header of generated files')->example('// (c) Kévin Dunglas <[email protected]>')->end()

tests/config/address-book.yml

@@ -1,5 +1,5 @@
 namespaces:
-  entity: "AppBundle\Entity"
+  entity: "Dunglas\AddressBookBundle\Entity"
 types:
   Thing:
     properties:

tests/config/ecommerce.yml

@@ -17,6 +17,7 @@ namespaces:
   interface:            "Dunglas\EcommerceBundle\Model"
 author: "Kévin Dunglas <[email protected]>"
 debug: true
+useType: true
 useInterface: true
 checkIsGoodRelations: true
 types: