HierarchicalPath::__toString() - Code Metrics - Inspection of "adding preserve delimiters" - thephpleague/uri - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#58)

by ignace nyamagana

created 2016-05-17 10:27 UTC

HierarchicalPath::__toString() A

↳ Parent: HierarchicalPath

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	9
ccs	6
cts	6
cp	1
rs	9.6666
cc	2
eloc	5
nc	2
nop	0
crap	2

<?php
/**
 * League.Uri (http://uri.thephpleague.com)
 *
 * @package   League.uri
 * @author    Ignace Nyamagana Butera <[email protected]>
 * @copyright 2013-2015 Ignace Nyamagana Butera
 * @license   https://github.com/thephpleague/uri/blob/master/LICENSE (MIT License)
 * @version   4.2.0
 * @link      https://github.com/thephpleague/uri/
 */
namespace League\Uri\Components;

use InvalidArgumentException;
use League\Uri\Interfaces\HierarchicalComponent;
use League\Uri\Interfaces\HierarchicalPath as HierarchicalPathInterface;

/**
 * Value object representing a URI path component.
 *
 * @package League.uri
 * @author  Ignace Nyamagana Butera <[email protected]>
 * @since   1.0.0
 */
class HierarchicalPath extends AbstractHierarchicalComponent implements HierarchicalPathInterface
{
    use PathTrait;

    /**
     * @inheritdoc
     */
    protected static $separator = '/';

    /**
     * @inheritdoc
     */
    protected static $invalidCharactersRegex = ',[?#],';

    /**
     * New Instance
     *
     * @param string $path
     */
    public function __construct($path = '')
    {
        $path = $this->validateString($path);
        $this->assertValidComponent($path);
        $this->isAbsolute = self::IS_RELATIVE;
        if (static::$separator == mb_substr($path, 0, 1, 'UTF-8')) {
            $this->isAbsolute = self::IS_ABSOLUTE;
            $path = mb_substr($path, 1, mb_strlen($path), 'UTF-8');
        }

        $append_delimiter = false;
        if (static::$separator === mb_substr($path, -1, 1, 'UTF-8')) {
            $path = mb_substr($path, 0, -1, 'UTF-8');
            $append_delimiter = true;
        }

        $this->data = $this->validate($path);
        if ($append_delimiter) {
            $this->data[] = '';
        }
    }

    /**
     * validate the submitted data
     *
     * @param string $data
     *
     * @return array
     */
    protected function validate($data)
    {
        $filterSegment = function ($segment) {
            return isset($segment);
        };

        $data = $this->decodePath($data);

        return array_filter(explode(static::$separator, $data), $filterSegment);
    }

    /**
     * Retrieves a single path segment.
     *
     * Retrieves a single path segment. If the segment offset has not been set,
     * returns the default value provided.
     *
     * @param string $offset  the segment offset
     * @param mixed  $default Default value to return if the offset does not exist.
     *
     * @return mixed
     */
    public function getSegment($offset, $default = null)
    {
        if (isset($this->data[$offset])) {
            return $this->data[$offset];
        }

        return $default;
    }

    /**
     * @inheritdoc
     */
    public static function __set_state(array $properties)
    {
        return static::createFromArray($properties['data'], $properties['isAbsolute']);
    }

    /**
     * @inheritdoc
     */
    public function getComponent()
    {
        $front_delimiter = '';
        if ($this->isAbsolute == self::IS_ABSOLUTE) {
            $front_delimiter = static::$separator;
        }

        return $front_delimiter.$this->encodePath(implode(static::$separator, $this->data));
    }

    /**
     * Returns an instance with the specified component appended
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified component with the appended data
     *
     * @param HierarchicalComponent|string $component the component to append
     *
     * @return static
     */
    public function append($component)
    {
        $source = $this->toArray();
        if (!empty($source) && '' === end($source)) {
            array_pop($source);
        }

        return $this->newCollectionInstance(array_merge(
            $source,
            $this->validateComponent($component)->toArray()
        ));
    }

    /**
     * Returns the path basename
     *
     * @return string
     */
    public function getBasename()
    {
        $data = $this->data;

        return (string) array_pop($data);
    }

    /**
     * Returns parent directory's path
     *
     * @return string
     */
    public function getDirname()
    {
        return str_replace(
            ['\\', "\0"],
            [static::$separator, '\\'],
            dirname(str_replace('\\', "\0", $this->__toString()))
        );
    }

    /**
     * Returns the basename extension
     *
     * @return string
     */
    public function getExtension()
    {
        list($basename, ) = explode(';', $this->getBasename(), 2);

        return pathinfo($basename, PATHINFO_EXTENSION);
    }

