RoutineBuilderPart::writeFunctionStatement() - Code Metrics - Inspection of "road to v0.4" - gossi/php-code-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 55b21a...aec22b )

by Thomas

created 2016-11-15 12:20 UTC

RoutineBuilderPart::writeFunctionStatement() A

↳ Parent: RoutineBuilderPart

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	12
ccs	9
cts	9
cp	1
rs	9.4285
cc	2
eloc	8
nc	2
nop	1
crap	2

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

use gossi\codegen\model\AbstractModel;
use gossi\codegen\model\RoutineInterface;

Trait RoutineBuilderPart {
	
	use TypeBuilderPart;
	
	protected abstract function generate(AbstractModel $model);

	
	protected function writeFunctionStatement(RoutineInterface $model) {
		$this->writer->write('function ');
class MyClass { }

$x = new MyClass();
$x->foo = true;
		
		if ($model->isReferenceReturned()) {
			$this->writer->write('& ');
		}
		
		$this->writer->write($model->getName() . '(');
		$this->writeParameters($model);
		$this->writer->write(')');
		$this->writeFunctionReturnType($model);
	}
	
	protected function writeParameters(RoutineInterface $model) {
		$first = true;
		foreach ($model->getParameters() as $parameter) {
			if (!$first) {
				$this->writer->write(', ');
			}
			$first = false;
	
			$this->generate($parameter);
		}
	}
	
	protected function writeFunctionReturnType(RoutineInterface $model) {
		$type = $this->getType($model, $this->config->getGenerateReturnTypeHints());
class MyClass { }

$x = new MyClass();
$x->foo = true;
		if ($type !== null) {
			$this->writer->write(': ')->write($type);
		}
	}
	
	protected function writeBody(RoutineInterface $model) {
		$this->writer->writeln(' {')->indent();
		$this->writer->writeln(trim($model->getBody()));
		$this->writer->outdent()->rtrim()->writeln("}");
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
	}
}


1		<?php
2		namespace gossi\codegen\generator\builder\parts;
3
4		use gossi\codegen\model\AbstractModel;
5		use gossi\codegen\model\RoutineInterface;
6
7		Trait RoutineBuilderPart {
8
9		use TypeBuilderPart;
10
11		protected abstract function generate(AbstractModel $model);
		0 ignored issues – show Documentation introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report 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. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
12
13	15	protected function writeFunctionStatement(RoutineInterface $model) {
14	15	$this->writer->write('function ');
		1 ignored issue – show Bug introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report The property `writer` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
15
16	15	if ($model->isReferenceReturned()) {
17	2	$this->writer->write('& ');
18		}
19
20	15	$this->writer->write($model->getName() . '(');
21	15	$this->writeParameters($model);
22	15	$this->writer->write(')');
23	15	$this->writeFunctionReturnType($model);
24	15	}
25
26	15	protected function writeParameters(RoutineInterface $model) {
27	15	$first = true;
28	15	foreach ($model->getParameters() as $parameter) {
29	5	if (!$first) {
30	3	$this->writer->write(', ');
31		}
32	5	$first = false;
33
34	5	$this->generate($parameter);
35		}
36	15	}
37
38	15	protected function writeFunctionReturnType(RoutineInterface $model) {
39	15	$type = $this->getType($model, $this->config->getGenerateReturnTypeHints());
		2 ignored issues – show Bug introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report The property `config` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Documentation introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report `$model` is of type `object<gossi\codegen\model\RoutineInterface>`, but the function expects a `object<gossi\codegen\model\AbstractModel>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
40	15	if ($type !== null) {
41	2	$this->writer->write(': ')->write($type);
42		}
43	15	}
44
45	14	protected function writeBody(RoutineInterface $model) {
46	14	$this->writer->writeln(' {')->indent();
47	14	$this->writer->writeln(trim($model->getBody()));
48	14	$this->writer->outdent()->rtrim()->writeln("}");
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report The string literal `}` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
49	14	}
50		}
51

gossi / php-code-generator

Push — master ( 55b21a...aec22b )

RoutineBuilderPart::writeFunctionStatement() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like