Sources::getSource() - Code Metrics - Inspection of "Element index sources" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#93)

by Bart

created 2017-04-13 14:57 UTC

Sources::getSource() C

↳ Parent: Sources

Complexity

Conditions	16
Paths	37

Size

Total Lines	57
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	272

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	57
ccs	0
cts	44
cp	0
rs	6.5273
cc	16
eloc	43
nc	37
nop	4
crap	272

How to fix Long Method Complexity

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft\Craft;
use Craft\BaseApplicationComponent as BaseApplication;

/**
 * Schematic Sources Service.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2017, Nerds & Company
 * @license   MIT
 *
 * @link      http://www.nerds.company
 */
class Sources extends BaseApplication
{
    /**
    * Get sources based on the indexFrom attribute and return them with the indexTo attribute.
    *
    * @param string       $fieldType
    * @param string|array $sources
    * @param string       $indexFrom
    * @param string       $indexTo
    *
    * @return array|string
    */
   public function getMappedSources($fieldType, $sources, $indexFrom, $indexTo)
   {
       $mappedSources = $sources;
       if (is_array($sources)) {
           $mappedSources = [];
           foreach ($sources as $source) {
               $mappedSources[] = $this->getSource($fieldType, $source, $indexFrom, $indexTo);
           }
       }

       return $mappedSources;
   }

   /**
    * Gets a source by the attribute indexFrom, and returns it with attribute $indexTo.
    *
    * @TODO Break up and simplify this method
    *
    * @param string $fieldType
    * @param string $source
    * @param string $indexFrom
    * @param string $indexTo
    *
    * @return string
    */
   public function getSource($fieldType, $source, $indexFrom, $indexTo)
   {
       if ($source == 'singles' || $source == '*') {
           return $source;
       }

      /** @var BaseElementModel $sourceObject */
      $sourceObject = null;

       if (strpos($source, ':') > -1) {
           list($sourceType, $sourceFrom) = explode(':', $source);
           switch ($sourceType) {
              case 'section':
                  $service = Craft::app()->sections;
                  $method = 'getSectionBy';
                  break;
              case 'group':
                  $service = $fieldType == 'Users' ? Craft::app()->userGroups : Craft::app()->categories;
                  $method = 'getGroupBy';
                  break;
              case 'folder':
                  $service = Craft::app()->schematic_assetSources;
                  $method = 'getSourceBy';
                  break;
              case 'taggroup':
                  $service = Craft::app()->tags;
                  $method = 'getTagGroupBy';
                  break;
              case 'field':
                  $service = Craft::app()->fields;
                  $method = 'getFieldBy';
                  break;
          }
       } elseif ($source !== 'singles') {
           //Backwards compatibility
          $sourceType = 'section';
           $sourceFrom = $source;
           $service = Craft::app()->sections;
           $method = 'getSectionBy';
       }
       var_dump($source);

       var_dump($service);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
       var_dump($method);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
       var_dump($sourceFrom);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

       if (isset($service) && isset($method) && isset($sourceFrom)) {
           $method = $method.$indexFrom;
           $sourceObject = $service->$method($sourceFrom);
           var_dump($sourceObject);
       }

       if ($sourceObject && isset($sourceType)) {
           return $sourceType.':'.$sourceObject->$indexTo;
       }

       return $source;
   }
}


Pull Request — master (#93)

Sources::getSource() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace NerdsAndCompany\Schematic\Services;
4
5			use Craft\Craft;
6			use Craft\BaseApplicationComponent as BaseApplication;
7
8			/**
9			* Schematic Sources Service.
10			*
11			* Sync Craft Setups.
12			*
13			* @author Nerds & Company
14			* @copyright Copyright (c) 2015-2017, Nerds & Company
15			* @license MIT
16			*
17			* @link http://www.nerds.company
18			*/
19			class Sources extends BaseApplication
20			{
21			/**
22			* Get sources based on the indexFrom attribute and return them with the indexTo attribute.
23			*
24			* @param string $fieldType
25			* @param string\|array $sources
26			* @param string $indexFrom
27			* @param string $indexTo
28			*
29			* @return array\|string
30			*/
31			public function getMappedSources($fieldType, $sources, $indexFrom, $indexTo)
32			{
33			$mappedSources = $sources;
34			if (is_array($sources)) {
35			$mappedSources = [];
36			foreach ($sources as $source) {
37			$mappedSources[] = $this->getSource($fieldType, $source, $indexFrom, $indexTo);
38			}
39			}
40
41			return $mappedSources;
42			}
43
44			/**
45			* Gets a source by the attribute indexFrom, and returns it with attribute $indexTo.
46			*
47			* @TODO Break up and simplify this method
48			*
49			* @param string $fieldType
50			* @param string $source
51			* @param string $indexFrom
52			* @param string $indexTo
53			*
54			* @return string
55			*/
56			public function getSource($fieldType, $source, $indexFrom, $indexTo)
57			{
58			if ($source == 'singles' \|\| $source == '*') {
59			return $source;
60			}
61
62			/** @var BaseElementModel $sourceObject */
63			$sourceObject = null;
64
65			if (strpos($source, ':') > -1) {
66			list($sourceType, $sourceFrom) = explode(':', $source);
67			switch ($sourceType) {
68			case 'section':
69			$service = Craft::app()->sections;
70			$method = 'getSectionBy';
71			break;
72			case 'group':
73			$service = $fieldType == 'Users' ? Craft::app()->userGroups : Craft::app()->categories;
74			$method = 'getGroupBy';
75			break;
76			case 'folder':
77			$service = Craft::app()->schematic_assetSources;
78			$method = 'getSourceBy';
79			break;
80			case 'taggroup':
81			$service = Craft::app()->tags;
82			$method = 'getTagGroupBy';
83			break;
84			case 'field':
85			$service = Craft::app()->fields;
86			$method = 'getFieldBy';
87			break;
88			}
89			} elseif ($source !== 'singles') {
90			//Backwards compatibility
91			$sourceType = 'section';
92			$sourceFrom = $source;
93			$service = Craft::app()->sections;
94			$method = 'getSectionBy';
95			}
96			var_dump($source);
			0 ignored issues – show Security Debugging Code introduced 2017-04-13 15:05 UTC by Report Bug Copy Issue Report `var_dump($source);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
97			var_dump($service);
			0 ignored issues – show Bug introduced 2017-04-13 14:57 UTC by Report Bug Copy Issue Report The variable `$service` 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...
98			var_dump($method);
			0 ignored issues – show Bug introduced 2017-04-13 14:57 UTC by Report Bug Copy Issue Report The variable `$method` 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...
99			var_dump($sourceFrom);
			0 ignored issues – show Bug introduced 2017-04-13 14:57 UTC by Report Bug Copy Issue Report The variable `$sourceFrom` 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...
100
101			if (isset($service) && isset($method) && isset($sourceFrom)) {
102			$method = $method.$indexFrom;
103			$sourceObject = $service->$method($sourceFrom);
104			var_dump($sourceObject);
105			}
106
107			if ($sourceObject && isset($sourceType)) {
108			return $sourceType.':'.$sourceObject->$indexTo;
109			}
110
111			return $source;
112			}
113			}
114

nerds-and-company / schematic

Pull Request — master (#93)

Sources::getSource() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like