Base::getRecordDefinition() - Code Metrics - Inspection of "Merge pull request #145 from nerds-and-company/rec..." - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2887d6...36b702 )

unknown

created 2018-06-06 11:33 UTC

Base::getRecordDefinition() B

↳ Parent: Base

Complexity

Conditions	5
Paths	6

Size

Total Lines	32
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	32
ccs	17
cts	17
cp	1
rs	8.439
c	0
b	0
f	0
cc	5
eloc	18
nc	6
nop	1
crap	5

<?php

namespace NerdsAndCompany\Schematic\Converters\Models;

use Craft;
use craft\base\Model;
use craft\models\MatrixBlockType as MatrixBlockTypeModel;
use yii\base\Component as BaseComponent;
use NerdsAndCompany\Schematic\Schematic;
use NerdsAndCompany\Schematic\Behaviors\FieldLayoutBehavior;
use NerdsAndCompany\Schematic\Behaviors\SourcesBehavior;
use NerdsAndCompany\Schematic\Interfaces\ConverterInterface;

/**
 * Schematic Base Converter.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 *
 * @method getSources(string $fieldType, $sources, string $indexFrom, string $indexTo)
 * @method getSource(string $fieldType, string $source, string $indexFrom, string $indexTo)
 * @method getFieldLayoutDefinition(FieldLayout $fieldLayout): array
 * @method getFieldLayout(array $fieldLayoutDef): FieldLayout
 */
abstract class Base extends BaseComponent implements ConverterInterface
{
    /**
     * Load fieldlayout and sources behaviors.
     *
     * @return array
     */
    public function behaviors()
    {
        return [
          FieldLayoutBehavior::class,
          SourcesBehavior::class,
        ];
    }

    /**
     * {@inheritdoc}
     */
    abstract public function saveRecord(Model $record, array $definition): bool;

    /**
     * {@inheritdoc}
     */
    abstract public function deleteRecord(Model $record): bool;

    /**
     * {@inheritdoc}
     */
    public function getRecordDefinition(Model $record): array
    {
        $definition = [
          'class' => get_class($record),
          'attributes' => $record->getAttributes(),
        ];
        unset($definition['attributes']['id']);
        unset($definition['attributes']['structureId']);
        unset($definition['attributes']['dateCreated']);
        unset($definition['attributes']['dateUpdated']);

        // Define sources
        $definition['attributes'] = $this->findSources($definition['class'], $definition['attributes'], 'id', 'handle');
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 { }

        // Define field layout
        if (isset($definition['attributes']['fieldLayoutId'])) {
            if (!$record instanceof MatrixBlockTypeModel) {
                $definition['fieldLayout'] = $this->getFieldLayoutDefinition($record->getFieldLayout());
            }
        }
        unset($definition['attributes']['fieldLayoutId']);

        // Define site settings
        if (isset($record->siteSettings)) {
            $definition['siteSettings'] = [];
            foreach ($record->getSiteSettings() as $siteSetting) {
                $definition['siteSettings'][$siteSetting->site->handle] = $this->getRecordDefinition($siteSetting);
            }
        }

        return $definition;
    }

    /**
     * {@inheritdoc}
     */
    public function setRecordAttributes(Model &$record, array $definition, array $defaultAttributes)
    {
        // Set sources
        $definition['attributes'] = $this->findSources($definition['class'], $definition['attributes'], 'handle', 'id');
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 { }

        $attributes = array_merge($definition['attributes'], $defaultAttributes);
        $record->setAttributes($attributes, false);

        // Set field layout
        if (array_key_exists('fieldLayout', $definition)) {
            $record->setFieldLayout($this->getFieldLayout($definition['fieldLayout']));
        }

        // Set site settings
        if (array_key_exists('siteSettings', $definition)) {
            $siteSettings = [];
            foreach ($definition['siteSettings'] as $handle => $siteSettingDefinition) {
                $siteSetting = new $siteSettingDefinition['class']($siteSettingDefinition['attributes']);
                $site = Craft::$app->sites->getSiteByHandle($handle);
                if ($site) {
                    $siteSetting->siteId = $site->id;
                    $siteSettings[$site->id] = $siteSetting;
                } else {
                    Schematic::warning('  - Site '.$handle.' could not be found');
                }
            }
            $record->setSiteSettings($siteSettings);
        }
    }
}