    /**
     * Returns an instance with the specified basename extension
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the extension basename modified.
     *
     * @param string $extension the new extension
     *                          can preceeded with or without the dot (.) character
     *
     * @throws InvalidArgumentException If the extension is invalid
     *
     * @return static
     */
    public function withExtension($extension)
    {
        $extension = $this->formatExtension($extension);
        $segments = $this->toArray();
        $basename = array_pop($segments);
        $parts = explode(';', $basename, 2);
        $basenamePart = array_shift($parts);
        if ('' === $basenamePart || is_null($basenamePart)) {
            return $this;
        }

        $newBasename = $this->buildBasename($basenamePart, $extension, array_shift($parts));
        if ($basename === $newBasename) {
            return $this;
        }
        $segments[] = $newBasename;

        return $this->newCollectionInstance($segments);
    }

    /**
     * create a new basename with a new extension
     *
     * @param string $basenamePart  the basename file part
     * @param string $extension     the new extension to add
     * @param string $parameterPart the basename parameter part
     *
     * @return string
     */
    protected function buildBasename($basenamePart, $extension, $parameterPart)
    {
        $length = mb_strrpos($basenamePart, '.'.pathinfo($basenamePart, PATHINFO_EXTENSION), 'UTF-8');
        if (false !== $length) {
            $basenamePart = mb_substr($basenamePart, 0, $length, 'UTF-8');
        }

        $parameterPart = trim($parameterPart);
        if ('' !== $parameterPart) {
            $parameterPart = ";$parameterPart";
        }

        $extension = trim($extension);
        if ('' !== $extension) {
            $extension = ".$extension";
        }

        return $basenamePart.$extension.$parameterPart;
    }

    /**
     * validate and format the given extension
     *
     * @param string $extension the new extension to use
     *
     * @throws InvalidArgumentException If the extension is not valid
     *
     * @return string
     */
    protected function formatExtension($extension)
    {
        if (0 === strpos($extension, '.')) {
            throw new InvalidArgumentException('an extension sequence can not contain a leading `.` character');
        }

        if (strpos($extension, static::$separator)) {
            throw new InvalidArgumentException('an extension sequence can not contain a path delimiter');
        }

        return implode(static::$separator, $this->validate($extension));
    }
}


