gossi\codegen\generator\builder\AbstractBuilder

Complexity

Total Complexity

9

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
	build()	0	1	?
A	generate()	0	4	1
A	ensureBlankLine()	0	5	3
A	buildDocblock()	0	10	4

<?php
namespace gossi\codegen\generator\builder;

use gossi\codegen\generator\ModelGenerator;
use gossi\codegen\generator\utils\Writer;
use gossi\codegen\model\AbstractModel;
use gossi\docblock\Docblock;
use gossi\codegen\config\CodeGeneratorConfig;
use gossi\codegen\model\DocblockInterface;

abstract class AbstractBuilder {

	/** @var ModelGenerator */
	protected $generator;
	
	/** @var Writer */
	protected $writer;
	
	/** @var CodeGeneratorConfig */
	protected $config;
	
	public function __construct(ModelGenerator $generator) {
		$this->generator = $generator;
		$this->writer = $generator->getWriter();
		$this->config = $generator->getConfig();
	}
	
	public abstract function build(AbstractModel $model);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

	
	protected function generate(AbstractModel $model) {
		$builder = $this->generator->getFactory()->getBuilder($model);
		$builder->build($model);
	}
	
	protected function ensureBlankLine() {
		if (!$this->writer->endsWith("\n\n") && strlen($this->writer->rtrim()->getContent()) > 0) {
			$this->writer->writeln();
		} 
	}
	
	protected function buildDocblock(DocblockInterface $model) {
		$this->ensureBlankLine();
		if ($this->config->getGenerateDocblock()) {
			$model->generateDocblock();
		}
		$docblock = $model->getDocblock();
		if (!$docblock->isEmpty() || $this->config->getGenerateEmptyDocblock()) {
			$this->writer->writeln($docblock->toString());
		}
	}
	
}