Add support for scalar and return type hinting (as available in PHP7) and add the strict type declaration option to CodeFileGenerator

Author: Robin Geuze

src/config/CodeFileGeneratorConfig.php

@@ -6,35 +6,37 @@ class CodeFileGeneratorConfig extends CodeGeneratorConfig {
 
 	protected function getOptionalOptions() {
 		return array_merge([
-				'headerComment', 'headerDocblock', 'blankLineAtEnd'
+				'headerComment', 'headerDocblock', 'blankLineAtEnd', 'declareStrictTypes'
 			], parent::getOptionalOptions());
 	}
-	
+
 	protected function getDefaultOptions() {
 		return array_merge([
 				'headerComment' => '',
 				'headerDocblock' => null,
-				'blankLineAtEnd' => true
+				'blankLineAtEnd' => true,
+				'declareStrictTypes'  => false,
 			], parent::getDefaultOptions());
 	}
-	
+
 	protected function getAllowedOptionTypes() {
 		return array_merge([
 				'headerComment' => 'string',
 				'headerDocblock' => ['null', 'gossi\\docblock\\Docblock'],
-				'blankLineAtEnd' => 'bool'
+				'blankLineAtEnd' => 'bool',
+				'declareStrictTypes' => 'bool',
 			], parent::getAllowedOptionTypes());
 	}
-	
+
 	/**
 	 * @return string
 	 */
 	public function getHeaderComment() {
 		return $this->options['headerComment'];
 	}
-	
+
 	/**
-	 * 
+	 *
 	 * @param string $comment
 	 * @return $this
 	 */
@@ -49,9 +51,9 @@ public function setHeaderComment($comment) {
 	public function getHeaderDocblock() {
 		return $this->options['headerDocblock'];
 	}
-	
+
 	/**
-	 * 
+	 *
 	 * @param Docblock $docblock
 	 * @return $this
 	 */
@@ -66,9 +68,9 @@ public function setHeaderDocblock(Docblock $docblock) {
 	public function getBlankLineAtEnd() {
 		return $this->options['blankLineAtEnd'];
 	}
-	
+
 	/**
-	 * 
+	 *
 	 * @param boolean $show
 	 * @return $this
 	 */
@@ -77,4 +79,21 @@ public function setBlankLineAtEnd($show) {
 		return $this;
 	}
 
+	/**
+	 * @return boolean
+	 */
+	public function getDeclareStrictTypes() {
+		return $this->options['declareStrictTypes'];
+	}
+
+	/**
+	 *
+	 * @param boolean $show
+	 * @return $this
+	 */
+	public function setDeclareStrictTypes($strict) {
+		$this->options['declareStrictTypes'] = $strict;
+		return $this;
+	}
+
 }

src/config/CodeGeneratorConfig.php

@@ -4,66 +4,109 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 class CodeGeneratorConfig {
-	
+
 	protected $options;
-	
+
 	public function __construct(array $options = []) {
 		$resolver = new OptionsResolver();
 		$resolver->setOptional($this->getOptionalOptions());
 		$resolver->setAllowedTypes($this->getAllowedOptionTypes());
 		$resolver->setDefaults($this->getDefaultOptions());
 		$this->options = $resolver->resolve($options);
 	}
-	
+
 	protected function getOptionalOptions() {
-		return ['generateDocblock', 'generateEmptyDocblock'];
+		return [
+			'generateDocblock',
+			'generateEmptyDocblock',
+			'generateScalarTypeHints',
+			'generateReturnTypeHints',
+		];
 	}
-	
+
 	protected function getDefaultOptions() {
 		return [
 			'generateDocblock' => true,
-			'generateEmptyDocblock' => true
+			'generateEmptyDocblock' => true,
+			'generateScalarTypeHints' => false,
+			'generateReturnTypeHints' => false,
 		];
 	}
-	
+
 	protected function getAllowedOptionTypes() {
 		return [
 			'generateDocblock' => 'bool',
 			'generateEmptyDocblock' => 'bool',
+			'generateScalarTypeHints' => 'bool',
+			'generateReturnTypeHints' => 'bool',
 		];
 	}
-	
+
 	/**
 	 * @return boolean
 	 */
 	public function getGenerateDocblock() {
 		return $this->options['generateDocblock'];
 	}
-	
+
 	/**
-	 * 
+	 *
 	 * @param boolean $generate
 	 * @return $this
 	 */
 	public function setGenerateDocblock($generate) {
 		$this->options['generateDocblock'] = $generate;
 		return $this;
 	}
-	
+
 	/**
 	 * @return boolean
 	 */
 	public function getGenerateEmptyDocblock() {
 		return $this->options['generateEmptyDocblock'];
 	}
-	
+
 	/**
-	 * 
+	 *
 	 * @param boolean $generate
 	 * @return $this
 	 */
 	public function setGenerateEmptyDocblock($generate) {
 		$this->options['generateEmptyDocblock'] = $generate;
 		return $this;
 	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getGenerateScalarTypeHints() {
+		return $this->options['generateScalarTypeHints'];
+	}
+
+	/**
+	 *
+	 * @param boolean $generate
+	 * @return $this
+	 */
+	public function setGenerateScalarTypeHints($generate) {
+		$this->options['generateScalarTypeHints'] = $generate;
+		return $this;
+	}
+
+	/**
+	 * @return boolean
+	 */
+	public function getGenerateReturnTypeHints() {
+		return $this->options['generateReturnTypeHints'];
+	}
+
+	/**
+	 *
+	 * @param boolean $generate
+	 * @return $this
+	 */
+	public function setGenerateReturnTypeHints($generate) {
+		$this->options['generateReturnTypeHints'] = $generate;
+		return $this;
+	}
 }

src/generator/CodeFileGenerator.php

@@ -6,7 +6,7 @@
 use gossi\docblock\Docblock;
 
 class CodeFileGenerator extends CodeGenerator {
-	
+
 	/**
 	 * @param CodeFileGeneratorConfig|array $config
 	 */
@@ -17,38 +17,42 @@ public function __construct($config = null) {
 			$this->config = $config;
 		} else {
 			$this->config = new CodeFileGeneratorConfig();
-		} 
-		
+		}
+
 		$this->init();
 	}
-	
+
 	/**
 	 * @return CodeFileGeneratorConfig
 	 */
 	public function getConfig() {
 		return $this->config;
 	}
-	
+
 	public function generate(GenerateableInterface $model) {
 		$content = "<?php\n";
-		
+
 		$comment = $this->config->getHeaderComment();
 		if (!empty($comment)) {
 			$docblock = new Docblock();
 			$docblock->setLongDescription($comment);
 			$content .= str_replace('/**', '/*', $docblock->toString()) . "\n";
 		}
-		
+
 		if ($this->config->getHeaderDocblock() instanceof Docblock) {
 			$content .= $this->config->getHeaderDocblock()->toString() . "\n";
 		}
-		
+
+		if ($this->config->getDeclareStrictTypes()) {
+			$content .= "declare(strict_types=1);\n";
+		}
+
 		$content .= parent::generate($model);
-		
+
 		if ($this->config->getBlankLineAtEnd()) {
 			$content .= "\n";
 		}
-		
+
 		return $content;
 	}
 }

src/generator/CodeGenerator.php

@@ -9,14 +9,14 @@
 class CodeGenerator {
 
 	protected $config;
-	
+
 	/**
 	 * @var DefaultGeneratorStrategy
 	 */
 	protected $strategy;
-	
+
 	/**
-	 * 
+	 *
 	 * @param CodeGeneratorConfig|array $config
 	 */
 	public function __construct($config = null) {
@@ -26,20 +26,26 @@ public function __construct($config = null) {
 			$this->config = $config;
 		} else {
 			$this->config = new CodeGeneratorConfig();
-		} 
+		}
 
 		$this->init();
 	}
-	
+
 	protected function init() {
 		if ($this->config->getGenerateEmptyDocblock()) {
-			$visitor = new EmptyDocblockVisitor();
+			$visitor = new EmptyDocblockVisitor(
+				$this->config->getGenerateScalarTypeHints(),
+				$this->config->getGenerateReturnTypeHints()
+			);
 		} else {
-			$visitor = new DefaultVisitor();
+			$visitor = new DefaultVisitor(
+				$this->config->getGenerateScalarTypeHints(),
+				$this->config->getGenerateReturnTypeHints()
+			);
 		}
 		$this->strategy = new DefaultGeneratorStrategy($visitor);
 	}
-	
+
 	/**
 	 * @return CodeGeneratorConfig
 	 */
@@ -58,5 +64,5 @@ public function generate(GenerateableInterface $model) {
 
 		return $this->strategy->generate($model);
 	}
-	
+
 }