GenerateDocumentationAction::run() - Code Metrics - Inspection of "change how docs are generated, so support multiple..." - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ce9eda...f41b2c )

by Mahmoud

created 2017-03-22 23:27 UTC

GenerateDocumentationAction::run() A

↳ Parent: GenerateDocumentationAction

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	1

<?php

namespace App\Containers\Documentation\Actions;

use App\Containers\Documentation\Tasks\GenerateAPIDocsTask;
use App\Containers\Documentation\Tasks\GetDocsTypesTask;
use App\Containers\Documentation\Tasks\ProcessMarkdownTemplatesTask;
use App\Ship\Parents\Actions\Action;

/**
 * Class GenerateDocumentationAction.
 *
 * @author Mahmoud Zalt <[email protected]>
 */
class GenerateDocumentationAction extends Action
{

    /**
     * @param $console
     */
    public function run($console)
    {
        // parse the markdown file.
        $this->call(ProcessMarkdownTemplatesTask::class);

        // get docs types that needs to be generated by the user base on his configs.
        $types = $this->call(GetDocsTypesTask::class);

        $console->info("Generating API Documentations for (" . implode(' & ', $types) . ")\n");

        // for each type, generate docs.
        foreach ($types as $type) {
            $documentationUrls[] = $this->call(GenerateAPIDocsTask::class, [$type, $console]);
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }

        $console->info("Done! You can access your API Docs at: \n" . implode("\n", $documentationUrls));
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

}


1			<?php
2
3			namespace App\Containers\Documentation\Actions;
4
5			use App\Containers\Documentation\Tasks\GenerateAPIDocsTask;
6			use App\Containers\Documentation\Tasks\GetDocsTypesTask;
7			use App\Containers\Documentation\Tasks\ProcessMarkdownTemplatesTask;
8			use App\Ship\Parents\Actions\Action;
9
10			/**
11			* Class GenerateDocumentationAction.
12			*
13			* @author Mahmoud Zalt <[email protected]>
14			*/
15			class GenerateDocumentationAction extends Action
16			{
17
18			/**
19			* @param $console
20			*/
21			public function run($console)
22			{
23			// parse the markdown file.
24			$this->call(ProcessMarkdownTemplatesTask::class);
25
26			// get docs types that needs to be generated by the user base on his configs.
27			$types = $this->call(GetDocsTypesTask::class);
28
29			$console->info("Generating API Documentations for (" . implode(' & ', $types) . ")\n");
30
31			// for each type, generate docs.
32			foreach ($types as $type) {
33			$documentationUrls[] = $this->call(GenerateAPIDocsTask::class, [$type, $console]);
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-22 23:30 UTC by Report Bug Copy Issue Report `$documentationUrls` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$documentationUrls = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
34			}
35
36			$console->info("Done! You can access your API Docs at: \n" . implode("\n", $documentationUrls));
			0 ignored issues – show Bug introduced 2017-03-22 23:30 UTC by Report Bug Copy Issue Report The variable `$documentationUrls` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
37			}
38
39			}
40

Porto-SAP / Hello-API

Push — master ( ce9eda...f41b2c )

GenerateDocumentationAction::run() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like