Volumes::getRecords() - Code Metrics - Inspection of "Refactor for Craft3" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#114)

by Bart

created 2018-04-03 14:18 UTC

Volumes::getRecords() A

↳ Parent: Volumes

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 NerdsAndCompany\Schematic\Services;

use \Craft;
use craft\base\VolumeInterface;

/**
 * Schematic Asset Sources Service.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class Volumes extends Base
{
    //==============================================================================================================
    //================================================  EXPORT  ====================================================
    //==============================================================================================================

    /**
     * Get all asset transforms
     *
     * @return VolumeInterface[]
     */
    protected function getRecords()
    {
        return Craft::$app->volumes->getAllVolumes();
    }

    //==============================================================================================================
    //================================================  IMPORT  ====================================================
    //==============================================================================================================

    /**
     * Import asset source definitions.
     *
     * @param array $assetSourceDefinitions
     * @param bool  $force
     *
     * @return Result
     */
    public function import($force = false, array $assetSourceDefinitions = null)
    {
        Craft::info('Importing Asset Sources', 'schematic');

        $this->resetCraftAssetSourcesServiceCache();
        $assetSources = $this->getAssetSourcesService()->getAllSources('handle');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        foreach ($assetSourceDefinitions as $assetSourceHandle => $assetSourceDefinition) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $assetSource = array_key_exists($assetSourceHandle, $assetSources)
                ? $assetSources[$assetSourceHandle]
                : new AssetSourceModel();

            unset($assetSources[$assetSourceHandle]);

            $this->populateAssetSource($assetSource, $assetSourceDefinition, $assetSourceHandle);

            if (!$this->getAssetSourcesService()->saveSource($assetSource)) { // Save assetsource via craft
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                $this->addErrors($assetSource->getAllErrors());
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

                continue;
            }
        }

        if ($force) {
            foreach ($assetSources as $assetSource) {
                $this->getAssetSourcesService()->deleteSourceById($assetSource->id);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }
        }

        return $this->getResultModel();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Populate asset source.
     *
     * @param AssetSourceModel $assetSource
     * @param array            $assetSourceDefinition
     * @param string           $assetSourceHandle
     *
     * @return AssetSourceModel
     */
    private function populateAssetSource(AssetSourceModel $assetSource, array $assetSourceDefinition, $assetSourceHandle)
    {
        $defaultAssetSourceSettings = array(
            'publicURLs' => true,
        );

        $assetSource->setAttributes([
            'handle' => $assetSourceHandle,
            'type' => $assetSourceDefinition['type'],
            'name' => $assetSourceDefinition['name'],
            'sortOrder' => $assetSourceDefinition['sortOrder'],
            'settings' => array_merge($defaultAssetSourceSettings, $assetSourceDefinition['settings']),
        ]);

        if (array_key_exists('fieldLayout', $assetSourceDefinition)) {
            $fieldLayout = Craft::$app->schematic_fields->getFieldLayout($assetSourceDefinition['fieldLayout']);
            $assetSource->setFieldLayout($fieldLayout);
        }

        return $assetSource;
    }

    /**
     * Reset craft fields service cache using reflection.
     */
    private function resetCraftAssetSourcesServiceCache()
    {
        $obj = $this->getAssetSourcesService();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $refObject = new \ReflectionObject($obj);
        if ($refObject->hasProperty('_fetchedAllSources')) {
            $refProperty = $refObject->getProperty('_fetchedAllSources');
            $refProperty->setAccessible(true);
            $refProperty->setValue($obj, false);
        }
        if ($refObject->hasProperty('_sourcesById')) {
            $refProperty = $refObject->getProperty('_sourcesById');
            $refProperty->setAccessible(true);
            $refProperty->setValue($obj, array());
        }
    }
}


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Services;
4
5			use \Craft;
6			use craft\base\VolumeInterface;
7
8			/**
9			* Schematic Asset Sources Service.
10			*
11			* Sync Craft Setups.
12			*
13			* @author Nerds & Company
14			* @copyright Copyright (c) 2015-2018, Nerds & Company
15			* @license MIT
16			*
17			* @see http://www.nerds.company
18			*/
19			class Volumes extends Base
20			{
21			//==============================================================================================================
22			//================================================ EXPORT ====================================================
23			//==============================================================================================================
24
25			/**
26			* Get all asset transforms
27			*
28			* @return VolumeInterface[]
29			*/
30			protected function getRecords()
31			{
32			return Craft::$app->volumes->getAllVolumes();
33			}
34
35			//==============================================================================================================
36			//================================================ IMPORT ====================================================
37			//==============================================================================================================
38
39			/**
40			* Import asset source definitions.
41			*
42			* @param array $assetSourceDefinitions
43			* @param bool $force
44			*
45			* @return Result
46			*/
47			public function import($force = false, array $assetSourceDefinitions = null)
48			{
49			Craft::info('Importing Asset Sources', 'schematic');
50
51			$this->resetCraftAssetSourcesServiceCache();
52			$assetSources = $this->getAssetSourcesService()->getAllSources('handle');
			0 ignored issues – show Documentation Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report The method `getAssetSourcesService` does not exist on `object<NerdsAndCompany\S...matic\Services\Volumes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
53
54			foreach ($assetSourceDefinitions as $assetSourceHandle => $assetSourceDefinition) {
			0 ignored issues – show Bug introduced 2018-04-03 09:26 UTC by Report Bug Copy Issue Report The expression `$assetSourceDefinitions` of type `null\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
55			$assetSource = array_key_exists($assetSourceHandle, $assetSources)
56			? $assetSources[$assetSourceHandle]
57			: new AssetSourceModel();
58
59			unset($assetSources[$assetSourceHandle]);
60
61			$this->populateAssetSource($assetSource, $assetSourceDefinition, $assetSourceHandle);
62
63			if (!$this->getAssetSourcesService()->saveSource($assetSource)) { // Save assetsource via craft
			0 ignored issues – show Documentation Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report The method `getAssetSourcesService` does not exist on `object<NerdsAndCompany\S...matic\Services\Volumes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
64			$this->addErrors($assetSource->getAllErrors());
			0 ignored issues – show Documentation Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report The method `addErrors` does not exist on `object<NerdsAndCompany\S...matic\Services\Volumes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
65
66			continue;
67			}
68			}
69
70			if ($force) {
71			foreach ($assetSources as $assetSource) {
72			$this->getAssetSourcesService()->deleteSourceById($assetSource->id);
			0 ignored issues – show Documentation Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report The method `getAssetSourcesService` does not exist on `object<NerdsAndCompany\S...matic\Services\Volumes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
73			}
74			}
75
76			return $this->getResultModel();
			0 ignored issues – show Documentation Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report The method `getResultModel` does not exist on `object<NerdsAndCompany\S...matic\Services\Volumes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
77			}
78
79			/**
80			* Populate asset source.
81			*
82			* @param AssetSourceModel $assetSource
83			* @param array $assetSourceDefinition
84			* @param string $assetSourceHandle
85			*
86			* @return AssetSourceModel
87			*/
88			private function populateAssetSource(AssetSourceModel $assetSource, array $assetSourceDefinition, $assetSourceHandle)
89			{
90			$defaultAssetSourceSettings = array(
91			'publicURLs' => true,
92			);
93
94			$assetSource->setAttributes([
95			'handle' => $assetSourceHandle,
96			'type' => $assetSourceDefinition['type'],
97			'name' => $assetSourceDefinition['name'],
98			'sortOrder' => $assetSourceDefinition['sortOrder'],
99			'settings' => array_merge($defaultAssetSourceSettings, $assetSourceDefinition['settings']),
100			]);
101
102			if (array_key_exists('fieldLayout', $assetSourceDefinition)) {
103			$fieldLayout = Craft::$app->schematic_fields->getFieldLayout($assetSourceDefinition['fieldLayout']);
104			$assetSource->setFieldLayout($fieldLayout);
105			}
106
107			return $assetSource;
108			}
109
110			/**
111			* Reset craft fields service cache using reflection.
112			*/
113			private function resetCraftAssetSourcesServiceCache()
114			{
115			$obj = $this->getAssetSourcesService();
			0 ignored issues – show Documentation Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report The method `getAssetSourcesService` does not exist on `object<NerdsAndCompany\S...matic\Services\Volumes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
116			$refObject = new \ReflectionObject($obj);
117			if ($refObject->hasProperty('_fetchedAllSources')) {
118			$refProperty = $refObject->getProperty('_fetchedAllSources');
119			$refProperty->setAccessible(true);
120			$refProperty->setValue($obj, false);
121			}
122			if ($refObject->hasProperty('_sourcesById')) {
123			$refProperty = $refObject->getProperty('_sourcesById');
124			$refProperty->setAccessible(true);
125			$refProperty->setValue($obj, array());
126			}
127			}
128			}
129

nerds-and-company / schematic

Pull Request — master (#114)

Volumes::getRecords() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like