Jidaikobo\Kontiki\Models\BaseModelTraits\FieldDefinitionTrait

Complexity

Total Complexity

23

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	processFieldDefinitions()	0	6	1
A	defineMetaDataFieldDefinitions()	0	3	1
A	defineFieldDefinitions()	0	3	1
A	getMetaDataFieldDefinitions()	0	3	1
A	getFields()	0	10	2
A	getFieldDefinitions()	0	3	1
A	processFields()	0	10	1
A	initializeMetaDataFields()	0	4	2
A	getReadOnlyField()	0	6	1
A	fillValueFieldDefinitions()	0	9	4
A	disableFormFieldsForContext()	0	16	3
A	getIdField()	0	6	1
A	getField()	0	20	2
A	initializeFields()	0	4	2

<?php

namespace Jidaikobo\Kontiki\Models\BaseModelTraits;

/**
 * Trait FieldDefinitionTrait
 *
 * Provides methods for defining and managing field definitions in models.
 */
trait FieldDefinitionTrait
{
    protected ?array $fieldDefinitions = null;
    protected ?array $metaDataFieldDefinitions = null;

    public function getFields(
        string $context = '',
        array $data = [],
        int $id = null
    ): array {
        if (!empty($context)) {
            $this->processFields($context, $data, $id);
        }

        return array_merge($this->fieldDefinitions, $this->metaDataFieldDefinitions);

It seems like $this->fieldDefinitions can also be of type null; however, parameter $arrays of array_merge() does only seem to accept array, maybe add an additional type check?

    }

    public function getFieldDefinitions(): array
    {
        return $this->fieldDefinitions;

The expression return $this->fieldDefinitions could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function getMetaDataFieldDefinitions(): array
    {
        return $this->metaDataFieldDefinitions;

The expression return $this->metaDataFieldDefinitions could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    protected function defineFieldDefinitions(): void
    {
        $this->fieldDefinitions = [];
    }

    protected function defineMetaDataFieldDefinitions(): void
    {
        $this->metaDataFieldDefinitions = [];
    }

    protected function processFieldDefinitions(
        string $context = '',

The parameter $context is not used and could be removed.

        array $data = [],

The parameter $data is not used and could be removed.

        int $id = null

The parameter $id is not used and could be removed.

    ): void {
        return;
    }

    protected function disableFormFieldsForContext(): void
    {
        foreach (['metaDataFieldDefinitions', 'fieldDefinitions'] as $fieldType) {
            foreach ($this->$fieldType as &$field) {
                // Set input fields to readonly
                $field['attributes']['readonly'] = 'readonly';

                // Remove file upload class and add "form-control-plaintext"
                $existingClass = $field['attributes']['class'] ?? '';
                $existingClass = str_replace('kontiki-file-upload', '', $existingClass);
                $field['attributes']['class'] = trim(
                    $existingClass . ' form-control-plaintext p-2'
                );

                // Remove descriptions
                $field['description'] = '';
            }
        }
    }

    private function fillValueFieldDefinitions(
        string $context = '',

The parameter $context is not used and could be removed.

        array $data = [],
        int $id = null

The parameter $id is not used and could be removed.

    ): void {
        foreach (['metaDataFieldDefinitions', 'fieldDefinitions'] as $fieldType) {
            foreach (array_keys($this->$fieldType) as $fieldName) {
                if (isset($data[$fieldName])) {
                    $this->$fieldType[$fieldName]['default'] = $data[$fieldName];
                }
            }
        }
    }

    private function initializeFields(): void
    {
        if ($this->fieldDefinitions === null) {
            $this->defineFieldDefinitions();
        }
    }

    private function initializeMetaDataFields(): void
    {
        if ($this->metaDataFieldDefinitions === null) {
            $this->defineMetaDataFieldDefinitions();
        }
    }

    private function processFields(
        string $context = '',
        array $data = [],
        int $id = null
    ): void {
        // set values for save / form
        $this->fillValueFieldDefinitions($context, $data, $id);

        // process definitions for various purpose
        $this->processFieldDefinitions($context, $data, $id);
    }

    /**
     * Get the definition for Id field.
     *
     * wrapper of read-only field.
     */
    protected function getIdField(): array
    {
        return $this->getReadOnlyField(
            __('ID'),
            [
                'display_in_list' => true
            ]
        );
    }

    /**
     * Get the definition for a read-only field.
     *
     * This method defines the structure of a field that is displayed in lists
     * but not included in form inputs.
     *
     * @param string $label The label to be used for the field.
     * @param array $options Optional settings for the field.
     * @return array The read-only field definition.
     */
    protected function getReadOnlyField(string $label, array $options = []): array
    {
        return [
            'label' => $label,
            'display_in_list' => $options['display_in_list'] ?? false,
            'save_as_utc' => $options['save_as_utc'] ?? false,
        ];
    }

    /**
     * Generate a text field definition.
     *
     * @param string $label The field name.
     * @param array $options Optional settings for the field.
     * @return array Field definition.
     */
    protected function getField(string $label, array $options = []): array
    {
        return [
            'label' => $options['label'] ?? __($label),
            'type' => $options['type'] ?? 'text',
            'description' => $options['description'] ?? '',
            'attributes' => $options['attributes'] ?? ['class' => 'form-control'],
            'label_attributes' => $options['label_attributes'] ?? ['class' => 'form-label'],
            'options' => $options['options'] ?? [],
            'default' => $options['default'] ?? '',
            'searchable' => $options['searchable'] ?? true,
            'rules' => $options['rules'] ?? [],
            'filter' => $options['filter'] ?? (defined('FILTER_SANITIZE_FULL_SPECIAL_CHARS')
                ? FILTER_SANITIZE_FULL_SPECIAL_CHARS

The constant Jidaikobo\Kontiki\Models\BaseModelTraits\FILTER_SANITIZE_FULL_SPECIAL_CHARS was not found. Maybe you did not declare it correctly or list all dependencies?

                : FILTER_SANITIZE_SPECIAL_CHARS),
            'template' => $options['template'] ?? 'default',
            'group' => $options['group'] ?? 'main',
            'fieldset_template' => $options['fieldset_template'] ?? 'forms/fieldset/flat.php',
            'display_in_list' => $options['display_in_list'] ?? false,
            'save_as_utc' => $options['save_as_utc'] ?? false
        ];
    }
}