Sections - 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-04 13:51 UTC

Sections A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	14
lcom	0
cbo	5
dl	0
loc	88
rs	10
c	0
b	0
f	0
ccs	0
cts	29
cp	0

4 Methods

Rating	Name	Size	Complexity
A	getRecords()	4	1
A	getRecordDefinition()	19	4
B	saveRecord()	24	6
A	deleteRecord()	10	3

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft;
use craft\base\Model;
use craft\models\Section;
use craft\models\EntryType;
use craft\models\Section_SiteSettings;

/**
 * Schematic Sections.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class Sections extends Base
{
    /**
     * Get all section records
     *
     * @return Section[]
     */
    protected function getRecords()
    {
        return Craft::$app->sections->getAllSections();
    }

    /**
     * Get section definition.
     *
     * @param Model $record
     *
     * @return array
     */
    protected function getRecordDefinition(Model $record)
    {
        $definition = parent::getRecordDefinition($record);
        if ($record instanceof Section) {
            $definition['entryTypes'] = $this->export($record->getEntryTypes());
            $definition['siteSettings'] = [];
            foreach ($record->getSiteSettings() as $siteSetting) {
                $attributes = $siteSetting->attributes;
                unset($attributes['sectionId']);
                unset($attributes['id']);
                $definition['siteSettings'][] = $attributes;
            }
        }
        if ($record instanceof EntryType) {
            unset($definition['attributes']['sectionId']);
        }

        return $definition;
    }

    /**
     * Save a record
     *
     * @param Model $record
     * @param array $definition
     * @return boolean
     */
    protected function saveRecord(Model $record, array $definition)
    {
        $record->setAttributes($definition['attributes']);
        if ($record instanceof Section) {
            $siteSettings = [];
            foreach ($definition['siteSettings'] as $siteSettingDefinition) {
                $siteSettings[] = new Section_SiteSettings($siteSettingDefinition);
            }
            $record->setSiteSettings($siteSettings);
            if (Craft::$app->sections->saveSection($record)) {
                parent::import($definition['entryTypes'], $record->getEntryTypes(), ['sectionId' => $record->id]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
                return true;
            }
        }

        if ($record instanceof EntryType) {
            if ($definition['fieldLayout']) {
                $record->setFieldLayout($this->getFieldLayout($definition['fieldLayout']));
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 Craft::$app->sections->saveEntryType($record);
        }

        return false;
    }

    /**
     * Delete a record
     *
     * @param Model $record
     * @return boolean
     */
    protected function deleteRecord(Model $record)
    {
        if ($record instanceof Section) {
            return Craft::$app->sections->deleteSection($record);
        }
        if ($record instanceof EntryType) {
            return Craft::$app->sections->deleteEntryType($record);
        }
        return false;
    }
}


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Services;
4
5			use Craft;
6			use craft\base\Model;
7			use craft\models\Section;
8			use craft\models\EntryType;
9			use craft\models\Section_SiteSettings;
10
11			/**
12			* Schematic Sections.
13			*
14			* Sync Craft Setups.
15			*
16			* @author Nerds & Company
17			* @copyright Copyright (c) 2015-2018, Nerds & Company
18			* @license MIT
19			*
20			* @see http://www.nerds.company
21			*/
22			class Sections extends Base
23			{
24			/**
25			* Get all section records
26			*
27			* @return Section[]
28			*/
29			protected function getRecords()
30			{
31			return Craft::$app->sections->getAllSections();
32			}
33
34			/**
35			* Get section definition.
36			*
37			* @param Model $record
38			*
39			* @return array
40			*/
41			protected function getRecordDefinition(Model $record)
42			{
43			$definition = parent::getRecordDefinition($record);
44			if ($record instanceof Section) {
45			$definition['entryTypes'] = $this->export($record->getEntryTypes());
46			$definition['siteSettings'] = [];
47			foreach ($record->getSiteSettings() as $siteSetting) {
48			$attributes = $siteSetting->attributes;
49			unset($attributes['sectionId']);
50			unset($attributes['id']);
51			$definition['siteSettings'][] = $attributes;
52			}
53			}
54			if ($record instanceof EntryType) {
55			unset($definition['attributes']['sectionId']);
56			}
57
58			return $definition;
59			}
60
61			/**
62			* Save a record
63			*
64			* @param Model $record
65			* @param array $definition
66			* @return boolean
67			*/
68			protected function saveRecord(Model $record, array $definition)
69			{
70			$record->setAttributes($definition['attributes']);
71			if ($record instanceof Section) {
72			$siteSettings = [];
73			foreach ($definition['siteSettings'] as $siteSettingDefinition) {
74			$siteSettings[] = new Section_SiteSettings($siteSettingDefinition);
75			}
76			$record->setSiteSettings($siteSettings);
77			if (Craft::$app->sections->saveSection($record)) {
78			parent::import($definition['entryTypes'], $record->getEntryTypes(), ['sectionId' => $record->id]);
			0 ignored issues – show Comprehensibility Bug introduced 2018-04-04 14:03 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`import()` instead of `saveRecord()`). Are you sure this is correct? If so, you might want to change this to `$this->import()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
79			return true;
80			}
81			}
82
83			if ($record instanceof EntryType) {
84			if ($definition['fieldLayout']) {
85			$record->setFieldLayout($this->getFieldLayout($definition['fieldLayout']));
			0 ignored issues – show Documentation Bug introduced 2018-04-04 14:03 UTC by Report Bug Copy Issue Report The method `getFieldLayout` does not exist on `object<NerdsAndCompany\S...atic\Services\Sections>`? 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...
86			}
87			return Craft::$app->sections->saveEntryType($record);
88			}
89
90			return false;
91			}
92
93			/**
94			* Delete a record
95			*
96			* @param Model $record
97			* @return boolean
98			*/
99			protected function deleteRecord(Model $record)
100			{
101			if ($record instanceof Section) {
102			return Craft::$app->sections->deleteSection($record);
103			}
104			if ($record instanceof EntryType) {
105			return Craft::$app->sections->deleteEntryType($record);
106			}
107			return false;
108			}
109			}
110

nerds-and-company / schematic

Pull Request — master (#114)

Sections A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like