Keppler\Url\Builder\Schemes\Https\Bags\HttpsMutableQuery

Complexity

Total Complexity

17

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	first()	0	3	1
A	only()	0	3	1
A	all()	0	3	1
A	get()	0	3	1
A	walkRecursive()	0	4	2
A	set()	0	5	1
A	has()	0	3	1
A	forgetAll()	0	5	1
A	encoded()	0	7	2
A	last()	0	3	1
A	raw()	0	7	2
A	forget()	0	12	3

<?php
declare(strict_types=1);

namespace Keppler\Url\Builder\Schemes\Https\Bags;

use Keppler\Url\Interfaces\Mutable\MutableBagInterface;
use Keppler\Url\Traits\Accessor;
use Keppler\Url\Traits\Mutator;

/**
 * Class HttpsMutableQuery
 *
 * @package Keppler\Url\Builder\Schemes\Https\Bags
 */
class HttpsMutableQuery implements MutableBagInterface
{
    use Mutator;
    use Accessor;

    /**
     * query = *( pchar / "/" / "?" )
     *
     * @var array
     */
    private $query = [];

    /**
     * @return array|null
     */
    public function first(): ?array
    {
        return $this->firstInQuery($this->query);
    }

    /**
     * @return array|null
     */
    public function last()
    {
        return $this->lastInQuery($this->query);
    }

    /**
     * @param string ...$args
     *
     * @return HttpsMutableQuery
     */
    public function forget(string ...$args): self
    {
        foreach ($args as $item) {
            if (!$this->hasValueIn($this->query, $item)) {
                throw new \LogicException(sprintf('Cannot forget %s as it does not exist',
                    $item));
            }

            $this->mutatorForgetKeyOrValue($this->query, $item);
        }

        return $this;
    }

    /**
     * @return HttpsMutableQuery
     */
    public function forgetAll(): self
    {
        $this->query = [];

        return $this;
    }

    /**
     * @param string ...$args
     * @return array
     */
    public function only(string ...$args): array
    {
        return $this->mutatorQueryOnlyValues($this->query, $args);
    }

    /**
     * @return \Generator
     */
    public function walkRecursive(): \Generator
    {
        foreach (new \RecursiveIteratorIterator(new \RecursiveArrayIterator($this->query)) as $key => $value) {
            yield $key => $value;
        }
    }

    /////////////////////////////////
    /// INTERFACE IMPLEMENTATION  ///
    ////////////////////////////////

    /**
     * @param $key
     * @return mixed
     * @throws \Keppler\Url\Exceptions\ComponentNotFoundException
     */
    public function get($key)
    {
        return $this->getKeyIn($this->query, $key);
    }

    /**
     * @param $key
     *
     * @return bool
     */
    public function has($key): bool
    {
        return $this->hasKeyIn($this->query, $key);
    }

    /**
     * Returns all the components of the query
     *
     * @return array
     */
    public function all(): array
    {
        return $this->query;
    }

    /**
     * Return the raw unaltered query
     *
     * @return string
     */
    public function raw(): string
    {
        if (!empty($this->query)) {
            return '?'.urldecode(http_build_query($this->query));
        }

        return '';
    }

    /**
     * Returns the encoded query or path string
     *
     * @return string
     */
    public function encoded(): string
    {
        if (!empty($this->query)) {
            return '?'.http_build_query($this->query);
        }

        return '';
    }

    /**
     * Sets a given key => value to the query or path
     * Some bags should set a class property if they
     * contain multidimensional values by default
     *
     * @param $key
     * @param $value
     *
     * @return self
     */
    public function set($key, $value): self
    {
        $this->query[$key] = $value;

        return $this;
    }
}