NerdsAndCompany\Schematic\Behaviors\SourcesBehavior

Complexity

Total Complexity

48

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

83.78%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	findSources()	0	14	5
A	getSources()	0	13	3
A	getFolderById()	0	12	2
A	getFolderByVolumeId()	0	4	2
A	setMockFolder()	0	4	1
A	getFolderByHandle()	0	14	3
F	getSource()	0	95	32

<?php

namespace NerdsAndCompany\Schematic\Behaviors;

use Craft;
use TypeError;
use yii\base\Behavior;
use craft\base\Model;
use craft\records\VolumeFolder;
use craft\fields\Users;
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
{
    /** Hack to be able to avoid the active record call in VolumeFolder::findOne() */
    public $mockFolder = null;

    /**
     * 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::class == $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);

The method $method cannot be called on $service (of type string).

            } 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
     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
     *
     * @param int $folderId
     * @return object
     */
    private function getFolderById(int $folderId): \stdClass
    {
        $folder = Craft::$app->assets->getFolderById($folderId);
        if ($folder) {
            $volume = $folder->getVolume();
            return  (object) [
                'id' => $folderId,
                'handle' => $volume->handle
            ];
        }
        return null;
    }

    /**
     * Get folder by volume id
     *
     * @param int $volumeId
     * @return VolumeFolder
     */
    private function getFolderByVolumeId(int $volumeId): VolumeFolder
    {
        return $this->mockFolder ? $this->mockFolder : VolumeFolder::findOne(['volumeId' => $volumeId]);
    }

    /**
     * Set a mock folder for the tests
     *
     * @param VolumeFolder $mockFolder
     */
    public function setMockFolder(VolumeFolder $mockFolder)
    {
        $this->mockFolder = $mockFolder;
    }

    /**
     * Get a folder by volume handle
     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
     *
     * @param string $folderHandle
     * @return object
     */
    private function getFolderByHandle(string $folderHandle): \stdClass
    {
        $volume = Craft::$app->volumes->getVolumeByHandle($folderHandle);
        if ($volume) {
            $folder = $this->getFolderByVolumeId($volume->id);
            if ($folder) {
                return  (object) [
                    'id' => $folder->id,
                    'handle' => $folderHandle
                ];
            }
        }
        return null;
    }
}