SourcesBehavior::getFolderById() - Code Metrics - Inspection of "Asset folders fix" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#160)

by Bart

created 2018-09-24 11:43 UTC

SourcesBehavior::getFolderById() A

↳ Parent: SourcesBehavior

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2.0116

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	6
cts	7
cp	0.8571
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2.0116

<?php

namespace NerdsAndCompany\Schematic\Behaviors;

use Craft;
use TypeError;
use yii\base\Behavior;
use craft\base\Model;
use craft\records\VolumeFolder;
use NerdsAndCompany\Schematic\Schematic;
use NerdsAndCompany\Schematic\Events\SourceMappingEvent;

/**
 * Schematic Sources Behavior.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class SourcesBehavior extends Behavior
{
    /**
     * Recursively find sources in definition attributes.
     *
     * @param string $fieldType
     * @param array  $attributes
     * @param string $indexFrom
     * @param string $indexTo
     *
     * @return array
     */
    public function findSources(string $fieldType, array $attributes, string $indexFrom, string $indexTo): array
    {
        foreach ($attributes as $key => $attribute) {
            if ($key === 'source') {
                $attributes[$key] = $this->getSource($fieldType, $attribute, $indexFrom, $indexTo);
            } elseif ($key === 'sources') {
                $attributes[$key] = $this->getSources($fieldType, $attribute, $indexFrom, $indexTo);
            } elseif (is_array($attribute)) {
                $attributes[$key] = $this->findSources($fieldType, $attribute, $indexFrom, $indexTo);
            }
        }

        return $attributes;
    }

    /**
     * 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 getSources(string $fieldType, $sources, string $indexFrom, string $indexTo)
    {
        $mappedSources = $sources;
        if (is_array($sources)) {
            $mappedSources = [];
            $sources = array_filter($sources);
            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|null
     *
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     * @SuppressWarnings(PHPMD.NPathComplexity)
     */
    public function getSource(string $fieldType, string $source = null, string $indexFrom, string $indexTo)
    {
        if (false === strpos($source, ':')) {
            return $source;
        }

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

        // Get service and method by source
        list($sourceType, $sourceFrom) = explode(':', $source);
        switch ($sourceType) {
            case 'editSite':
                $service = Craft::$app->sites;
                $method = 'getSiteBy';
                break;
            case 'single':
            case 'section':
            case 'createEntries':
            case 'editPeerEntries':
            case 'deleteEntries':
            case 'deletePeerEntries':
            case 'deletePeerEntryDrafts':
            case 'editEntries':
            case 'editPeerEntryDrafts':
            case 'publishEntries':
            case 'publishPeerEntries':
            case 'publishPeerEntryDrafts':
                $service = Craft::$app->sections;
                $method = 'getSectionBy';
                break;
            case 'group':
            case 'editCategories':
                $service = 'Users' == $fieldType ? Craft::$app->userGroups : Craft::$app->categories;
                $method = 'getGroupBy';
                break;
            case 'folder':
                $service = $this;
                $method = 'getFolderBy';
                break;
            case 'createFoldersInVolume':
            case 'deleteFilesAndFoldersInVolume':
            case 'saveAssetInVolume':
            case 'viewVolume':
                $service = Craft::$app->volumes;
                $method = 'getVolumeBy';
                break;
            case 'taggroup':
                $service = Craft::$app->tags;
                $method = 'getTagGroupBy';
                break;
            case 'field':
                $service = Craft::$app->fields;
                $method = 'getFieldBy';
                break;
            case 'editGlobalSet':
                $service = Craft::$app->globals;
                $method = 'getSetBy';
                break;
            case 'utility':
                return $source;
        }

        // Send event
        $plugin = Craft::$app->controller->module;
        $event = new SourceMappingEvent([
            'source' => $source,
            'service' => $service ?? null,
            'method' => $method ?? null,
        ]);
        $plugin->trigger($plugin::EVENT_MAP_SOURCE, $event);
        $service = $event->service;
        $method = $event->method;

        // Try service and method
        if (isset($service) && isset($method) && isset($sourceFrom)) {
            $method = $method.ucfirst($indexFrom);
            try {
                $sourceObject = $service->$method($sourceFrom);

            } catch (TypeError $e) {
                Schematic::error('An error occured mapping source '.$source.' from '.$indexFrom.' to '.$indexTo);
                Schematic::error($e->getMessage());

                return null;
            }
        }

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

        Schematic::warning('No mapping found for source '.$source);

        return null;
    }

    /**
     * Get a folder by id
     *
     * @param int $folderId
     * @return object
     */
    private function getFolderById(int $folderId): object
    {
        $folder = Craft::$app->assets->getFolderById($folderId);
        if ($folder) {
            $volume = $folder->getVolume();
            return  (object) [
                'id' => $folderId,
                'handle' => $volume->handle
            ];
        }
        return null;
    }

    /**
     * Get a folder by handle
     *
     * @param string $folderHandle
     * @return object
     */
    private function getFolderByHandle(string $folderHandle): object
    {
        $volume = Craft::$app->volumes->getVolumeByHandle($folderHandle);
        $folder = VolumeFolder::findOne(['volumeId' => $volume->id]);
        return  (object) [
            'id' => $folder->id,
            'handle' => $folderHandle
        ];
    }
}


