NerdsAndCompany\Schematic\Services\CategoryGroups

Complexity

Total Complexity

17

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

39.29%

Importance

Changes	2
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	export()	0	12	2
A	getCategoryGroupDefinition()	0	12	1
A	getLocaleDefinition()	0	7	1
A	getLocaleDefinitions()	0	10	2
B	import()	0	31	6
A	populateCategoryGroup()	0	15	1
B	populateCategoryGroupLocales()	0	24	3
A	resetCraftCategoriesServiceCache()	0	11	1

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft\Craft;
use Craft\CategoryGroupModel;
use Craft\CategoryGroupLocaleModel;

/**
 * Schematic Category Groups Service.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2016, Nerds & Company
 * @license   MIT
 *
 * @link      http://www.nerds.company
 */
class CategoryGroups extends Base
{
    /**
     * Export categoryGroups.
     *
     * @param CategoryGroupModel[] $categoryGroups
     *
     * @return array
     */
    public function export(array $categoryGroups = [])
    {
        Craft::log(Craft::t('Exporting Category Groups'));

        $categoryGroupDefinitions = [];

        foreach ($categoryGroups as $categoryGroup) {
            $categoryGroupDefinitions[$categoryGroup->handle] = $this->getCategoryGroupDefinition($categoryGroup);
        }

        return $categoryGroupDefinitions;
    }

    /**
     * Get category groups definition.
     *
     * @param CategoryGroupModel $categoryGroup
     *
     * @return array
     */
    private function getCategoryGroupDefinition(CategoryGroupModel $categoryGroup)
    {
        $fieldLayout = Craft::app()->fields->getLayoutById($categoryGroup->fieldLayoutId);
        return [
            'name' => $categoryGroup->name,
            'hasUrls' => $categoryGroup->hasUrls,
            'template' => $categoryGroup->template,
            'maxLevels' => $categoryGroup->maxLevels,
            'locales' => $this->getLocaleDefinitions($categoryGroup->getLocales()),
            'fieldLayout' => Craft::app()->schematic_fields->getFieldLayoutDefinition($fieldLayout),
        ];
    }

    /**
     * Get locale definitions.
     *
     * @param CategoryGroupLocaleModel[] $locales
     *
     * @return array
     */
    private function getLocaleDefinitions(array $locales)
    {
        $localeDefinitions = [];

        foreach ($locales as $locale) {
            $localeDefinitions[$locale->locale] = $this->getLocaleDefinition($locale);
        }

        return $localeDefinitions;
    }

    /**
     * Get locale definition.
     *
     * @param CategoryGroupLocaleModel $locale
     *
     * @return array
     */
    private function getLocaleDefinition(CategoryGroupLocaleModel $locale)
    {
        return [
            'urlFormat' => $locale->urlFormat,
            'nestedUrlFormat' => $locale->nestedUrlFormat,
        ];
    }

    /**
     * Attempt to import category groups.
     *
     * @param array $categoryGroupDefinitions
     * @param bool  $force                If set to true category groups not included in the import will be deleted
     *
     * @return Result
     */
    public function import(array $categoryGroupDefinitions, $force = false)
    {
        Craft::log(Craft::t('Importing Category Groups'));

        $this->resetCraftCategoriesServiceCache();
        $categoryGroups = Craft::app()->categories->getAllGroups('handle');

        foreach ($categoryGroupDefinitions as $categoryGroupHandle => $categoryGroupDefinition) {
            $categoryGroup = array_key_exists($categoryGroupHandle, $categoryGroups)
                ? $categoryGroups[$categoryGroupHandle]
                : new CategoryGroupModel();

            unset($categoryGroups[$categoryGroupHandle]);

            $this->populateCategoryGroup($categoryGroup, $categoryGroupDefinition, $categoryGroupHandle);

            if (!Craft::app()->categories->saveGroup($categoryGroup)) { // Save categorygroup via craft
                $this->addErrors($categoryGroup->getAllErrors());

                continue;
            }
        }

        if ($force) {
            foreach ($categoryGroups as $categoryGroup) {
                Craft::app()->categories->deleteGroupById($categoryGroup->id);
            }
        }

        return $this->getResultModel();
    }

    /**
     * Populate categorygroup.
     *
     * @param CategoryGroupModel $categoryGroup
     * @param array          $categoryGroupDefinition
     * @param string         $categoryGroupHandle
     */
    private function populateCategoryGroup(CategoryGroupModel $categoryGroup, array $categoryGroupDefinition, $categoryGroupHandle)
    {
        $categoryGroup->setAttributes([
            'handle' => $categoryGroupHandle,
            'name' => $categoryGroupDefinition['name'],
            'hasUrls' => $categoryGroupDefinition['hasUrls'],
            'template' => $categoryGroupDefinition['template'],
            'maxLevels' => $categoryGroupDefinition['maxLevels'],
        ]);

        $this->populateCategoryGroupLocales($categoryGroup, $categoryGroupDefinition['locales']);

        $fieldLayout = Craft::app()->schematic_fields->getFieldLayout($categoryGroupDefinition['fieldLayout']);
        $categoryGroup->setFieldLayout($fieldLayout);
    }

    /**
     * Populate section locales.
     *
     * @param CategoryGroupModel $categoryGroup
     * @param $localeDefinitions
     */
    private function populateCategoryGroupLocales(CategoryGroupModel $categoryGroup, $localeDefinitions)
    {
        $locales = $categoryGroup->getLocales();

        foreach ($localeDefinitions as $localeId => $localeDef) {
            $locale = array_key_exists($localeId, $locales) ? $locales[$localeId] : new CategoryGroupLocaleModel();

            $locale->setAttributes([
                'locale' => $localeId,
                'urlFormat' => $localeDef['urlFormat'],
                'nestedUrlFormat' => $localeDef['nestedUrlFormat'],
            ]);

            // Todo: Is this a hack? I don't see another way.
            // Todo: Might need a sorting order as well? It's NULL at the moment.
            Craft::app()->db->createCommand()->insertOrUpdate('locales', [
                'locale' => $locale->locale,
            ], []);

            $locales[$localeId] = $locale;
        }

        $categoryGroup->setLocales($locales);
    }

    /**
     * Reset craft fields service cache using reflection
     */
    private function resetCraftCategoriesServiceCache()
    {
        $obj         = Craft::app()->categories;
        $refObject   = new \ReflectionObject($obj);
        $refProperty = $refObject->getProperty('_fetchedAllCategoryGroups');
        $refProperty->setAccessible(true);
        $refProperty->setValue($obj, false);
        $refProperty = $refObject->getProperty('_categoryGroupsById');
        $refProperty->setAccessible(true);
        $refProperty->setValue($obj, array());
    }
}