generators\Readme\ReadmeGenerator

Complexity

Total Complexity

8

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setContent()	0	5	1
A	setMediator()	0	3	1
A	getPath()	0	12	2
A	substituteData()	0	10	1
A	getTemplateFilename()	0	3	1
A	toString()	0	6	1

<?php

namespace generators\Readme;

use Config;
use mediators\AbstractMediator;

/**
  * @property string FILENAME
  * @property string $content
  * @property Config $config
  */
final class ReadmeGenerator extends \generators\AbstractGenerator
{
    const FILENAME = 'app/addons/${addon}/README.md';
    private $templatePath = ROOT_DIR . '/resources/README.md';
    private $content = '';
    private $config;
    private $mediator;

    function __construct(Config $config)
    {
        $this->config = $config;
    }

    /**
     * @inheritdoc
     */
    public function getTemplateFilename(): string
    {
        return sanitize_filename($this->templatePath);
    }

    public function setMediator(AbstractMediator $mediator): void
    {
        $this->mediator = $mediator;
    }

    /**
     * @inheritdoc
     */
    public function getPath(): string
    {
        $addon_id = $this->config->get('addon.id');

        if (!$addon_id) {
            throw new \InvalidArgumentException('Addon id (name) not specified');
        }

        $path = $this->config->get('filesystem.output_path')
            . str_replace('${addon}', $addon_id, static::FILENAME);

        return sanitize_filename($path);
    }

    /**
     * @inheritdoc
     *
     * @return LanguageGenerator

The type generators\Readme\LanguageGenerator was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function setContent(string $content)
    {
        $this->content = $content;

        return $this;

The expression return $this returns the type generators\Readme\ReadmeGenerator which is incompatible with the documented return type generators\Readme\LanguageGenerator.

    }

    /**
     * Replace placeholders by real data
     * @param string $content
     * 
     * @return string
     */
    public static function substituteData(string $content, array $data): string
    {
        return str_replace(
            [
                '${addon.id}',
                '${developer.company}',
                '${developer.name}',
            ],
            $data,
            $content
        );
    }

    /**
     * @inheritdoc
     */
    public function toString(): string
    {
        return self::substituteData($this->content, [
            parse_to_readable($this->config->get('addon.id')),
            $this->config->get('developer.company'),
            $this->config->get('developer.name')
        ]);
    }
}