FormSubmissionManager::fieldPresentInRequest() - Code Metrics - Inspection of "added some missing return types" - spider-mane/saveyour - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 4c5faf...429320 )

by Chris
created 2020-08-23 09:21 UTC
FormSubmissionManager::fieldPresentInRequest() A

↳ Parent: FormSubmissionManager
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
<?php

namespace WebTheory\Saveyour\Controllers;

use Psr\Http\Message\ServerRequestInterface;
use WebTheory\Saveyour\Contracts\FieldOperationCacheInterface;
use WebTheory\Saveyour\Contracts\FormDataProcessorInterface;
use WebTheory\Saveyour\Contracts\FormFieldControllerInterface;
use WebTheory\Saveyour\Contracts\FormFieldRepositoryInterface;
use WebTheory\Saveyour\Contracts\FormProcessingCacheInterface;
use WebTheory\Saveyour\Contracts\FormSubmissionManagerInterface;
use WebTheory\Saveyour\Contracts\FormValidatorInterface;
use WebTheory\Saveyour\Request;

class FormSubmissionManager implements FormSubmissionManagerInterface
{
    /**
     * Array of FormFieldControllerInterface instances
     *
     * @var FormFieldControllerInterface[]
     */
    protected $fields = [];

    /**
     * @var FormFieldRepositoryInterface
     */
    protected $fieldRepository;

    /**
     * Array of FormDataProcessorInterface instances
     *
     * @var FormDataProcessorInterface[]
     */
    protected $processors = [];

    /**
     * Array of form FormValidatorInterface instances
     *
     * @var FormValidatorInterface[]
     */
    protected $validators = [];

    /**
     * @var FieldOperationCacheInterface[]
     */
    protected $results = [];

    /**
     * Array of alerts to display in after form submission
     *
     * @var string[]
     */
    protected $alerts = [];

    /**
     * Get the value of validators
     *
     * @return mixed
     */
    public function getValidators()
    {
        return $this->validators;
    }

    /**
     * Set array of form FormValidatorInterface instances
     *
     * @param array $validators Array of form FormValidatorInterface instances
     *
     * @return self
     */
    public function setValidators(array $validators)
    {
        $this->validators = [];

        foreach ($validators as $rule => $validator) {

            if (is_array($validator)) {
                $alert = $validator['alert'] ?? null;
                $validator = $validator['validator'];
            }

            $this->addValidator($rule, $validator, $alert ?? null);
        }

        return $this;
    }

    /**
     *
     */
    public function addValidator(string $rule, FormValidatorInterface $validator, ?string $alert = null)
    {
        $this->validators[$rule] = $validator;

        if ($alert) {
            $this->addAlert($rule, $alert);
        }

        return $this;
    }

    /**
     * Get array of alerts to display in after form submission
     *
     * @return string[]
     */
    public function getAlerts(): array
    {
        return $this->alerts;
    }

    /**
     *
     */
    public function getAlert(string $rule): string
    {
        return $this->alerts[$rule];
    }

    /**
     * Set array of alerts to display in after form submission
     *
     * @param string[] $alert Array of alerts to display in after form submission
     *
     * @return self
     */
    public function setAlerts(array $alerts)
    {
        $this->alerts = [];

        foreach ($alerts as $rule => $alert) {
            $this->addAlert($rule, $alert);
        }
    }

    /**
     *
     */
    public function addAlert(string $rule, string $alert)
    {
        $this->alerts[$rule] = $alert;

        return $this;
    }

    /**
     * Get the value of fields
     *
     * @return mixed
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Set the value of fields
     *
     * @param FormFieldControllerInterface[] $fields
     *
     * @return self
     */
    public function setFields(FormFieldControllerInterface ...$fields)
    {
        $this->fields = $fields;

        return $this;
    }

    /**
     * @param FormFieldControllerInterface $field
     */
    public function addField(FormFieldControllerInterface $field)
    {
        $this->fields[] = $field;

        return $this;
    }

    /**
     * Get the value of fieldRepository
     *
     * @return FormFieldRepositoryInterface
     */
    public function getFieldRepository(): FormFieldRepositoryInterface
    {
        return $this->fieldRepository;
    }

