UserModel::defineFieldDefinitions() - Code Metrics - Inspection of "refactoring" - jidaikobo-shibata/kontiki-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 122379...eaa951 )

by Nobufumi

created 2025-03-22 07:39 UTC

UserModel::defineFieldDefinitions() A

↳ Parent: UserModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	51
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	29
nc	1
nop	0
dl	0
loc	51
rs	9.456
c	0
b	0
f	0

How to fix Long Method

<?php

namespace Jidaikobo\Kontiki\Models;

class UserModel extends BaseModel
{
    use Traits\CRUDTrait;
    use Traits\MetaDataTrait;

    use Traits\IndexTrait;

    protected string $table = 'users';

    protected function defineFieldDefinitions(): void
    {
        // add dynamic rules at $this->processFieldDefinitions()
        $this->fieldDefinitions = [
            'id' => $this->getIdField(),

            'username' => $this->getField(
                __('username'),
                [
                    'rules' => [
                        'required',
                        ['lengthMin', 3]
                    ],
                    'display_in_list' => true
                ]
            ),

            'password' => $this->getField(
                __('password'),
                [
                    'type' => 'password',
                    'rules' => [
                        'required',
                        ['lengthMin', 8]
                    ],
                    'filter' => FILTER_UNSAFE_RAW,
                ]
            ),

            'role' => $this->getField(
                __('role'),
                [
                    'type' => 'select',
                    'options' => [
                        'editor' => __('editor'),
                        'admin' => __('admin'),
                    ],
                    'rules' => [
                        'required',
                    ],
                    'attributes' => [
                        'class' => 'form-control form-select'
                    ],
                    'display_in_list' => true
                ]
            ),

            'created_at' => $this->getReadOnlyField(
                __('created_at', 'Created'),
                [
                    'display_in_list' => true
                ]
            ),
        ];
    }

    protected function processFieldDefinitions(
        string $context = '',
        array $data = [],
        int $id = null
    ): void {
        // add rule
        $this->fieldDefinitions['username']['rules'][] = [
            'unique',
            $this->table,
            'username',
            $id
        ];

        if ($context == 'create') {
            return;
        }

        // Exclude `required` from password's rules
        // No password specified means no change
        $this->fieldDefinitions['password']['rules'] = array_filter(
            $this->fieldDefinitions['password']['rules'],
            fn($rule) => $rule !== 'required'
        );

        $this->fieldDefinitions['password']['description'] = __('users_edit_message');

        // disable form elements
        if (in_array($context, ['trash', 'restore', 'delete'])) {
            $this->disableFormFieldsForContext();
        }
    }

    public function validate(array $data, array $context): array
    {
        $result = parent::validate($data, $context);
        $adminCheck = $this->atLeastOneAdmin($data, $context);
        $deleteCheck = $this->cannotDeleteAdmin($context);

        return [
            'valid' => $result['valid'] && $adminCheck['valid'] && $deleteCheck['valid'],
            'errors' => array_merge_recursive(
                $result['errors'],
                $adminCheck['errors'],
                $deleteCheck['errors']
            )
        ];
    }

    private function atLeastOneAdmin(array $data, array $context): array
    {
        $result = [
            'valid' => true,
            'errors' => []
        ];

        $id = $context['id'] ?? 0;
        if (!$id || !isset($data['role'])) {
            return $result;
        }

        $targetUser = $this->getById($id);

        if ($this->isDemotingLastAdmin($targetUser, $data)) {
            $result['valid'] = false;
            $result['errors']['role']['messages'] = [__('at_least_one_admin')];
        }

        return $result;
    }

    /**
     * Check if the given user is the last admin and being demoted.
     */
    private function isDemotingLastAdmin(?array $user, array $newData): bool
    {
        if (!$user || $user['role'] !== 'admin' || $newData['role'] === 'admin') {

            return false;
        }

        $otherAdmins = $this->db->table($this->table)
            ->where('role', 'admin')
            ->where('id', '!=', $user['id'])
            ->count();

        return $otherAdmins === 0;
    }

    private function cannotDeleteAdmin(array $context): array
    {
        $result = [
            'valid' => true,
            'errors' => []
        ];

        if (($context['context'] ?? '') !== 'delete') {
            return $result;
        }

        $id = $context['id'] ?? 0;
        $targetUser = $this->getById($id);

        if ($targetUser['role'] !== 'admin') return $result;
        $result['valid'] = false;
        $result['errors']['role']['messages'] = [__('cannot_delete_admin')];

        return $result;
    }

    private function hashPassword(string $password): string
    {
        return password_hash($password, PASSWORD_BCRYPT);

    }

    protected function processDataForForm(string $actionType, array $data): array
    {
        if ($actionType == 'edit') {
            $data['password'] = '';
        }
        return $data;
    }

    protected function afterProcessDataBeforeSave(string $context, array $data): array
    {
        if ($context == 'create') {
            $data['password'] = $this->hashPassword($data['password']);
        }

        if ($context == 'update') {
            // Branching password processing
            if (isset($data['password'])) {
                if (trim($data['password']) === '') {
                    unset($data['password']);
                } else {
                    $data['password'] = $this->hashPassword($data['password']);
                }
            }
        }
        return $data;
    }
}


