FieldLayoutBehavior::getFieldLayout() - 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-05 15:57 UTC

FieldLayoutBehavior::getFieldLayout() B

↳ Parent: FieldLayoutBehavior

Complexity

Conditions	4
Paths	3

Size

Total Lines	22
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0
cc	4
eloc	15
nc	3
nop	1

<?php
namespace NerdsAndCompany\Schematic\Behaviors;

use Craft;
use yii\base\Behavior;
use craft\base\Field;
use craft\models\FieldLayout;
use craft\elements\Entry;

/**
 * Schematic FieldLayout Behavior.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class FieldLayoutBehavior extends Behavior
{
    /**
     * Get field layout definition.
     *
     * @param FieldLayout $fieldLayout
     *
     * @return array
     */
    public function getFieldLayoutDefinition(FieldLayout $fieldLayout)
    {
        if ($fieldLayout->getTabs()) {
            $tabDefinitions = [];

            foreach ($fieldLayout->getTabs() as $tab) {
                $tabDefinitions[$tab->name] = $this->getFieldLayoutFieldsDefinition($tab->getFields());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            return ['tabs' => $tabDefinitions];
        }

        return ['fields' => $this->getFieldLayoutFieldsDefinition($fieldLayout->getFields())];
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Get field layout fields definition.
     *
     * @param Field[] $fields
     *
     * @return array
     */
    private function getFieldLayoutFieldsDefinition(array $fields)
    {
        $fieldDefinitions = [];

        foreach ($fields as $field) {
            $fieldDefinitions[$field->handle] = $field->required;
        }

        return $fieldDefinitions;
    }

    /**
     * Attempt to import a field layout.
     *
     * @param array $fieldLayoutDef
     *
     * @return FieldLayout
     */
    public function getFieldLayout(array $fieldLayoutDef)
    {
        $layoutFields = [];
        $requiredFields = [];

        if (array_key_exists('tabs', $fieldLayoutDef)) {
            foreach ($fieldLayoutDef['tabs'] as $tabName => $tabDef) {
                $layoutTabFields = $this->getPrepareFieldLayout($tabDef);
                $requiredFields = array_merge($requiredFields, $layoutTabFields['required']);
                $layoutFields[$tabName] = $layoutTabFields['fields'];
            }
        } elseif (array_key_exists('fields', $fieldLayoutDef)) {
            $layoutTabFields = $this->getPrepareFieldLayout($fieldLayoutDef);
            $requiredFields = $layoutTabFields['required'];
            $layoutFields = $layoutTabFields['fields'];
        }

        $fieldLayout = Craft::$app->fields->assembleLayout($layoutFields, $requiredFields);
        $fieldLayout->type = Entry::class;

        return $fieldLayout;
    }

    /**
     * Get a prepared fieldLayout for the craft assembleLayout function.
     *
     * @param array $fieldLayoutDef
     *
     * @return array
     */
    private function getPrepareFieldLayout(array $fieldLayoutDef)
    {
        $layoutFields = [];
        $requiredFields = [];

        foreach ($fieldLayoutDef as $fieldHandle => $required) {
            $field = Craft::$app->fields->getFieldByHandle($fieldHandle);
            if ($field instanceof Field) {
                $layoutFields[] = $field->id;

                if ($required) {
                    $requiredFields[] = $field->id;
                }
            }
        }

        return [
          'fields' => $layoutFields,
          'required' => $requiredFields,
        ];
    }
}


1			<?php
2			namespace NerdsAndCompany\Schematic\Behaviors;
3
4			use Craft;
5			use yii\base\Behavior;
6			use craft\base\Field;
7			use craft\models\FieldLayout;
8			use craft\elements\Entry;
9
10			/**
11			* Schematic FieldLayout Behavior.
12			*
13			* Sync Craft Setups.
14			*
15			* @author Nerds & Company
16			* @copyright Copyright (c) 2015-2018, Nerds & Company
17			* @license MIT
18			*
19			* @see http://www.nerds.company
20			*/
21			class FieldLayoutBehavior extends Behavior
22			{
23			/**
24			* Get field layout definition.
25			*
26			* @param FieldLayout $fieldLayout
27			*
28			* @return array
29			*/
30			public function getFieldLayoutDefinition(FieldLayout $fieldLayout)
31			{
32			if ($fieldLayout->getTabs()) {
33			$tabDefinitions = [];
34
35			foreach ($fieldLayout->getTabs() as $tab) {
36			$tabDefinitions[$tab->name] = $this->getFieldLayoutFieldsDefinition($tab->getFields());
			0 ignored issues – show Documentation introduced 2018-04-04 14:03 UTC by Report Bug Copy Issue Report `$tab->getFields()` is of type `array<integer,object<craft\base\FieldInterface>>`, but the function expects a `array<integer,object<craft\base\Field>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
37			}
38
39			return ['tabs' => $tabDefinitions];
40			}
41
42			return ['fields' => $this->getFieldLayoutFieldsDefinition($fieldLayout->getFields())];
			0 ignored issues – show Documentation introduced 2018-04-04 14:03 UTC by Report Bug Copy Issue Report `$fieldLayout->getFields()` is of type `array<integer,object<craft\base\FieldInterface>>`, but the function expects a `array<integer,object<craft\base\Field>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
43			}
44
45			/**
46			* Get field layout fields definition.
47			*
48			* @param Field[] $fields
49			*
50			* @return array
51			*/
52			private function getFieldLayoutFieldsDefinition(array $fields)
53			{
54			$fieldDefinitions = [];
55
56			foreach ($fields as $field) {
57			$fieldDefinitions[$field->handle] = $field->required;
58			}
59
60			return $fieldDefinitions;
61			}
62
63			/**
64			* Attempt to import a field layout.
65			*
66			* @param array $fieldLayoutDef
67			*
68			* @return FieldLayout
69			*/
70			public function getFieldLayout(array $fieldLayoutDef)
71			{
72			$layoutFields = [];
73			$requiredFields = [];
74
75			if (array_key_exists('tabs', $fieldLayoutDef)) {
76			foreach ($fieldLayoutDef['tabs'] as $tabName => $tabDef) {
77			$layoutTabFields = $this->getPrepareFieldLayout($tabDef);
78			$requiredFields = array_merge($requiredFields, $layoutTabFields['required']);
79			$layoutFields[$tabName] = $layoutTabFields['fields'];
80			}
81			} elseif (array_key_exists('fields', $fieldLayoutDef)) {
82			$layoutTabFields = $this->getPrepareFieldLayout($fieldLayoutDef);
83			$requiredFields = $layoutTabFields['required'];
84			$layoutFields = $layoutTabFields['fields'];
85			}
86
87			$fieldLayout = Craft::$app->fields->assembleLayout($layoutFields, $requiredFields);
88			$fieldLayout->type = Entry::class;
89
90			return $fieldLayout;
91			}
92
93			/**
94			* Get a prepared fieldLayout for the craft assembleLayout function.
95			*
96			* @param array $fieldLayoutDef
97			*
98			* @return array
99			*/
100			private function getPrepareFieldLayout(array $fieldLayoutDef)
101			{
102			$layoutFields = [];
103			$requiredFields = [];
104
105			foreach ($fieldLayoutDef as $fieldHandle => $required) {
106			$field = Craft::$app->fields->getFieldByHandle($fieldHandle);
107			if ($field instanceof Field) {
108			$layoutFields[] = $field->id;
109
110			if ($required) {
111			$requiredFields[] = $field->id;
112			}
113			}
114			}
115
116			return [
117			'fields' => $layoutFields,
118			'required' => $requiredFields,
119			];
120			}
121			}
122

nerds-and-company / schematic

Pull Request — master (#114)

FieldLayoutBehavior::getFieldLayout() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like