FunctionCommentsGenerator::code() - Code Metrics - Inspection of "Added functionCommentsGenerator for automatic @par..." - SamsonPHP/generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7c8f9a...d24041 )

by Vitaly

created 2016-09-04 07:47 UTC

FunctionCommentsGenerator::code() A

↳ Parent: FunctionCommentsGenerator

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1

<?php declare(strict_types = 1);
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 04.09.16 at 10:43
 */
namespace samsonphp\generator;

/**
 * Class FunctionCommentsGenerator
 *
 * @author Vitaly Egorov <[email protected]>
 */
class FunctionCommentsGenerator extends CommentsGenerator
{
    /** @var array Argument name to type collection */
    protected $arguments = [];

    /** @var array Argument name to description collection */
    protected $descriptions = [];

    /**
     * FunctionCommentsGenerator constructor.
     *
     * @param array                  $arguments    Argument name to type collection
     * @param array                  $descriptions Argument name to description collection
     * @param AbstractGenerator|null $parent       Parent generator
     */
    public function __construct(array $arguments, array $descriptions, AbstractGenerator $parent = null)
    {
        $this->arguments = $arguments;
        $this->descriptions = $descriptions;

        parent::__construct($parent);
    }

    /**
     * {@inheritdoc}
     */
    public function code(int $indentation = 0) : string
    {
        // Add parameters comments
        foreach ($this->arguments as $argument => $type) {
            $this->defParam($argument, $type, $this->descriptions[$argument] ?? '');
        }

        return parent::code($indentation);
    }
}


1			<?php declare(strict_types = 1);
2			/**
3			* Created by Vitaly Iegorov <[email protected]>.
4			* on 04.09.16 at 10:43
5			*/
6			namespace samsonphp\generator;
7
8			/**
9			* Class FunctionCommentsGenerator
10			*
11			* @author Vitaly Egorov <[email protected]>
12			*/
13			class FunctionCommentsGenerator extends CommentsGenerator
14			{
15			/** @var array Argument name to type collection */
16			protected $arguments = [];
17
18			/** @var array Argument name to description collection */
19			protected $descriptions = [];
20
21			/**
22			* FunctionCommentsGenerator constructor.
23			*
24			* @param array $arguments Argument name to type collection
25			* @param array $descriptions Argument name to description collection
26			* @param AbstractGenerator\|null $parent Parent generator
27			*/
28			public function __construct(array $arguments, array $descriptions, AbstractGenerator $parent = null)
29			{
30			$this->arguments = $arguments;
31			$this->descriptions = $descriptions;
32
33			parent::__construct($parent);
34			}
35
36			/**
37			* {@inheritdoc}
38			*/
39			public function code(int $indentation = 0) : string
40			{
41			// Add parameters comments
42			foreach ($this->arguments as $argument => $type) {
43			$this->defParam($argument, $type, $this->descriptions[$argument] ?? '');
44			}
45
46			return parent::code($indentation);
47			}
48			}
49

SamsonPHP / generator

Push — master ( 7c8f9a...d24041 )

FunctionCommentsGenerator::code() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like