App\Containers\Documentation\Traits\DocsGeneratorTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getFullApiUrl()	0	4	1
A	getHtmlPath()	0	4	1
A	getDocumentationPath()	0	4	1
A	getJsonFilePath()	0	4	1
A	getConfigFile()	0	4	1
A	getTypeConfig()	0	4	1
A	getExecutable()	0	4	1
A	getUrl()	0	6	1
A	getEndpointFiles()	0	14	2
A	replace()	0	4	1
A	minutesToTimeDisplay()	0	9	1
A	getAppUrl()	0	4	1

<?php

namespace App\Containers\Documentation\Traits;

use DateTime;

/**
 * Class DocsGeneratorTrait
 *
 * @author  Mahmoud Zalt  <mahmoud@zalt.me>
 */
trait DocsGeneratorTrait
{

    /**
     * @return  mixed
     */
    private function getFullApiUrl($type)
    {
        return '> ' . $this->getAppUrl() . '/' . $this->getUrl($type);
    }

    /**
     * @return  mixed
     */
    private function getAppUrl()
    {
        return $this->config->get('app.url');

The property config does not exist. Did you maybe forget to declare it?

    }

    /**
     * @return  mixed
     */
    private function getHtmlPath()
    {
        return $this->config->get("{$this->getConfigFile()}.html_files");
    }

    /**
     * Where to generate the new documentation.
     *
     * @return  string
     */
    private function getDocumentationPath($type)
    {
        return $this->getHtmlPath() . $this->getUrl($type);
    }

    /**
     * @return  string
     */
    private function getJsonFilePath($type)
    {
        return "app/Containers/Documentation/ApiDocJs/{$type}";
    }

    /**
     * @return  string
     */
    private function getConfigFile()
    {
        return 'apidoc';
    }

    /**
     * @return  mixed
     */
    private function getTypeConfig()
    {
        return $this->config->get($this->getConfigFile() . '.types');
    }

    /**
     * @return  mixed
     */
    private function getExecutable()
    {
        return $this->config->get($this->getConfigFile() . '.executable');
    }

    /**
     * @param $type
     *
     * @return  mixed
     */
    private function getUrl($type)
    {
        $configs = $this->getTypeConfig();

        return $configs[$type]['url'];
    }

    /**
     * @param $type
     *
     * @return  string
     */
    private function getEndpointFiles($type)
    {
        $configs = $this->getTypeConfig();

        // what files types needs to be included
        $routeFilesCommand = '';
        $routes = $configs[$type]['routes'];

        foreach ($routes as $route) {
            $routeFilesCommand .= '-f ' . $route . '.php ';
        }

        return $routeFilesCommand;
    }


    /**
     * @param $templateKey
     * @param $value
     */
    private function replace($templateKey, $value)
    {
        $this->headerMarkdownContent = str_replace($templateKey, $value, $this->headerMarkdownContent);

The property headerMarkdownContent does not exist. Did you maybe forget to declare it?

    }

    /**
     * @param $minutes
     *
     * @return  string
     */
    private function minutesToTimeDisplay($minutes)
    {
        $seconds = $minutes * 60;

        $dtF = new DateTime('@0');
        $dtT = new DateTime("@$seconds");

        return $dtF->diff($dtT)->format('%a days, %h hours, %i minutes and %s seconds');
    }

}