Mailcode\Traits\Commands\Validation\QueryParamsTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	hasQueryParam()	0	3	1
A	getQueryParams()	0	3	1
A	analyzeQueryString()	0	9	1
A	validateSyntax_query_params()	0	13	4
A	getQueryParamTokens()	0	3	1
A	getQueryParam()	0	8	2
A	hasQueryParams()	0	3	1

<?php
/**
 * File containing the {@see \Mailcode\Traits\Commands\Validation\QueryParamsTrait} trait.
 *
 * @package Mailcode
 * @subpackage Validation
 * @see \Mailcode\Traits\Commands\Validation\QueryParamsTrait
 */

declare(strict_types=1);

namespace Mailcode\Traits\Commands\Validation;

use Mailcode\Interfaces\Commands\Validation\QueryParamsInterface;
use Mailcode\Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral;

/**
 * Command validation drop-in: checks for the presence
 * of query parameters specified in separate string
 * literals, identified by the format <code>"paramName=paramValue"</code>.
 *
 * @package Mailcode
 * @subpackage Validation
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @see QueryParamsInterface
 */
trait QueryParamsTrait
{
    /**
     * @var array<string,string>
     */
    private array $queryParams = array();

    /**
     * @var Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
     */
    private array $queryParamTokens = array();

    protected function validateSyntax_query_params() : void
    {
        $literals = $this->requireParams()

It seems like requireParams() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            ->getInfo()
            ->getStringLiterals();

        foreach($literals as $literal)
        {
            $text = $literal->getText();

            if(strpos($text, '=') !== false && $this->analyzeQueryString($text))
            {
                $this->queryParamTokens[] = $literal;
            }
        }
    }

    private function analyzeQueryString(string $param) : bool
    {
        $tokens = explode('=', $param);
        $name = trim(array_shift($tokens));
        $value = trim(implode('=', $tokens));

        $this->queryParams[$name] = $value;

        return true;
    }

    public function hasQueryParams() : bool
    {
        return !empty($this->queryParams);
    }

    /**
     * @return array<string,string>
     */
    public function getQueryParams() : array
    {
        return $this->queryParams;
    }

    /**
     * @return Mailcode_Parser_Statement_Tokenizer_Token_StringLiteral[]
     */
    public function getQueryParamTokens() : array
    {
        return $this->queryParamTokens;
    }

    public function getQueryParam(string $name) : string
    {
        if(isset($this->queryParams[$name]))
        {
            return $this->queryParams[$name];
        }

        return '';
    }

    public function hasQueryParam(string $name) : bool
    {
        return isset($this->queryParams[$name]);
    }
}