spatie / url
Parse, build and manipulate URL's
Fund package maintenance!
spatie
spatie.be/open-source/support-us
Installs: 8 984 157
Dependents: 70
Suggesters: 0
Security: 0
Stars: 721
Watchers: 11
Forks: 56
Open Issues: 0
Requires
- php: ^8.0
- psr/http-message: ^1.0 || ^2.0
- spatie/macroable: ^1.0 || ^2.0
Requires (Dev)
- pestphp/pest: ^1.21
README
A simple package to deal with URLs in your applications.
Installation
You can install the package via composer:
composer require spatie/url
Usage
Parse and transform a URL
Retrieve any part of the URL:
use Spatie\Url\Url; $url = Url::fromString('https://spatie.be/opensource'); echo $url->getScheme(); // 'https' echo $url->getHost(); // 'spatie.be' echo $url->getPath(); // '/opensource'
Transform any part of the URL:
Note the
Url
class is immutable.
$url = Url::fromString('https://spatie.be/opensource'); echo $url->withHost('github.com')->withPath('spatie'); // 'https://github.com/spatie'
Scheme
Transform the URL scheme.
$url = Url::fromString('http://spatie.be/opensource'); echo $url->withScheme('https'); // 'https://spatie.be/opensource'
Use a list of allowed schemes.
Note each scheme in the list will be sanitized
$url = Url::fromString('https://spatie.be/opensource'); echo $url->withAllowedSchemes(['wss'])->withScheme('wss'); // 'wss://spatie.be/opensource'
or pass the list directly to fromString
as the URL's scheme will be sanitized and validated immediately:
$url = Url::fromString('https://spatie.be/opensource', [...SchemeValidator::VALID_SCHEMES, 'wss']); echo $url->withScheme('wss'); // 'wss://spatie.be/opensource'
Query parameters
Retrieve and transform query parameters:
$url = Url::fromString('https://spatie.be/opensource?utm_source=github&utm_campaign=packages'); echo $url->getQuery(); // 'utm_source=github&utm_campaign=packages' echo $url->getQueryParameter('utm_source'); // 'github' echo $url->getQueryParameter('utm_medium'); // null echo $url->getQueryParameter('utm_medium', 'social'); // 'social' echo $url->getQueryParameter('utm_medium', function() { //some logic return 'email'; }); // 'email' echo $url->withoutQueryParameter('utm_campaign'); // 'https://spatie.be/opensource?utm_source=github' echo $url->withQueryParameters(['utm_campaign' => 'packages']); // 'https://spatie.be/opensource?utm_source=github&utm_campaign=packages'
Path segments
Retrieve path segments:
$url = Url::fromString('https://spatie.be/opensource/laravel'); echo $url->getSegment(1); // 'opensource' echo $url->getSegment(2); // 'laravel'
PSR-7 UriInterface
Implements PSR-7's UriInterface
interface:
class Url implements UriInterface { /* ... */ }
The league/uri
is a more powerful package than this one. The main reason this package exists, is because the alternatives requires non-standard php extensions. If you're dealing with special character encodings or need bulletproof validation, you're definitely better off using league/uri
.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Testing
composer test
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
License
The MIT License (MIT). Please see License File for more information.