arc\url\Query

Complexity

Total Complexity

27

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

83.33%

Importance

Changes	8
Bugs	5	Features	2

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	import()	0	6	1
A	reset()	0	6	1
A	getvar()	0	4	1
A	putvar()	0	4	1
A	__toString()	0	6	1
A	compile()	0	9	2
B	parse()	0	13	5
B	parseQueryString()	0	25	6
A	parseQueryStringEntry()	0	12	3
B	encodeValue()	0	16	5

<?php

/*
 * This file is part of the Ariadne Component Library.
 *
 * (c) Muze <info@muze.nl>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace arc\url;

/**
 *  Query parses any valid url query part and generates array accessible values for it
 *  - you can use the same name multiple times -- ?name=value1&name=value2
 *    this will result in name becoming an array, similarly arrays will not be encoded with trailing [] behind the name
 *  - you can use names without values -- ?name&name2&name3
 *  - names may include any valid character -- ?valid+name
 *
 */
class Query extends \ArrayObject implements QueryInterface
{
    public function __construct($query = '')
    {
        parent::__construct( $this->parse( $query ), \ArrayObject::ARRAY_AS_PROPS );
    }

    public function __toString()
    {
        return str_replace( ['%7E', '%20'], ['~', '+'], // ~ and + are often unnecesarily encoded
            $this->compile( (array) $this )
        );
    }

    /**
     *	Import a query string or an array of key => value pairs into the UrlQuery.
     *
     *	Usage:
     *		$query->import( 'foo=bar&bar=1' );
     *		$query->import( array( 'foo' => 'bar', 'bar' => 1 ) );
     *
     *	@param string|array $values query string or array of values to import into this query
     */
    public function import($values)
    {
        $this->exchangeArray( $this->parse( $values ) + $this->getArrayCopy() );

        return $this;
    }

    /**
     * Removes all current query parameters.
     * @return $this
     */
    public function reset()
    {
        $this->exchangeArray( [] );

        return $this;
    }

    // === \arc\KeyValueStoreInterface ===

    /**
     *	@param string $name name of the query parameter
     *	@return mixed The named query parameter
     */
    public function getvar($name)
    {
        return $this->offsetGet($name);
    }

    /**
     *	@param string $name name for the query parameter
     *	@param mixed $value value of the query parameter
     */
    public function putvar($name, $value)
    {
        $this->offsetSet($name, $value);
    }

    protected function compile($values)
    {
        $result = array();
        foreach ($values as $name => $value) {
            $result[] = $this->encodeValue( $name, $value );
        }

        return implode( '&', $result );
    }

    protected function parse($values)
    {
        $result = array();
        if (is_array( $values ) || ( $values instanceof \Traversable )) {
            foreach ($values as $name => $value) {
                $result[$name] = $value;
            }
        } elseif (is_string( $values )) {
            $result = $this->parseQueryString( $values );
        }

        return $result;
    }

    protected function parseQueryString($queryString)
    {
        $result = array();
        if ($queryString) {
            $values = preg_split( '/[\&\;]/', $queryString );
            foreach ($values as $queryStringEntry) {
                list( $name, $value ) = $this->parseQueryStringEntry( $queryStringEntry );
                if (!isset($value)) {
                    // no '=' in query entry  => ?name&...
                    $result[] = $name;
                } elseif (!isset( $result[$name] )) {
                    // new entry => ?name=1&...

47% of this comment could be valid code. Did you maybe forget this after debugging?

                    $result[ $name ] = $value;
                } elseif (!is_array( $result[$name] )) {
                    // entry with same name exists already but is not an array yet => ?name=1&name=2&...
                    $result[ $name ] = array( $result[$name], $value );
                } else {
                    // entry with same name exists and is an array => ?name=1&name=2&name=3&...
                    $result[ $name ][] = $value;
                }
            }
        }

        return $result;
    }

    private function parseQueryStringEntry($queryStringEntry)
    {
        $result = explode( '=', $queryStringEntry, 2 ) + array( 1 => null ); // value may be null if no '=' is found in the query string
        foreach ($result as $key => $value) {
            if (isset($value)) {
                $value = urldecode( $value );
            }
            $result[$key] = $value;
        }

        return $result;
    }

    private function encodeValue($name, $value = null)
    {
        if (is_array( $value )) {
            $result = array();
            foreach ($value as $val) {
                $result[] = $this->encodeValue( $name, $val );
            }

            return implode( '&', $result );
        } else {
            return ( is_numeric( $name )
                ? RawUrlEncode( $value )
                : RawUrlEncode( $name ) . ( isset( $value ) ? '=' . RawUrlEncode( (string) $value ) : '' )
            );
        }
    }
}