gossi\codegen\config\CodeFileGeneratorConfig

Complexity

Total Complexity

11

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

92.68%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	configureOptions()	0	28	1
A	toDocblock()	0	7	2
A	getHeaderComment()	0	3	1
A	setHeaderComment()	0	4	1
A	getHeaderDocblock()	0	3	1
A	setHeaderDocblock()	0	4	1
A	getBlankLineAtEnd()	0	3	1
A	setBlankLineAtEnd()	0	4	1
A	getDeclareStrictTypes()	0	3	1
A	setDeclareStrictTypes()	0	4	1

<?php
declare(strict_types=1);

namespace gossi\codegen\config;

use gossi\docblock\Docblock;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Configuration for code file generation
 *
 * @author Thomas Gossmann
 */
class CodeFileGeneratorConfig extends CodeGeneratorConfig {

	protected function configureOptions(OptionsResolver $resolver): void {
		parent::configureOptions($resolver);

		$resolver->setDefaults([
			'headerComment' => null,
			'headerDocblock' => null,
			'blankLineAtEnd' => true,
			'declareStrictTypes'  => false,
			'generateScalarTypeHints' => function (Options $options) {
				return $options['declareStrictTypes'];
			},
			'generateReturnTypeHints' => function (Options $options) {
				return $options['declareStrictTypes'];
			},
		]);

		$resolver->setAllowedTypes('headerComment', ['null', 'string', 'gossi\\docblock\\Docblock']);
		$resolver->setAllowedTypes('headerDocblock', ['null', 'string', 'gossi\\docblock\\Docblock']);
		$resolver->setAllowedTypes('blankLineAtEnd', 'bool');
		$resolver->setAllowedTypes('declareStrictTypes', 'bool');

		$resolver->setNormalizer('headerComment', function (Options $options, $value) {
			return $this->toDocblock($value);
		});
		$resolver->setNormalizer('headerDocblock', function (Options $options, $value) {
			return $this->toDocblock($value);
		});
	}

	/**
	 *
	 * @param mixed $value
	 * @return Docblock|null
	 */
	private function toDocblock($value): ?Docblock {
		if (is_string($value)) {
			$value = Docblock::create()->setLongDescription($value);
		}

		return $value;
	}

	/**
	 * Returns the file header comment
	 *
	 * @return Docblock the header comment
	 */
	public function getHeaderComment(): ?Docblock {
		return $this->options['headerComment'];
	}

	/**
	 * Sets the file header comment
	 *
	 * @param Docblock $comment the header comment
	 * @return $this
	 */
	public function setHeaderComment(Docblock $comment) {
		$this->options['headerComment'] = $comment;
		return $this;
	}

	/**
	 * Returns the file header docblock
	 *
	 * @return Docblock the docblock
	 */
	public function getHeaderDocblock(): ?Docblock {
		return $this->options['headerDocblock'];
	}

	/**
	 * Sets the file header docblock
	 *
	 * @param Docblock $docblock the docblock
	 * @return $this
	 */
	public function setHeaderDocblock(Docblock $docblock) {
		$this->options['headerDocblock'] = $docblock;
		return $this;
	}

	/**
	 * Returns whether a blank line should be generated at the end of the file
	 *
	 * @return bool `true` if it will be generated and `false` if not
	 */
	public function getBlankLineAtEnd(): bool {
		return $this->options['blankLineAtEnd'];
	}

	/**
	 * Sets whether a blank line should be generated at the end of the file
	 *
	 * @param bool $show `true` if it will be generated and `false` if not
	 * @return $this
	 */
	public function setBlankLineAtEnd(bool $show) {
		$this->options['blankLineAtEnd'] = $show;
		return $this;
	}

	/**
	 * Returns whether a `declare(strict_types=1);` statement should be printed
	 * below the header comments (PHP 7)
	 *
	 * @return bool `true` if it will be printed and `false` if not
	 */
	public function getDeclareStrictTypes(): bool {
		return $this->options['declareStrictTypes'];
	}

	/**
	 * Sets whether a `declare(strict_types=1);` statement should be printed
	 * below the header comments (PHP 7)
	 *
	 * @param bool $strict `true` if it will be printed and `false` if not
	 * @return $this
	 */
	public function setDeclareStrictTypes(bool $strict) {
		$this->options['declareStrictTypes'] = $strict;
		return $this;
	}
}