CategoryGroups::export() - Code Metrics - Inspection of "Clear craft category gorups cache before importing..." - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 07eadb...49cf5c )

by Bart

created 2016-05-22 19:25 UTC

CategoryGroups::export() A

↳ Parent: CategoryGroups

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

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

<?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);
        if ($refObject->hasProperty('_fetchedAllCategoryGroups')) {
            $refProperty = $refObject->getProperty('_fetchedAllCategoryGroups');
            $refProperty->setAccessible(true);
            $refProperty->setValue($obj, false);
        }
        if ($refObject->hasProperty('_categoryGroupsById')) {
            $refProperty = $refObject->getProperty('_categoryGroupsById');
            $refProperty->setAccessible(true);
            $refProperty->setValue($obj, array());
        }
    }
}


1		<?php
2
3		namespace NerdsAndCompany\Schematic\Services;
4
5		use Craft\Craft;
6		use Craft\CategoryGroupModel;
7		use Craft\CategoryGroupLocaleModel;
8
9		/**
10		* Schematic Category Groups Service.
11		*
12		* Sync Craft Setups.
13		*
14		* @author Nerds & Company
15		* @copyright Copyright (c) 2015-2016, Nerds & Company
16		* @license MIT
17		*
18		* @link http://www.nerds.company
19		*/
20		class CategoryGroups extends Base
21		{
22		/**
23		* Export categoryGroups.
24		*
25		* @param CategoryGroupModel[] $categoryGroups
26		*
27		* @return array
28		*/
29	3	public function export(array $categoryGroups = [])
30		{
31	3	Craft::log(Craft::t('Exporting Category Groups'));
32
33	3	$categoryGroupDefinitions = [];
34
35	3	foreach ($categoryGroups as $categoryGroup) {
36	2	$categoryGroupDefinitions[$categoryGroup->handle] = $this->getCategoryGroupDefinition($categoryGroup);
37	3	}
38
39	3	return $categoryGroupDefinitions;
40		}
41
42		/**
43		* Get category groups definition.
44		*
45		* @param CategoryGroupModel $categoryGroup
46		*
47		* @return array
48		*/
49	4	private function getCategoryGroupDefinition(CategoryGroupModel $categoryGroup)
50		{
51	2	$fieldLayout = Craft::app()->fields->getLayoutById($categoryGroup->fieldLayoutId);
52		return [
53	2	'name' => $categoryGroup->name,
54	2	'hasUrls' => $categoryGroup->hasUrls,
55	2	'template' => $categoryGroup->template,
56	4	'maxLevels' => $categoryGroup->maxLevels,
57	2	'locales' => $this->getLocaleDefinitions($categoryGroup->getLocales()),
58	2	'fieldLayout' => Craft::app()->schematic_fields->getFieldLayoutDefinition($fieldLayout),
59	2	];
60		}
61
62		/**
63		* Get locale definitions.
64		*
65		* @param CategoryGroupLocaleModel[] $locales
66		*
67		* @return array
68		*/
69	2	private function getLocaleDefinitions(array $locales)
70		{
71	2	$localeDefinitions = [];
72
73	2	foreach ($locales as $locale) {
74	2	$localeDefinitions[$locale->locale] = $this->getLocaleDefinition($locale);
75	2	}
76
77	2	return $localeDefinitions;
78		}
79
80		/**
81		* Get locale definition.
82		*
83		* @param CategoryGroupLocaleModel $locale
84		*
85		* @return array
86		*/
87	2	private function getLocaleDefinition(CategoryGroupLocaleModel $locale)
88		{
89		return [
90	2	'urlFormat' => $locale->urlFormat,
91	2	'nestedUrlFormat' => $locale->nestedUrlFormat,
92	2	];
93		}
94
95		/**
96		* Attempt to import category groups.
97		*
98		* @param array $categoryGroupDefinitions
99		* @param bool $force If set to true category groups not included in the import will be deleted
100		*
101		* @return Result
102		*/
103	4	public function import(array $categoryGroupDefinitions, $force = false)
104		{
105	4	Craft::log(Craft::t('Importing Category Groups'));
106
107	4	$this->resetCraftCategoriesServiceCache();
108	4	$categoryGroups = Craft::app()->categories->getAllGroups('handle');
109
110	4	foreach ($categoryGroupDefinitions as $categoryGroupHandle => $categoryGroupDefinition) {
111	2	$categoryGroup = array_key_exists($categoryGroupHandle, $categoryGroups)
112	2	? $categoryGroups[$categoryGroupHandle]
113	2	: new CategoryGroupModel();
114
115	2	unset($categoryGroups[$categoryGroupHandle]);
116
117	2	$this->populateCategoryGroup($categoryGroup, $categoryGroupDefinition, $categoryGroupHandle);
118
119	2	if (!Craft::app()->categories->saveGroup($categoryGroup)) { // Save categorygroup via craft
120	2	$this->addErrors($categoryGroup->getAllErrors());
121
122	2	continue;
123		}
124	4	}
125
126	4	if ($force) {
127	2	foreach ($categoryGroups as $categoryGroup) {
128		Craft::app()->categories->deleteGroupById($categoryGroup->id);
129	2	}
130	2	}
131
132	4	return $this->getResultModel();
133		}
134
135		/**
136		* Populate categorygroup.
137		*
138		* @param CategoryGroupModel $categoryGroup
139		* @param array $categoryGroupDefinition
140		* @param string $categoryGroupHandle
141		*/
142	2	private function populateCategoryGroup(CategoryGroupModel $categoryGroup, array $categoryGroupDefinition, $categoryGroupHandle)
143		{
144	2	$categoryGroup->setAttributes([
145	2	'handle' => $categoryGroupHandle,
146	2	'name' => $categoryGroupDefinition['name'],
147	2	'hasUrls' => $categoryGroupDefinition['hasUrls'],
148	2	'template' => $categoryGroupDefinition['template'],
149	2	'maxLevels' => $categoryGroupDefinition['maxLevels'],
150	2	]);
151
152	2	$this->populateCategoryGroupLocales($categoryGroup, $categoryGroupDefinition['locales']);
153
154	2	$fieldLayout = Craft::app()->schematic_fields->getFieldLayout($categoryGroupDefinition['fieldLayout']);
155	2	$categoryGroup->setFieldLayout($fieldLayout);
156	2	}
157
158		/**
159		* Populate section locales.
160		*
161		* @param CategoryGroupModel $categoryGroup
162		* @param $localeDefinitions
163		*/
164	2	private function populateCategoryGroupLocales(CategoryGroupModel $categoryGroup, $localeDefinitions)
165		{
166	2	$locales = $categoryGroup->getLocales();
167
168	2	foreach ($localeDefinitions as $localeId => $localeDef) {
169	2	$locale = array_key_exists($localeId, $locales) ? $locales[$localeId] : new CategoryGroupLocaleModel();
170
171	2	$locale->setAttributes([
172	2	'locale' => $localeId,
173	2	'urlFormat' => $localeDef['urlFormat'],
174	2	'nestedUrlFormat' => $localeDef['nestedUrlFormat'],
175	2	]);
176
177		// Todo: Is this a hack? I don't see another way.
178		// Todo: Might need a sorting order as well? It's NULL at the moment.
179	2	Craft::app()->db->createCommand()->insertOrUpdate('locales', [
180	2	'locale' => $locale->locale,
181	2	], []);
182
183	2	$locales[$localeId] = $locale;
184	2	}
185
186	2	$categoryGroup->setLocales($locales);
187	2	}
188
189		/**
190		* Reset craft fields service cache using reflection
191		*/
192	4	private function resetCraftCategoriesServiceCache()
193		{
194	4	$obj = Craft::app()->categories;
195	4	$refObject = new \ReflectionObject($obj);
196	4	if ($refObject->hasProperty('_fetchedAllCategoryGroups')) {
197		$refProperty = $refObject->getProperty('_fetchedAllCategoryGroups');
198		$refProperty->setAccessible(true);
199		$refProperty->setValue($obj, false);
200		}
201	4	if ($refObject->hasProperty('_categoryGroupsById')) {
202		$refProperty = $refObject->getProperty('_categoryGroupsById');
203		$refProperty->setAccessible(true);
204		$refProperty->setValue($obj, array());
205		}
206	4	}
207		}
208

nerds-and-company / schematic

Push — master ( 07eadb...49cf5c )

CategoryGroups::export() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like