IQueryParams.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;

use Iterator;

interface IQueryParams extends Iterator {

    /**
     * Get a query parameter value from the collection
     *
     * @param string $param
     * @return string|null
     */
    function get(string $param) : ?string;

    /**
     * @param string $param
     * @return bool
     */
    function isSet(string $param) : bool;

    /**
     * @return array
     */
    function toArray() : array;

    /**
     * @return IMutableQueryParams
     */
    function toMutableQueryParams() : IMutableQueryParams;

    /**
     * @return string
     */
    function toString() : string;
}