Validation::setValidation() - Code Metrics - Inspection of "Add Livewire widget" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — v6 (#4971)

by Pedro
created 2023-09-29 18:19 UTC
Validation::setValidation() A

↳ Parent: Validation
Complexity

Conditions	6
Paths	4
Size

Total Lines	10
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	2
Metric	Value
cc	6
eloc	8
nc	4
nop	3
dl	0
loc	10
rs	9.2222
c	2
b	0
f	2
<?php

namespace Backpack\CRUD\app\Library\CrudPanel\Traits;

use Backpack\CRUD\app\Library\Validation\Rules\BackpackCustomRule;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Str;

trait Validation
{
    /**
     * Adds the required rules from an array and allows validation of that array.
     *
     * @param  array  $requiredFields
     */
    public function setValidationFromArray(array $rules, array $messages = [], array $attributes = [])
    {
        $this->setRequiredFields($rules);
        $this->setOperationSetting('validationRules', array_merge($this->getOperationSetting('validationRules') ?? [], $rules));
               setOperationSetting('validationRules', array_merge($this->getOperationSetting('validationRules') ?? [], $rules));
        $this->setOperationSetting('validationMessages', array_merge($this->getOperationSetting('validationMessages') ?? [], $messages));
        $this->setOperationSetting('validationAttributes', array_merge($this->getOperationSetting('validationAttributes') ?? [], $attributes));
    }

    /**
     * Take the rules defined on fields and create a validation
     * array from them.
     */
    public function setValidationFromFields()
    {
        $fields = $this->getOperationSetting('fields');

        // construct the validation rules array
        // (eg. ['name' => 'required|min:2'])
        $rules = $this->getValidationRulesFromFieldsAndSubfields($fields);

        // construct the validation messages array
        // (eg. ['title.required' => 'You gotta write smth man.'])
        $messages = $this->getValidationMessagesFromFieldsAndSubfields($fields);

        // construct the validation attributes array
        // (eg. ['user_id' => 'username'])
        $attributes = $this->getValidationAttributesFromFieldsAndSubfields($fields);

        $this->setValidationFromArray($rules, $messages, $attributes);
    }

    /**
     * Mark a FormRequest file as required for the current operation, in Settings.
     * Adds the required rules to an array for easy access.
     *
     * @param  string  $class  Class that extends FormRequest
     */
    public function setValidationFromRequest($class)
    {
        $this->setFormRequest($class);
        $this->setRequiredFields($class);
    }

    /**
     * Mark a FormRequest file as required for the current operation, in Settings.
     * Adds the required rules to an array for easy access.
     *
     * @param  string|array  $classOrRulesArray  Class that extends FormRequest or array of validation rules
     * @param  array  $messages  Array of validation messages.
     * @param  array  $attributes  Array of validation attributes
     */
    public function setValidation($classOrRulesArray = false, $messages = [], $attributes = [])
    {
        if (! $classOrRulesArray) {
            $this->setValidationFromFields();
        } elseif (is_array($classOrRulesArray)) {
            $this->setValidationFromArray($classOrRulesArray, $messages, $attributes);
        } elseif (is_string($classOrRulesArray) && class_exists($classOrRulesArray) && is_a($classOrRulesArray, FormRequest::class, true)) {
            $this->setValidationFromRequest($classOrRulesArray);
        } else {
            abort(500, 'Please pass setValidation() nothing, a rules array or a FormRequest class.');
        }
    }

    /**
     * Remove the current FormRequest from configuration, so it will no longer be validated.
     */
    public function unsetValidation()
    {
        $this->setOperationSetting('formRequest', false);
        $this->setOperationSetting('validationRules', []);
        $this->setOperationSetting('validationMessages', []);
        $this->setOperationSetting('validationAttributes', []);
        $this->setOperationSetting('requiredFields', []);
    }

    /**
     * Remove the current FormRequest from configuration, so it will no longer be validated.
     */
    public function disableValidation()
    {
        $this->unsetValidation();
    }

    /**
     * Mark a FormRequest file as required for the current operation, in Settings.
     *
     * @param  string  $class  Class that extends FormRequest
     */
    public function setFormRequest($class)
    {
        $this->setOperationSetting('formRequest', $class);
    }

    /**
     * Get the current form request file, in any.
     * Returns null if no FormRequest is required for the current operation.
     *
     * @return string Class that extends FormRequest
     */
    public function getFormRequest()
    {
        return $this->getOperationSetting('formRequest');
    }

    /**
     * Run the authorization and validation for the current crud panel.
     * That authorization is gathered from 3 places:
     * - the FormRequest when provided.
     * - the rules added in the controller.
     * - the rules defined in the fields itself.
     *
     * @return \Illuminate\Http\Request
     */
    public function validateRequest()
    {
        $formRequest = $this->getFormRequest();

        $rules = $this->getOperationSetting('validationRules') ?? [];
        $messages = $this->getOperationSetting('validationMessages') ?? [];
        $attributes = $this->getOperationSetting('validationAttributes') ?? [];

        if ($formRequest) {
            // when there is no validation in the fields, just validate the form request.
            if (empty($rules)) {
                return app($formRequest);

            }

            [$formRequest, $extendedRules, $extendedMessages, $extendedAttributes] = $this->mergeRequestAndFieldRules($formRequest, $rules, $messages, $attributes);
            [$formRequest, $extendedRules, $extendedMessages, $extendedAttributes] = $this->mergeRequestAndFieldRules(/** @scrutinizer ignore-type */ $formRequest, $rules, $messages, $attributes);

            // validate the complete request with FormRequest + controller validation + field validation (our anonymous class)
            return $this->checkRequestValidity($extendedRules, $extendedMessages, $extendedAttributes, $formRequest);
        }

        return ! empty($rules) ? $this->checkRequestValidity($rules, $messages, $attributes) : $this->getRequest();
        return ! empty($rules) ? $this->checkRequestValidity($rules, $messages, $attributes) : $this->/** @scrutinizer ignore-call */ getRequest();
    }

    /**
     * Merge the form request validation with the fields validation.
     *
     * @param  FormRequest  $request
     * @param  array|null  $rules
     * @param  array|null  $messages
     * @param  array|null  $attributes
     * @return array
     */
    public function mergeRequestAndFieldRules($request, $rules = null, $messages = null, $attributes = null)
    public function mergeRequestAndFieldRules($request, $rules = null, $messages = null, /** @scrutinizer ignore-unused */ $attributes = null)
    {
        $rules = $rules ?? $this->getOperationSetting('validationRules') ?? [];
        $messages = $messages ?? $this->getOperationSetting('validationMessages') ?? [];
        $attributes = $messages ?? $this->getOperationSetting('validationAttributes') ?? [];

        $request = (new $request)->createFrom($this->getRequest());
        $extendedRules = $this->mergeRules($request, $rules);
        $extendedMessages = array_merge($messages, $request->messages());
        $extendedAttributes = array_merge($attributes, $request->attributes());

        return [$request, $extendedRules, $extendedMessages, $extendedAttributes];
    }

    /**
     * Parse a FormRequest class, figure out what inputs are required
     * and store this knowledge in the current object.
     *
     * @param  string|array  $classOrRulesArray  Class that extends FormRequest or rules array
     */
    public function setRequiredFields($classOrRulesArray)
    {
        $requiredFields = $this->getOperationSetting('requiredFields') ?? [];

        if (is_array($classOrRulesArray)) {
            $rules = $classOrRulesArray;
        } else {
            $formRequest = new $classOrRulesArray();
            $rules = $formRequest->rules();
        }

        if (count($rules)) {
            foreach ($rules as $key => $validationRules) {
                if (is_string($validationRules)) {
                    $validationRules = explode('|', $validationRules);
                }
                if (! is_array($validationRules)) {
                    $validationRules = [$validationRules];
                }
                foreach ($validationRules as $rule) {
                    if (is_a($rule, BackpackCustomRule::class, true)) {
                        foreach ($rule->getFieldRules() as $customValidatorRules) {
                            $key = $this->checkIfRuleIsRequired($key, $customValidatorRules);
                            if ($key) {
                                $requiredFields[] = $key;
                            }
                        }

                        continue;
                    }
                    $key = $this->checkIfRuleIsRequired($key, $rule);
                    if ($key) {
                        $requiredFields[] = $key;
                    }
                }
            }
        }

        // merge any previous required fields with current ones
        $requiredFields = array_merge($this->getOperationSetting('requiredFields') ?? [], $requiredFields);

        // since this COULD BE called twice (to support the previous syntax where developers needed to call `setValidation` after the field definition)
        // and to make this change non-breaking, we are going to return an unique array. There is NO WARM returning repeated names, but there is also
        // no sense in doing it, so array_unique() it is.
        $requiredFields = array_unique($requiredFields);

        $this->setOperationSetting('requiredFields', $requiredFields);
    }

    /**
     * Check the current object to see if an input is required
     * for the given operation.
     *
     * @param  string  $inputKey  Field or input name.
     * @param  string  $operation  create / update
     * @return bool
     */
    public function isRequired($inputKey)
    {
        if (! $this->hasOperationSetting('requiredFields')) {
        if (! $this->/** @scrutinizer ignore-call */ hasOperationSetting('requiredFields')) {
            return false;
        }

        if (Str::contains($inputKey, '.')) {
            $inputKey = Str::dotsToSquareBrackets($inputKey, ['*']);
        }

        return in_array($inputKey, $this->getOperationSetting('requiredFields'));
    }

    /**
     * Add the validation setup by developer in field `validationRules` to the crud validation.
     *
     * @param  array  $field  - the field we want to get the validation from.
     * @param  bool|string  $parent  - the parent name when setting up validation for subfields.
     */
    private function setupFieldValidation($field, $parent = false)
    {
        [$rules, $messages, $attributes] = $this->getValidationDataFromField($field, $parent);

        if (! empty($rules)) {
            $this->setValidation($rules, $messages, $attributes);
        }
    }

    /**
     * Return the messages for the fields and subfields in the current crud panel.
     *
     * @param  array  $fields
     * @return array
     */
    private function getValidationMessagesFromFieldsAndSubfields($fields)
    {
        $messages = [];
        collect($fields)
        collect(/** @scrutinizer ignore-type */ $fields)
            ->filter(function ($value, $key) {
            ->filter(function ($value, /** @scrutinizer ignore-unused */ $key) {
                // only keep fields where 'validationMessages' OR there are subfields
                return array_key_exists('validationMessages', $value) || array_key_exists('subfields', $value);
            })->each(function ($item, $key) use (&$messages) {
                if (isset($item['validationMessages'])) {
                    foreach ($item['validationMessages'] as $rule => $message) {
                        $messages[$key.'.'.$rule] = $message;
                    }
                }
                // add messages from subfields
                if (array_key_exists('subfields', $item)) {
                    $subfieldsWithValidationMessages = array_filter($item['subfields'], function ($subfield) {
                        return array_key_exists('validationRules', $subfield);
                    });

                    foreach ($subfieldsWithValidationMessages as $subfield) {
                        foreach ($subfield['validationMessages'] ?? [] as $rule => $message) {
                            $messages[$item['name'].'.*.'.$subfield['name'].'.'.$rule] = $message;
                        }
                    }
                }
            })->toArray();

        return $messages;
    }

    /**
     * Return the attributes for the fields and subfields in the current crud panel.
     *
     * @param  array  $fields
     * @return array
     */
    private function getValidationAttributesFromFieldsAndSubfields($fields)
    {
        $attributes = [];
        collect($fields)
        collect(/** @scrutinizer ignore-type */ $fields)
            ->filter(function ($value, $key) {
            ->filter(function ($value, /** @scrutinizer ignore-unused */ $key) {
                // only keep fields where 'validationAttribute' exists OR there are subfields
                return array_key_exists('validationAttribute', $value) || array_key_exists('subfields', $value);
            })->each(function ($item, $key) use (&$attributes) {
                if (isset($item['validationAttribute'])) {
                    $attributes[$key] = $item['validationAttribute'];
                }
                // add attributes from subfields
                if (array_key_exists('subfields', $item)) {
                    $subfieldsWithValidationAttribute = array_filter($item['subfields'], function ($subfield) {
                        return array_key_exists('validationAttribute', $subfield);
                    });

                    foreach ($subfieldsWithValidationAttribute as $subfield) {
                        $attributes[$item['name'].'.*.'.$subfield['name']] = $subfield['validationAttribute'];
                    }
                }
            })->toArray();

        return $attributes;
    }

    /**
     * Return the rules for the fields and subfields in the current crud panel.
     *
     * @param  array  $fields
     * @return array
     */
    private function getValidationRulesFromFieldsAndSubfields($fields)
    {
        $rules = collect($fields)
        $rules = collect(/** @scrutinizer ignore-type */ $fields)
            ->filter(function ($value, $key) {
            ->filter(function ($value, /** @scrutinizer ignore-unused */ $key) {
                // only keep fields where 'validationRules' OR there are subfields
                return array_key_exists('validationRules', $value) || array_key_exists('subfields', $value);
            })->map(function ($item, $key) {
                $validationRules = [];
                // only keep the rules, not the entire field definition
                if (isset($item['validationRules'])) {
                    $validationRules[$key] = $item['validationRules'];
                }
                // add validation rules for subfields
                if (array_key_exists('subfields', $item)) {
                    $subfieldsWithValidation = array_filter($item['subfields'], function ($subfield) {
                        return array_key_exists('validationRules', $subfield);
                    });

                    foreach ($subfieldsWithValidation as $subfield) {
                        $validationRules[$item['name'].'.*.'.$subfield['name']] = $subfield['validationRules'];
                    }
                }

                return $validationRules;
            })->toArray();

        return array_merge(...array_values($rules));
    }

    /**
     * Return the array of rules and messages with the validation key accordingly set
     * to match the field or the subfield accordingly.
     *
     * @param  array  $field  - the field we want to get the rules and messages from.
     * @param  bool|string  $parent  - the parent name when setting up validation for subfields.
     */
    private function getValidationDataFromField($field, $parent = false)
    {
        $rules = [];
        $messages = [];
        $attributes = [];

        foreach ((array) $field['name'] as $fieldName) {
            if ($parent) {
                $fieldName = $parent.'.*.'.$fieldName;
                $fieldName = /** @scrutinizer ignore-type */ $parent.'.*.'.$fieldName;
            }

            if (isset($field['validationRules'])) {
                $rules[$fieldName] = $field['validationRules'];
            }
            if (isset($field['validationMessages'])) {
                foreach ($field['validationMessages'] as $validator => $message) {
                    $messages[$fieldName.'.'.$validator] = $message;
                }
            }
            if (isset($field['validationAttribute'])) {
                $attributes[$fieldName] = $field['validationAttribute'];
            }
        }

        return [$rules, $messages, $attributes];
    }

    /**
     * Return an array containing the request rules and the field/controller rules merged.
     * The rules in request will take precedence over the ones in controller/fields.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  array  $rules
     * @return array
     */
    private function mergeRules($request, $rules)
    {
        $extendedRules = [];
        $requestRules = $this->getRequestRulesAsArray($request);

        $rules = $this->getRulesAsArray($rules);

        foreach ($requestRules as $ruleKey => $rule) {
            $extendedRules[$ruleKey] = array_key_exists($ruleKey, $rules) ? array_merge($rule, $this->getRulesAsArray($rules[$ruleKey])) : $rule;
            unset($rules[$ruleKey]);
        }

        return array_merge($rules, $extendedRules);
    }

    /**
     * Return the request rules as an array of rules if developer provided a rule string configuration.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    private function getRequestRulesAsArray($request)
    {
        $requestRules = [];
        foreach ($request->rules() as $ruleKey => $rule) {
            $requestRules[$ruleKey] = $this->getRulesAsArray($rule);
        }

        return $requestRules;
    }

    /**
     * Checks if the request is valid against the rules.
     *
     * @param  array  $rules
     * @param  array  $messages
     * @param  \Illuminate\Http\Request|null  $request
     * @return \Illuminate\Http\Request
     */
    private function checkRequestValidity($rules, $messages, $attributes, $request = null)
    {
        $request = $request ?? $this->getRequest();
        $request->validate($rules, $messages, $attributes);

        return $request;
    }

    /**
     * Check if the given rule is a required rule.
     *
     * @param  string  $key
     * @param  string  $rule
     * @return string|bool
     */
    private function checkIfRuleIsRequired($key, $rule)
    {
        if (
            (is_string($rule) && strpos($rule, 'required') !== false && strpos($rule, 'required_') === false) ||
            (is_array($rule) && array_search('required', $rule) !== false && array_search('required_', $rule) === false)
        ) {
            if (Str::contains($key, '.')) {
                $key = Str::dotsToSquareBrackets($key, ['*']);
            }

            return $key;
        }

        return false;
    }

    /**
     * Prepare the rules as array.
     */
    private function getRulesAsArray($rules)
    {
        if (is_array($rules) || is_a($rules, BackpackCustomRule::class, true)) {
            return $rules;
        }

        return explode('|', $rules);
    }
}

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — v6 (#4971)

Validation::setValidation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