1			<?php
2
3			namespace Jidaikobo\Kontiki\Models;
4
5			class UserModel extends BaseModel
6			{
7			use Traits\CRUDTrait;
8			use Traits\MetaDataTrait;
			0 ignored issues – show introduced 2025-03-09 11:13 UTC by Report Bug Copy Issue Report The trait `Jidaikobo\Kontiki\Models\Traits\MetaDataTrait` requires some properties which are not provided by `Jidaikobo\Kontiki\Models\UserModel`: `$meta_key`, `$meta_value` Loading history...
9			use Traits\IndexTrait;
10
11			protected string $table = 'users';
12
13			protected function defineFieldDefinitions(): void
14			{
15			// add dynamic rules at $this->processFieldDefinitions()
16			$this->fieldDefinitions = [
17			'id' => $this->getIdField(),
18
19			'username' => $this->getField(
20			__('username'),
21			[
22			'rules' => [
23			'required',
24			['lengthMin', 3]
25			],
26			'display_in_list' => true
27			]
28			),
29
30			'password' => $this->getField(
31			__('password'),
32			[
33			'type' => 'password',
34			'rules' => [
35			'required',
36			['lengthMin', 8]
37			],
38			'filter' => FILTER_UNSAFE_RAW,
39			]
40			),
41
42			'role' => $this->getField(
43			__('role'),
44			[
45			'type' => 'select',
46			'options' => [
47			'editor' => __('editor'),
48			'admin' => __('admin'),
49			],
50			'rules' => [
51			'required',
52			],
53			'attributes' => [
54			'class' => 'form-control form-select'
55			],
56			'display_in_list' => true
57			]
58			),
59
60			'created_at' => $this->getReadOnlyField(
61			__('created_at', 'Created'),
62			[
63			'display_in_list' => true
64			]
65			),
66			];
67			}
68
69			protected function processFieldDefinitions(
70			string $context = '',
71			array $data = [],
72			int $id = null
73			): void {
74			// add rule
75			$this->fieldDefinitions['username']['rules'][] = [
76			'unique',
77			$this->table,
78			'username',
79			$id
80			];
81
82			if ($context == 'create') {
83			return;
84			}
85
86			// Exclude `required` from password's rules
87			// No password specified means no change
88			$this->fieldDefinitions['password']['rules'] = array_filter(
89			$this->fieldDefinitions['password']['rules'],
90			fn($rule) => $rule !== 'required'
91			);
92
93			$this->fieldDefinitions['password']['description'] = __('users_edit_message');
94
95			// disable form elements
96			if (in_array($context, ['trash', 'restore', 'delete'])) {
97			$this->disableFormFieldsForContext();
98			}
99			}
100
101			public function validate(array $data, array $context): array
102			{
103			$result = parent::validate($data, $context);
104			$adminCheck = $this->atLeastOneAdmin($data, $context);
105			$deleteCheck = $this->cannotDeleteAdmin($context);
106
107			return [
108			'valid' => $result['valid'] && $adminCheck['valid'] && $deleteCheck['valid'],
109			'errors' => array_merge_recursive(
110			$result['errors'],
111			$adminCheck['errors'],
112			$deleteCheck['errors']
113			)
114			];
115			}
116
117			private function atLeastOneAdmin(array $data, array $context): array
118			{
119			$result = [
120			'valid' => true,
121			'errors' => []
122			];
123
124			$id = $context['id'] ?? 0;
125			if (!$id \|\| !isset($data['role'])) {
126			return $result;
127			}
128
129			$targetUser = $this->getById($id);
130
131			if ($this->isDemotingLastAdmin($targetUser, $data)) {
132			$result['valid'] = false;
133			$result['errors']['role']['messages'] = [__('at_least_one_admin')];
134			}
135
136			return $result;
137			}
138
139			/**
140			* Check if the given user is the last admin and being demoted.
141			*/
142			private function isDemotingLastAdmin(?array $user, array $newData): bool
143			{
144			if (!$user \|\| $user['role'] !== 'admin' \|\| $newData['role'] === 'admin') {
			0 ignored issues – show Bug Best Practice introduced 2025-03-22 07:41 UTC by Report Bug Copy Issue Report The expression `$user` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
145			return false;
146			}
147
148			$otherAdmins = $this->db->table($this->table)
149			->where('role', 'admin')
150			->where('id', '!=', $user['id'])
151			->count();
152
153			return $otherAdmins === 0;
154			}
155
156			private function cannotDeleteAdmin(array $context): array
157			{
158			$result = [
159			'valid' => true,
160			'errors' => []
161			];
162
163			if (($context['context'] ?? '') !== 'delete') {
164			return $result;
165			}
166
167			$id = $context['id'] ?? 0;
168			$targetUser = $this->getById($id);
169
170			if ($targetUser['role'] !== 'admin') return $result;
171			$result['valid'] = false;
172			$result['errors']['role']['messages'] = [__('cannot_delete_admin')];
173
174			return $result;
175			}
176
177			private function hashPassword(string $password): string
178			{
179			return password_hash($password, PASSWORD_BCRYPT);
			0 ignored issues – show Bug Best Practice introduced 2025-03-14 11:45 UTC by Report Bug Copy Issue Report The expression `return password_hash($pa...Models\PASSWORD_BCRYPT)` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
180			}
181
182			protected function processDataForForm(string $actionType, array $data): array
183			{
184			if ($actionType == 'edit') {
185			$data['password'] = '';
186			}
187			return $data;
188			}
189
190			protected function afterProcessDataBeforeSave(string $context, array $data): array
191			{
192			if ($context == 'create') {
193			$data['password'] = $this->hashPassword($data['password']);
194			}
195
196			if ($context == 'update') {
197			// Branching password processing
198			if (isset($data['password'])) {
199			if (trim($data['password']) === '') {
200			unset($data['password']);
201			} else {
202			$data['password'] = $this->hashPassword($data['password']);
203			}
204			}
205			}
206			return $data;
207			}
208			}
209

jidaikobo-shibata / kontiki-framework

Push — main ( 122379...eaa951 )

UserModel::defineFieldDefinitions() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like