1		<?php
2
3		namespace NerdsAndCompany\Schematic\Behaviors;
4
5		use Craft;
6		use TypeError;
7		use yii\base\Behavior;
8		use craft\base\Model;
9		use craft\records\VolumeFolder;
10		use NerdsAndCompany\Schematic\Schematic;
11		use NerdsAndCompany\Schematic\Events\SourceMappingEvent;
12
13		/**
14		* Schematic Sources Behavior.
15		*
16		* Sync Craft Setups.
17		*
18		* @author Nerds & Company
19		* @copyright Copyright (c) 2015-2018, Nerds & Company
20		* @license MIT
21		*
22		* @see http://www.nerds.company
23		*/
24		class SourcesBehavior extends Behavior
25		{
26		/**
27		* Recursively find sources in definition attributes.
28		*
29		* @param string $fieldType
30		* @param array $attributes
31		* @param string $indexFrom
32		* @param string $indexTo
33		*
34		* @return array
35		*/
36	31	public function findSources(string $fieldType, array $attributes, string $indexFrom, string $indexTo): array
37		{
38	31	foreach ($attributes as $key => $attribute) {
39	31	if ($key === 'source') {
40	3	$attributes[$key] = $this->getSource($fieldType, $attribute, $indexFrom, $indexTo);
41	31	} elseif ($key === 'sources') {
42	3	$attributes[$key] = $this->getSources($fieldType, $attribute, $indexFrom, $indexTo);
43	31	} elseif (is_array($attribute)) {
44	31	$attributes[$key] = $this->findSources($fieldType, $attribute, $indexFrom, $indexTo);
45		}
46		}
47
48	31	return $attributes;
49		}
50
51		/**
52		* Get sources based on the indexFrom attribute and return them with the indexTo attribute.
53		*
54		* @param string $fieldType
55		* @param string\|array $sources
56		* @param string $indexFrom
57		* @param string $indexTo
58		*
59		* @return array\|string
60		*/
61	8	public function getSources(string $fieldType, $sources, string $indexFrom, string $indexTo)
62		{
63	8	$mappedSources = $sources;
64	8	if (is_array($sources)) {
65	6	$mappedSources = [];
66	6	$sources = array_filter($sources);
67	6	foreach ($sources as $source) {
68	6	$mappedSources[] = $this->getSource($fieldType, $source, $indexFrom, $indexTo);
69		}
70		}
71
72	8	return $mappedSources;
73		}
74
75		/**
76		* Gets a source by the attribute indexFrom, and returns it with attribute $indexTo.
77		*
78		* @TODO Break up and simplify this method
79		*
80		* @param string $fieldType
81		* @param string $source
82		* @param string $indexFrom
83		* @param string $indexTo
84		*
85		* @return string\|null
86		*
87		* @SuppressWarnings(PHPMD.CyclomaticComplexity)
88		* @SuppressWarnings(PHPMD.NPathComplexity)
89		*/
90	9	public function getSource(string $fieldType, string $source = null, string $indexFrom, string $indexTo)
91		{
92	9	if (false === strpos($source, ':')) {
93	6	return $source;
94		}
95
96		/** @var Model $sourceObject */
97	9	$sourceObject = null;
98
99		// Get service and method by source
100	9	list($sourceType, $sourceFrom) = explode(':', $source);
101		switch ($sourceType) {
102	9	case 'editSite':
103		$service = Craft::$app->sites;
104		$method = 'getSiteBy';
105		break;
106	9	case 'single':
107	9	case 'section':
108	9	case 'createEntries':
109	9	case 'editPeerEntries':
110	9	case 'deleteEntries':
111	9	case 'deletePeerEntries':
112	9	case 'deletePeerEntryDrafts':
113	9	case 'editEntries':
114	9	case 'editPeerEntryDrafts':
115	9	case 'publishEntries':
116	9	case 'publishPeerEntries':
117	9	case 'publishPeerEntryDrafts':
118	5	$service = Craft::$app->sections;
119	5	$method = 'getSectionBy';
120	5	break;
121	9	case 'group':
122	7	case 'editCategories':
123	5	$service = 'Users' == $fieldType ? Craft::$app->userGroups : Craft::$app->categories;
124	5	$method = 'getGroupBy';
125	5	break;
126	7	case 'folder':
127	2	$service = $this;
128	2	$method = 'getFolderBy';
129	2	break;
130	5	case 'createFoldersInVolume':
131	5	case 'deleteFilesAndFoldersInVolume':
132	5	case 'saveAssetInVolume':
133	5	case 'viewVolume':
134	3	$service = Craft::$app->volumes;
135	3	$method = 'getVolumeBy';
136	3	break;
137	2	case 'taggroup':
138		$service = Craft::$app->tags;
139		$method = 'getTagGroupBy';
140		break;
141	2	case 'field':
142	2	$service = Craft::$app->fields;
143	2	$method = 'getFieldBy';
144	2	break;
145		case 'editGlobalSet':
146		$service = Craft::$app->globals;
147		$method = 'getSetBy';
148		break;
149		case 'utility':
150		return $source;
151		}
152
153		// Send event
154	9	$plugin = Craft::$app->controller->module;
155	9	$event = new SourceMappingEvent([
156	9	'source' => $source,
157	9	'service' => $service ?? null,
158	9	'method' => $method ?? null,
159		]);
160	9	$plugin->trigger($plugin::EVENT_MAP_SOURCE, $event);
161	9	$service = $event->service;
162	9	$method = $event->method;
163
164		// Try service and method
165	9	if (isset($service) && isset($method) && isset($sourceFrom)) {
166	9	$method = $method.ucfirst($indexFrom);
167		try {
168	9	$sourceObject = $service->$method($sourceFrom);
		0 ignored issues – show Bug introduced 2018-09-10 12:54 UTC by Report Bug Copy Issue Report The method `$method` cannot be called on `$service` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
169	2	} catch (TypeError $e) {
170	1	Schematic::error('An error occured mapping source '.$source.' from '.$indexFrom.' to '.$indexTo);
171	1	Schematic::error($e->getMessage());
172
173	1	return null;
174		}
175		}
176
177	7	if ($sourceObject) {
178	6	return $sourceType.':'.$sourceObject->$indexTo;
179		}
180
181	1	Schematic::warning('No mapping found for source '.$source);
182
183	1	return null;
184		}
185
186		/**
187		* Get a folder by id
188		*
189		* @param int $folderId
190		* @return object
191		*/
192	1	private function getFolderById(int $folderId): object
193		{
194	1	$folder = Craft::$app->assets->getFolderById($folderId);
195	1	if ($folder) {
196	1	$volume = $folder->getVolume();
197		return (object) [
198	1	'id' => $folderId,
199	1	'handle' => $volume->handle
200		];
201		}
202		return null;
203		}
204
205		/**
206		* Get a folder by handle
207		*
208		* @param string $folderHandle
209		* @return object
210		*/
211	1	private function getFolderByHandle(string $folderHandle): object
212		{
213	1	$volume = Craft::$app->volumes->getVolumeByHandle($folderHandle);
214	1	$folder = VolumeFolder::findOne(['volumeId' => $volume->id]);
215		return (object) [
216		'id' => $folder->id,
217		'handle' => $folderHandle
218		];
219		}
220		}
221

nerds-and-company / schematic

Pull Request — master (#160)

SourcesBehavior::getFolderById() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like