DocsGeneratorTrait::getApiDomain() - Code Metrics - Inspection of "use app full URL instead of API url for the doc ge..." - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f41b2c...9e2978 )

by Mahmoud

created 2017-03-22 23:37 UTC

DocsGeneratorTrait::getApiDomain() A

↳ Parent: DocsGeneratorTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace App\Containers\Documentation\Traits;

use DateTime;

/**
 * Class DocsGeneratorTrait
 *
 * @author  Mahmoud Zalt  <[email protected]>
 */
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');
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @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);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @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');
    }

}


1			<?php
2
3			namespace App\Containers\Documentation\Traits;
4
5			use DateTime;
6
7			/**
8			* Class DocsGeneratorTrait
9			*
10			* @author Mahmoud Zalt <[email protected]>
11			*/
12			trait DocsGeneratorTrait
13			{
14
15			/**
16			* @return mixed
17			*/
18			private function getFullApiUrl($type)
19			{
20			return '> ' . $this->getAppUrl() . '/' . $this->getUrl($type);
21			}
22
23			/**
24			* @return mixed
25			*/
26			private function getAppUrl()
27			{
28			return $this->config->get('app.url');
			0 ignored issues – show Bug introduced 2017-03-22 23:30 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...
29			}
30
31			/**
32			* @return mixed
33			*/
34			private function getHtmlPath()
35			{
36			return $this->config->get("{$this->getConfigFile()}.html_files");
37			}
38
39			/**
40			* Where to generate the new documentation.
41			*
42			* @return string
43			*/
44			private function getDocumentationPath($type)
45			{
46			return $this->getHtmlPath() . $this->getUrl($type);
47			}
48
49			/**
50			* @return string
51			*/
52			private function getJsonFilePath($type)
53			{
54			return "app/Containers/Documentation/ApiDocJs/{$type}";
55			}
56
57			/**
58			* @return string
59			*/
60			private function getConfigFile()
61			{
62			return 'apidoc';
63			}
64
65			/**
66			* @return mixed
67			*/
68			private function getTypeConfig()
69			{
70			return $this->config->get($this->getConfigFile() . '.types');
71			}
72
73			/**
74			* @return mixed
75			*/
76			private function getExecutable()
77			{
78			return $this->config->get($this->getConfigFile() . '.executable');
79			}
80
81			/**
82			* @param $type
83			*
84			* @return mixed
85			*/
86			private function getUrl($type)
87			{
88			$configs = $this->getTypeConfig();
89
90			return $configs[$type]['url'];
91			}
92
93			/**
94			* @param $type
95			*
96			* @return string
97			*/
98			private function getEndpointFiles($type)
99			{
100			$configs = $this->getTypeConfig();
101
102			// what files types needs to be included
103			$routeFilesCommand = '';
104			$routes = $configs[$type]['routes'];
105
106			foreach ($routes as $route) {
107			$routeFilesCommand .= '-f ' . $route . '.php ';
108			}
109
110			return $routeFilesCommand;
111			}
112
113
114			/**
115			* @param $templateKey
116			* @param $value
117			*/
118			private function replace($templateKey, $value)
119			{
120			$this->headerMarkdownContent = str_replace($templateKey, $value, $this->headerMarkdownContent);
			0 ignored issues – show Bug introduced 2017-03-22 23:30 UTC by Report Bug Copy Issue Report The property `headerMarkdownContent` 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...
121			}
122
123			/**
124			* @param $minutes
125			*
126			* @return string
127			*/
128			private function minutesToTimeDisplay($minutes)
129			{
130			$seconds = $minutes * 60;
131
132			$dtF = new DateTime('@0');
133			$dtT = new DateTime("@$seconds");
134
135			return $dtF->diff($dtT)->format('%a days, %h hours, %i minutes and %s seconds');
136			}
137
138			}
139

Porto-SAP / Hello-API

Push — master ( f41b2c...9e2978 )

DocsGeneratorTrait::getApiDomain() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like