    /**
     * Set the value of fieldRepository
     *
     * @param FormFieldRepositoryInterface $fieldRepository
     *
     * @return self
     */
    public function setFieldRepository(FormFieldRepositoryInterface $fieldRepository)
    {
        $this->fieldRepository = $fieldRepository;

        return $this;
    }

    /**
     * Get the value of groups
     *
     * @return array
     */
    public function getProcessors(): array
    {
        return $this->processors;
    }

    /**
     * Set the value of groups
     *
     * @param FormDataProcessorInterface[] $processors
     *
     * @return self
     */
    public function setProcessors(FormDataProcessorInterface ...$processors)
    {
        $this->processors = $processors;

        return $this;
    }

    /**
     * Add a group
     *
     * @param string $groups
     *
     * @return self
     */
    public function addProcessor(FormDataProcessorInterface $processor)
    {
        $this->processors[] = $processor;

        return $this;
    }

    /**
     *
     */
    public function process(ServerRequestInterface $request): FormProcessingCacheInterface
    {
        $cache = new FormProcessingCache();

        if ($this->isSafe($request, $cache)) {
            $this->processFields($request, $cache);
            $this->runProcessors($request, $cache);
            $this->processResults($request, $cache);
        }

        return $cache;
    }

    /**
     *
     */
    protected function isSafe(ServerRequestInterface $request, FormProcessingCache $cache): bool
    {
        $violations = [];

        foreach ($this->validators as $rule => $validator) {
            if (!$validator->isValid($request)) {
                $violations[$rule] = $this->alerts[$rule] ?? '';
            }
        }

        $cache->withRequestViolations($violations);

        return empty($violations);
    }

    /**
     *
     */
    protected function sortFieldsForProcessing()
    {
        usort($this->fields, function (FormFieldControllerInterface $a, FormFieldControllerInterface $b) {
            // because usort will not compare values that it infers from
            // previous comparisons to be equal, 0 should never be returned. all
            // that matters is that dependent fields are positioned after their
            // dependencies.
            return in_array($a->getRequestVar(), $b->mustAwait()) ? -1 : 1;
        });
    }

    /**
     *
     */
    protected function fieldPresentInRequest(FormFieldControllerInterface $field, ServerRequestInterface $request): bool
    {
        return Request::has($request, $field->getRequestVar());
    }

    /**
     *
     */
    protected function processFields(ServerRequestInterface $request, FormProcessingCache $cache)
    {
        $inputResults = [];
        $inputViolations = [];

        $this->sortFieldsForProcessing();

        foreach ($this->fields as $field) {
            $name = $field->getRequestVar();
            $results = $this->processField($field, $request);

            $inputResults[$name] = $results;
            $inputViolations[$name] = $results->ruleViolations();
        }

        $cache->withInputResults($inputResults);
        $cache->withInputViolations(array_filter($inputViolations));

        return $this;
    }

    /**
     *
     */
    protected function processField(FormFieldControllerInterface $field, ServerRequestInterface $request): FieldOperationCacheInterface
    {
        $requestVarPresent = $this->fieldPresentInRequest($field, $request);

        if ($requestVarPresent) {
            $base = $field->process($request);
            $results = new FieldOperationCache(
                true,
                $base->sanitizedInputValue(),
                $base->updateAttempted(),
                $base->updateSuccessful(),
                $base->ruleViolations()
            );
        } else {
            $results = new FieldOperationCache(false, null, false, false, []);
        }

        return $results;
    }

    /**
     *
     */
    protected function runProcessors(ServerRequestInterface $request, FormProcessingCache $cache)
    {
        $fields = $cache->inputResults();
        $responses = [];

        foreach ($this->processors as $processor) {
            $results = [];

            foreach ($processor->getFields() as $field) {
                $results[$field] = $fields[$field];
            }

            $responses[] = $processor->process($request, $results);
        }

        $cache->withProcessingResults(array_filter($responses));

        return $this;
    }

    /**
     *
     */
    protected function processResults(ServerRequestInterface $request, FormProcessingCache $cache)
    protected function processResults(/** @scrutinizer ignore-unused */ ServerRequestInterface $request, FormProcessingCache $cache)
    {
        return $this;
    }
}

spider-mane / saveyour

Push — master ( 4c5faf...429320 )

FormSubmissionManager::fieldPresentInRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
