Merge pull request #90 from dunglas/mutators

Add an option to not generate mutator methods

Author: dunglas

.php_cs.dist

@@ -12,6 +12,7 @@ HEADER;
 $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__)
     ->exclude('tests/Fixtures/app/cache')
+    ->exclude('build')
 ;
 
 return PhpCsFixer\Config::create()

.travis.yml

@@ -30,7 +30,7 @@ install:
   - if [[ $deps = 'low' ]]; then composer update --prefer-dist --no-progress --no-suggest --prefer-stable --prefer-lowest --ansi; fi
 
 script:
-  - if [[ $coverage = 1 ]]; then phpdbg -qrr php phpunit-6.3.phar --coverage-closer build/logs/clover.xml; else php phpunit-6.3.phar; fi
+  - if [[ $coverage = 1 ]]; then phpdbg -qrr phpunit-6.3.phar --coverage-clover build/logs/clover.xml; else php phpunit-6.3.phar; fi
   - if [[ $lint = 1 ]]; then php php-cs-fixer.phar fix --dry-run --diff --no-ansi; fi
   - if [[ $lint = 1 ]]; then phpstan analyse -l5 --ansi src; fi
   - if [[ ! $deps && $TRAVIS_PHP_VERSION = "7.1" ]]; then php box.phar build; fi;

CHANGELOG.md

@@ -7,6 +7,7 @@
 * A fluent interface isn't generated anymore
 * Useless PHPDoc (`@param` and `@return` annotations when a typehint exist and mutator description) isn't generated anymore
 * `DateTimeInterface` is used instead of `DateTime` when possible
+* Add the ability to not generate mutator methods (useful when generating public properties)
 * The `extract-cardinalities` gains two new options: one to configure the Schema.org's file to use, the other for the GoodRelations one
 * The annotation generator for API Platform v1 has been dropped. Only API Platform v2 is now supported.
 * Parent class is not generated by default anymore (using inheritance for entity is discouraged)

src/TypesGeneratorConfiguration.php

@@ -93,6 +93,7 @@ function ($rdfa) {
                 ->end()
                 ->scalarNode('author')->defaultFalse()->info('The value of the phpDoc\'s @author annotation')->example('Kévin Dunglas <[email protected]>')->end()
                 ->enumNode('fieldVisibility')->values(['private', 'protected', 'public'])->defaultValue('private')->cannotBeEmpty()->info('Visibility of entities fields')->end()
+                ->booleanNode('mutatorMethods')->defaultTrue()->info('Set this flag to false to not generate getter, setter, adder and remover methods')->end()
                 ->arrayNode('types')
                     ->beforeNormalization()
                         ->always()

templates/class.php.twig

@@ -59,6 +59,7 @@ use {{ use }};
     }
 {% endif %}
 
+{% if config.mutatorMethods %}
 {% for field in class.fields %}
 {% if field.isArray %}
     /**
@@ -110,4 +111,5 @@ use {{ use }};
     }
 
 {% endfor %}
+{% endif %}
 }

tests/Command/DumpConfigurationTest.php

@@ -89,6 +89,9 @@ interface:            AppBundle\Model # Example: Acme\Model
     # Visibility of entities fields
     fieldVisibility:      private # One of "private"; "protected"; "public"
 
+    # Set this flag to false to not generate getter, setter, adder and remover methods
+    mutatorMethods:       true
+
     # Schema.org's types to use
     types:
 

tests/Command/GenerateTypesCommandTest.php

@@ -31,7 +31,6 @@ class GenerateTypesCommandTest extends TestCase
     public function setUp()
     {
         $this->fs = new Filesystem();
-        $this->fs->remove(__DIR__.'/../../build/');
     }
 
     /**
@@ -48,12 +47,13 @@ public function testCommand($output, $config)
     public function getArguments()
     {
         return [
-            [__DIR__.'/../../build/address-book/', __DIR__.'/../config/address-book.yml'],
-            [__DIR__.'/../../build/blog/', __DIR__.'/../config/blog.yml'],
-            [__DIR__.'/../../build/ecommerce/', __DIR__.'/../config/ecommerce.yml'],
-            [__DIR__.'/../../build/vgo/', __DIR__.'/../config/vgo.yml'],
-            [__DIR__.'/../../build/mongodb/address-book/', __DIR__.'/../config/mongodb/address-book.yml'],
-            [__DIR__.'/../../build/mongodb/ecommerce/', __DIR__.'/../config/mongodb/ecommerce.yml'],
+            [__DIR__.'/../../build/address-book/', __DIR__.'/../config/address-book.yaml'],
+            [__DIR__.'/../../build/blog/', __DIR__.'/../config/blog.yaml'],
+            [__DIR__.'/../../build/ecommerce/', __DIR__.'/../config/ecommerce.yaml'],
+            [__DIR__.'/../../build/vgo/', __DIR__.'/../config/vgo.yaml'],
+            [__DIR__.'/../../build/public-properties/', __DIR__.'/../config/public-properties.yaml'],
+            [__DIR__.'/../../build/mongodb/address-book/', __DIR__.'/../config/mongodb/address-book.yaml'],
+            [__DIR__.'/../../build/mongodb/ecommerce/', __DIR__.'/../config/mongodb/ecommerce.yaml'],
         ];
     }
 }