1		<?php
2
3		namespace NerdsAndCompany\Schematic\Converters\Models;
4
5		use Craft;
6		use craft\base\Model;
7		use craft\models\MatrixBlockType as MatrixBlockTypeModel;
8		use yii\base\Component as BaseComponent;
9		use NerdsAndCompany\Schematic\Schematic;
10		use NerdsAndCompany\Schematic\Behaviors\FieldLayoutBehavior;
11		use NerdsAndCompany\Schematic\Behaviors\SourcesBehavior;
12		use NerdsAndCompany\Schematic\Interfaces\ConverterInterface;
13
14		/**
15		* Schematic Base Converter.
16		*
17		* Sync Craft Setups.
18		*
19		* @author Nerds & Company
20		* @copyright Copyright (c) 2015-2018, Nerds & Company
21		* @license MIT
22		*
23		* @see http://www.nerds.company
24		*
25		* @method getSources(string $fieldType, $sources, string $indexFrom, string $indexTo)
26		* @method getSource(string $fieldType, string $source, string $indexFrom, string $indexTo)
27		* @method getFieldLayoutDefinition(FieldLayout $fieldLayout): array
28		* @method getFieldLayout(array $fieldLayoutDef): FieldLayout
29		*/
30		abstract class Base extends BaseComponent implements ConverterInterface
31		{
32		/**
33		* Load fieldlayout and sources behaviors.
34		*
35		* @return array
36		*/
37	33	public function behaviors()
38		{
39		return [
40	33	FieldLayoutBehavior::class,
41		SourcesBehavior::class,
42		];
43		}
44
45		/**
46		* {@inheritdoc}
47		*/
48		abstract public function saveRecord(Model $record, array $definition): bool;
49
50		/**
51		* {@inheritdoc}
52		*/
53		abstract public function deleteRecord(Model $record): bool;
54
55		/**
56		* {@inheritdoc}
57		*/
58	23	public function getRecordDefinition(Model $record): array
59		{
60		$definition = [
61	23	'class' => get_class($record),
62	23	'attributes' => $record->getAttributes(),
63		];
64	23	unset($definition['attributes']['id']);
65	23	unset($definition['attributes']['structureId']);
66	23	unset($definition['attributes']['dateCreated']);
67	23	unset($definition['attributes']['dateUpdated']);
68
69		// Define sources
70	23	$definition['attributes'] = $this->findSources($definition['class'], $definition['attributes'], 'id', 'handle');
		0 ignored issues – show Documentation Bug introduced 2018-06-06 09:56 UTC by Report Bug Copy Issue Report The method `findSources` does not exist on `object<NerdsAndCompany\S...Converters\Models\Base>`? 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...
71
72		// Define field layout
73	23	if (isset($definition['attributes']['fieldLayoutId'])) {
74	7	if (!$record instanceof MatrixBlockTypeModel) {
75	6	$definition['fieldLayout'] = $this->getFieldLayoutDefinition($record->getFieldLayout());
76		}
77		}
78	23	unset($definition['attributes']['fieldLayoutId']);
79
80		// Define site settings
81	23	if (isset($record->siteSettings)) {
82	4	$definition['siteSettings'] = [];
83	4	foreach ($record->getSiteSettings() as $siteSetting) {
84	4	$definition['siteSettings'][$siteSetting->site->handle] = $this->getRecordDefinition($siteSetting);
85		}
86		}
87
88	23	return $definition;
89		}
90
91		/**
92		* {@inheritdoc}
93		*/
94	9	public function setRecordAttributes(Model &$record, array $definition, array $defaultAttributes)
95		{
96		// Set sources
97	9	$definition['attributes'] = $this->findSources($definition['class'], $definition['attributes'], 'handle', 'id');
		0 ignored issues – show Documentation Bug introduced 2018-06-06 11:28 UTC by Report Bug Copy Issue Report The method `findSources` does not exist on `object<NerdsAndCompany\S...Converters\Models\Base>`? 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...
98
99	9	$attributes = array_merge($definition['attributes'], $defaultAttributes);
100	9	$record->setAttributes($attributes, false);
101
102		// Set field layout
103	9	if (array_key_exists('fieldLayout', $definition)) {
104	3	$record->setFieldLayout($this->getFieldLayout($definition['fieldLayout']));
105		}
106
107		// Set site settings
108	9	if (array_key_exists('siteSettings', $definition)) {
109	2	$siteSettings = [];
110	2	foreach ($definition['siteSettings'] as $handle => $siteSettingDefinition) {
111	2	$siteSetting = new $siteSettingDefinition['class']($siteSettingDefinition['attributes']);
112	2	$site = Craft::$app->sites->getSiteByHandle($handle);
113	2	if ($site) {
114	1	$siteSetting->siteId = $site->id;
115	1	$siteSettings[$site->id] = $siteSetting;
116		} else {
117	2	Schematic::warning(' - Site '.$handle.' could not be found');
118		}
119		}
120	2	$record->setSiteSettings($siteSettings);
121		}
122	9	}
123		}
124

nerds-and-company / schematic

Push — master ( 2887d6...36b702 )

Base::getRecordDefinition() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like