1		<?php
2		/**
3		* League.Uri (http://uri.thephpleague.com)
4		*
5		* @package League.uri
6		* @author Ignace Nyamagana Butera <[email protected]>
7		* @copyright 2013-2015 Ignace Nyamagana Butera
8		* @license https://github.com/thephpleague/uri/blob/master/LICENSE (MIT License)
9		* @version 4.2.0
10		* @link https://github.com/thephpleague/uri/
11		*/
12		namespace League\Uri\Components;
13
14		use InvalidArgumentException;
15		use League\Uri\Interfaces\HierarchicalComponent;
16		use League\Uri\Interfaces\HierarchicalPath as HierarchicalPathInterface;
17
18		/**
19		* Value object representing a URI path component.
20		*
21		* @package League.uri
22		* @author Ignace Nyamagana Butera <[email protected]>
23		* @since 1.0.0
24		*/
25		class HierarchicalPath extends AbstractHierarchicalComponent implements HierarchicalPathInterface
26		{
27		use PathTrait;
28
29		/**
30		* @inheritdoc
31		*/
32		protected static $separator = '/';
33
34		/**
35		* @inheritdoc
36		*/
37		protected static $invalidCharactersRegex = ',[?#],';
38
39		/**
40		* New Instance
41		*
42		* @param string $path
43		*/
44	910	public function __construct($path = '')
45		{
46	910	$path = $this->validateString($path);
47	901	$this->assertValidComponent($path);
48	895	$this->isAbsolute = self::IS_RELATIVE;
49	895	if (static::$separator == mb_substr($path, 0, 1, 'UTF-8')) {
50	722	$this->isAbsolute = self::IS_ABSOLUTE;
51	722	$path = mb_substr($path, 1, mb_strlen($path), 'UTF-8');
52	481	}
53
54	895	$append_delimiter = false;
55	895	if (static::$separator === mb_substr($path, -1, 1, 'UTF-8')) {
56	105	$path = mb_substr($path, 0, -1, 'UTF-8');
57	105	$append_delimiter = true;
58	70	}
59
60	895	$this->data = $this->validate($path);
61	895	if ($append_delimiter) {
62	105	$this->data[] = '';
63	70	}
64	895	}
65
66		/**
67		* validate the submitted data
68		*
69		* @param string $data
70		*
71		* @return array
72		*/
73		protected function validate($data)
74		{
75	895	$filterSegment = function ($segment) {
76	895	return isset($segment);
77	895	};
78
79	895	$data = $this->decodePath($data);
80
81	895	return array_filter(explode(static::$separator, $data), $filterSegment);
82		}
83
84		/**
85		* Retrieves a single path segment.
86		*
87		* Retrieves a single path segment. If the segment offset has not been set,
88		* returns the default value provided.
89		*
90		* @param string $offset the segment offset
91		* @param mixed $default Default value to return if the offset does not exist.
92		*
93		* @return mixed
94		*/
95	9	public function getSegment($offset, $default = null)
96		{
97	9	if (isset($this->data[$offset])) {
98	6	return $this->data[$offset];
99		}
100
101	3	return $default;
102		}
103
104		/**
105		* @inheritdoc
106		*/
107	9	public static function __set_state(array $properties)
108		{
109	9	return static::createFromArray($properties['data'], $properties['isAbsolute']);
110		}
111
112		/**
113		* @inheritdoc
114		*/
115	862	public function getComponent()
116		{
117	862	$front_delimiter = '';
118	862	if ($this->isAbsolute == self::IS_ABSOLUTE) {
119	680	$front_delimiter = static::$separator;
120	453	}
121
122	862	return $front_delimiter.$this->encodePath(implode(static::$separator, $this->data));
123		}
124
125		/**
126		* Returns an instance with the specified component appended
127		*
128		* This method MUST retain the state of the current instance, and return
129		* an instance that contains the modified component with the appended data
130		*
131		* @param HierarchicalComponent\|string $component the component to append
132		*
133		* @return static
134		*/
135	72	public function append($component)
136		{
137	72	$source = $this->toArray();
138	72	if (!empty($source) && '' === end($source)) {
139	30	array_pop($source);
140	20	}
141
142	72	return $this->newCollectionInstance(array_merge(
143	48	$source,
144	72	$this->validateComponent($component)->toArray()
145	48	));
146		}
147
148		/**
149		* Returns the path basename
150		*
151		* @return string
152		*/
153	63	public function getBasename()
154		{
155	63	$data = $this->data;
156
157	63	return (string) array_pop($data);
158		}
159
160		/**
161		* Returns parent directory's path
162		*
163		* @return string
164		*/
165	24	public function getDirname()
166		{
167	24	return str_replace(
168	24	['\\', "\0"],
169	24	[static::$separator, '\\'],
170	24	dirname(str_replace('\\', "\0", $this->__toString()))
171	16	);
172		}
173
174		/**
175		* Returns the basename extension
176		*
177		* @return string
178		*/
179	57	public function getExtension()
180		{
181	57	list($basename, ) = explode(';', $this->getBasename(), 2);
182
183	57	return pathinfo($basename, PATHINFO_EXTENSION);
184		}
185
186		/**
187		* Returns an instance with the specified basename extension
188		*
189		* This method MUST retain the state of the current instance, and return
190		* an instance that contains the extension basename modified.
191		*
192		* @param string $extension the new extension
193		* can preceeded with or without the dot (.) character
194		*
195		* @throws InvalidArgumentException If the extension is invalid
196		*
197		* @return static
198		*/
199	63	public function withExtension($extension)
200		{
201	63	$extension = $this->formatExtension($extension);
202	57	$segments = $this->toArray();
203	57	$basename = array_pop($segments);
204	57	$parts = explode(';', $basename, 2);
205	57	$basenamePart = array_shift($parts);
206	57	if ('' === $basenamePart \|\| is_null($basenamePart)) {
207	6	return $this;
208		}
209
210	51	$newBasename = $this->buildBasename($basenamePart, $extension, array_shift($parts));
211	51	if ($basename === $newBasename) {
212	3	return $this;
213		}
214	48	$segments[] = $newBasename;
215
216	48	return $this->newCollectionInstance($segments);
217		}
218
219		/**
220		* create a new basename with a new extension
221		*
222		* @param string $basenamePart the basename file part
223		* @param string $extension the new extension to add
224		* @param string $parameterPart the basename parameter part
225		*
226		* @return string
227		*/
228	51	protected function buildBasename($basenamePart, $extension, $parameterPart)
229		{
230	51	$length = mb_strrpos($basenamePart, '.'.pathinfo($basenamePart, PATHINFO_EXTENSION), 'UTF-8');
231	51	if (false !== $length) {
232	45	$basenamePart = mb_substr($basenamePart, 0, $length, 'UTF-8');
233	30	}
234
235	51	$parameterPart = trim($parameterPart);
236	51	if ('' !== $parameterPart) {
237	24	$parameterPart = ";$parameterPart";
238	16	}
239
240	51	$extension = trim($extension);
241	51	if ('' !== $extension) {
242	36	$extension = ".$extension";
243	24	}
244
245	51	return $basenamePart.$extension.$parameterPart;
246		}
247
248		/**
249		* validate and format the given extension
250		*
251		* @param string $extension the new extension to use
252		*
253		* @throws InvalidArgumentException If the extension is not valid
254		*
255		* @return string
256		*/
257	63	protected function formatExtension($extension)
258		{
259	63	if (0 === strpos($extension, '.')) {
260	3	throw new InvalidArgumentException('an extension sequence can not contain a leading `.` character');
261		}
262
263	60	if (strpos($extension, static::$separator)) {
264	3	throw new InvalidArgumentException('an extension sequence can not contain a path delimiter');
265		}
266
267	57	return implode(static::$separator, $this->validate($extension));
268		}
269		}
270

thephpleague / uri

Pull Request — master (#58)

HierarchicalPath::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like