QueryParams.php

<?php declare(strict_types=1);
/**
 * HyperPlug
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace modethirteen\Http;

class QueryParams implements IMutableQueryParams {

    /**
     * @param array $array
     * @return QueryParams
     */
    public static function newFromArray(array $array) : QueryParams {
        $params = new QueryParams();
        foreach($array as $param => $value) {
            $params->set($param, $value);
        }
        return $params;
    }

    /**
     * @param string $query
     * @return QueryParams
     */
    public static function newFromQuery(string $query) : QueryParams {
        $params = new QueryParams();
        if($query !== null) {
            $pairs = explode('&', $query);
            foreach($pairs as $pair) {
                if(!StringUtil::isNullOrEmpty($pair)) {
                    if(strpos($pair, '=') === false) {
                        $k = $pair;
                        $v = null;
                    } else {
                        list($k, $v) = array_map('urldecode', explode('=', $pair));
                    }
                    $params->set($k, $v === null ? '' : $v);
                }
            }
        }
        return $params;
    }

    /**
     * @var string[]
     */
    private array $params = [];

    /**
     * @var mixed - current key
     */
    private $key;

    /**
     * @var array<mixed> - list of keys in the map
     */
    private array $keys = [];

    public function __toString() : string {
        return $this->toString();
    }

    public function addQueryParams(IQueryParams $params) : void {
        foreach($params as $param => $value) {
            $this->set($param, $value);
        }
    }

    public function current() : string {
        return $this->params[$this->key];
    }

    public function isSet(string $param) : bool {
        return isset($this->params[$param]);
    }

    public function key() : string {
        return StringUtil::stringify($this->key);
    }

    public function next() : void {
        $this->key = next($this->keys);
    }

    public function rewind() : void {
        $this->key = reset($this->keys);
    }

    public function valid() : bool {
        return $this->key !== false;
    }

    public function get(string $param) : ?string {
        return isset($this->params[$param]) ? $this->params[$param] : null;
    }

    public function set(string $param, $value) : void {
        if($value === null) {
            unset($this->params[$param]);
        } else {
            $this->params[$param] = StringUtil::stringify($value);
        }
        $this->keys = array_keys($this->params);
        $this->rewind();
    }

    public function toArray() : array {
        return $this->params;
    }

    public function toMutableQueryParams(): IMutableQueryParams {
        return $this;
    }

    public function toString() : string {
        return http_build_query($this->params);
    }
}