samsonframework\generator\FunctionGenerator

Complexity

Total Complexity

12

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

87.18%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	defArgument()	0	10	1
A	setIndentation()	0	7	1
A	defDescription()	0	12	2
A	defReturnType()	0	6	1
B	code()	0	28	4
A	buildDefinition()	0	4	1
A	defComment()	0	4	1

<?php declare(strict_types=1);
/**
 * Created by Vitaly Iegorov <egorov@samsonos.com>.
 * on 03.09.16 at 11:30
 */
namespace samsonframework\generator;

/**
 * Function generation class.
 *
 * @author Vitaly Egorov <egorov@samsonos.com>
 */
class FunctionGenerator extends AbstractGenerator
{
    use CodeTrait;

    /** @var string Function name */
    protected $name;

    /** @var array Collection of function arguments */
    protected $arguments = [];

    /** @var array Collection of function arguments descriptions */
    protected $argumentDescriptions = [];

    /** @var array Collection of function arguments default values */
    protected $argumentDefaults = [];

    /** @var string Return type hint */
    protected $returnType;

    /** @var FunctionCommentsGenerator */
    protected $commentGenerator;

    /**
     * FunctionGenerator constructor.
     *
     * @param string            $name   Function name
     * @param AbstractGenerator $parent Parent Generator
     */
    public function __construct(string $name, AbstractGenerator $parent = null)
    {
        $this->name = $name;

        $this->commentGenerator = (new FunctionCommentsGenerator($this->arguments, $this->argumentDescriptions, $this))

The class samsonframework\generator\FunctionCommentsGenerator has been deprecated.

            ->setIndentation($this->indentation);

        parent::__construct($parent);
    }

    /**
     * Set function argument.
     *
     * @param string      $name        Argument name
     * @param string|null $type        Argument type
     * @param string      $description Argument description
     * @param mixed      $defaultValue Argument default value
     *
     * @return FunctionGenerator
     */
    public function defArgument(string $name, string $type = null, string $description = null, $defaultValue = null) : FunctionGenerator
    {
        $this->arguments[$name] = $type;
        $this->argumentDescriptions[$name] = $description;
        $this->argumentDefaults[$name] = $defaultValue;

        $this->commentGenerator->defParam($name, $type, $description);

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function setIndentation(int $indentation): AbstractGenerator
    {
        // Set comments indentation
        $this->commentGenerator->setIndentation($indentation);

        return parent::setIndentation($indentation); // TODO: Change the autogenerated stub
    }

    /**
     * Set function description comment.
     *
     * @param array $description Function description
     *
     * @return FunctionGenerator
     */
    public function defDescription(array $description): FunctionGenerator
    {
        // Append description lines
        foreach ($description as $line) {
            $this->commentGenerator->defLine($line);
        }

        // Add one empty line at the end
        $this->commentGenerator->defLine('');

        return $this;
    }

    /**
     * Set return value type
     *
     * @param string|null $type Return type hint
     *
     * @return FunctionGenerator
     */
    public function defReturnType(string $type) : FunctionGenerator
    {
        $this->returnType = $type;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function code(int $indentation = 0) : string
    {
        $innerIndentation = $this->indentation(1);

        // Get return type code
        $returnType = $this->returnType ? ' : ' . $this->returnType : '';

        $formattedCode = [
            $this->buildDefinition() . '(' . $this->buildArguments($this->arguments, $this->argumentDefaults) . ')' . $returnType,
            '{'
        ];

        // Prepend inner indentation to code
        foreach ($this->code as $codeLine) {
            $formattedCode[] = $innerIndentation.$codeLine;
        }

        $formattedCode[] = '}';

        $code = implode("\n" . $this->indentation($indentation), $formattedCode);

        // Add comments
        if (array_key_exists(FunctionCommentsGenerator::class, $this->generatedCode)) {
            $code = $this->generatedCode[FunctionCommentsGenerator::class] . "\n" . $code;
        }

        return $code;
    }

    /**
     * Build function definition.
     *
     * @return string Function definition
     */
    protected function buildDefinition()
    {
        return 'function ' . $this->name;
    }

    /**
     * {@inheritdoc}
     */
    public function defComment() : CommentsGenerator
    {
        return $this->commentGenerator;
    }
}