Please consider using the the latest stable version for any production code.
The Path component
The library provides a basic League\Uri\Components\Path class to ease path manipulation.
Path creation
Using the default constructor
Just like any other component, a new League\Uri\Components\Path object can be instantiated using its default constructor.
<?php
use League\Uri\Components\Path as Path;
$path = new Path('/hello/world');
echo $path; //display '/hello/world'
$altPath = new Path('text/plain;charset=us-ascii,Hello%20World%21');
echo $altPath; //display 'text/plain;charset=us-ascii,Hello%20World%21'
A Path can not be undefined (ie: accept null as a valid constructor argument
If the submitted value is not a valid path an InvalidArgumentException will be thrown.
Path properties
Absolute or relative path
A path is considered absolute only if it starts with the path separator /, otherwise it is considered as being relative or rootless. At any given time you can test your path status using the Path::isAbsolute method.
<?php
use League\Uri\Components\Path;
$relative_path = new Path('bar/baz');
echo $relative_path; //displays 'bar/baz'
$relative_path->isAbsolute(); //return false;
$absolute_path = new Path('/bar/baz');
echo $absolute_path; //displays '/bar/baz'
$absolute_path->isAbsolute(); //return true;
Path with or without a trailing slash
The Path object can tell you whether the current path ends with a slash or not using the Path::hasTrailingSlash method. This method takes no argument and return a boolean.
<?php
use League\Uri\Components\Path;
$path = new Path('/path/to/the/sky.txt');
$path->hasTrailingSlash(); //return false
$altPath = new Path('/path/');
$altPath->hasTrailingSlash(); //return true
Path representations
String representation
Basic path representations is done using the following methods:
<?php
use League\Uri\Components\Path;
$path = new Path('/path/to the/sky');
$path->__toString(); //return '/path/to%20the/sky'
$path->getUriComponent(); //return '/path/to%20the/sky'
Path modifications
If the modifications do not change the current object, it is returned as is, otherwise, a new modified object is returned.
When a modification fails a InvalidArgumentException exception is thrown.
Out of the box, the Path object operates a number of non destructive normalizations. For instance, the path is correctly URI encoded against the RFC3986 rules.
Removing dot segments
To remove dot segment as per RFC3986 you need to explicitly call the Path::withoutDotSegments method as the result can be destructive. The method takes no argument and returns a new Path object which represents the current object without dot segments.
<?php
use League\Uri\Components\Path;
$path = new Path('path/to/./the/../the/sky%7bfoo%7d');
$newPath = $raw_path->withoutDotSegments();
echo $path; //displays 'path/to/./the/../the/sky%7bfoo%7d'
echo $newPath; //displays 'path/to/the/sky%7Bfoo%7D'
$newPath->sameValueAs($path); //returns false;
This method is used by the URI Modifier RemoveDotSegments
Removing empty segments
Sometimes your path may contain multiple adjacent delimiters. Since removing them may result in a semantically different URI, this normalization can not be applied by default. To remove adjacent delimiters you can call the Path::withoutEmptySegments method which convert you path as described below:
<?php
use League\Uri\Components\Path;
$path = new Path("path////to/the/sky//");
$newPath = $path->withoutEmptySegments();
echo $path; //displays 'path////to/the/sky//'
echo $newPath; //displays 'path/to/the/sky/'
$newPath->sameValueAs($path); //returns false;
This method is used by the URI Modifier RemoveEmptySegments
Manipulating the trailing slash
Depending on your context you may want to add or remove the path trailing slash. In order to do so the Path object uses two methods which accept no argument.
Path::withoutTrailingSlash will remove the ending slash of your path only if a slash is present.
<?php
use League\Uri\Components\Path;
$path = new Path("path/to/the/sky/");
$newPath = $path->withoutTrailingSlash();
echo $path; //displays 'path/to/the/sky/'
echo $newPath; //displays 'path/to/the/sky'
This method is used by the URI Modifier RemoveTrailingSlash
Conversely, Path::withTrailingSlash will append a slash at the end of your path only if no slash is already present.
<?php
use League\Uri\Components\Path;
$path = new Path("/path/to/the/sky");
$newPath = $path->withTrailingSlash();
echo $path; //displays '/path/to/the/sky'
echo $newPath; //displays '/path/to/the/sky/'
This method is used by the URI Modifier AddTrailingSlash
Manipulating the leading slash
Conversely, to convert the path type the Path object uses two methods which accept no argument.
Path::withoutLeadingSlash will convert an absolute path into a relative one by removing the path leading slash if present.
<?php
use League\Uri\Components\Path;
$path = new Path("path/to/the/sky/");
$newPath = $path->withoutTrailingSlash();
echo $path; //displays 'path/to/the/sky/'
echo $newPath; //displays 'path/to/the/sky'
This method is used by the URI Modifier RemoveLeadingSlash
Path::withLeadingSlash will convert an relative path into a absolute one by prepending the path with a slash if none is present.
<?php
use League\Uri\Components\Path;
$path = new Path("/path/to/the/sky");
$newPath = $path->withTrailingSlash();
echo $raw_path; //displays '/path/to/the/sky'
echo $newPath; //displays '/path/to/the/sky/'
This method is used by the URI Modifier AddLeadingSlash
Specialized Path Object
What makes an URI specific apart from the scheme is how the path is parse and manipulated. This simple path class although functional will not ease parsing a Data URI path or a FTP Uri path. That’s why the library comes bundles with two specialized Path objects that extend the current object by adding more specific methods in accordance to the path usage:
- the HierarchicalPath object to work with Hierarchical paths component
- the DataPath object to work with the Data URIs path
The Extension Guide also provides an example on how to extend the Path object to make it meets you specific URI parsing and manipulation methods.