markenwerk/url-util

A PHP library providing common URL implementation.

PHP URL Util

, _(*1)

A PHP library providing common URL implementation., _(*2)

Installation

```{json} { "require": { "chroma-x/url-util": "~2.0" } }, <sub>(*3)</sub>

## Usage

### Autoloading and namesapce

```{php}  
require_once('path/to/vendor/autoload.php');

Parsing an URL

```{php} use ChromaX\UrlUtil;, <sub>(*4)</sub>

$url = new UrlUtil\Url('https://john:secret@mydomain.com:8443/path/to/resource?arg1=123&arg2=test#fragment');, <sub>(*5)</sub>

$scheme = $url->getScheme(); fwrite(STDOUT, 'Scheme "' . $scheme . '"' . PHP_EOL);, <sub>(*6)</sub>

$hostname = $url->getHostname(); fwrite(STDOUT, 'Hostname "' . $hostname . '"' . PHP_EOL);, <sub>(*7)</sub>

$port = $url->getPort(); fwrite(STDOUT, 'Port "' . (string)$port . '"' . PHP_EOL);, <sub>(*8)</sub>

$username = $url->getUsername(); fwrite(STDOUT, 'Username "' . $username . '"' . PHP_EOL);, <sub>(*9)</sub>

$password = $url->getPassword(); fwrite(STDOUT, 'Password "' . $password . '"' . PHP_EOL);, <sub>(*10)</sub>

$path = $url->getPath(); fwrite(STDOUT, 'Path "' . $path . '"' . PHP_EOL);, <sub>(*11)</sub>

$queryParameters = $url->getQueryParameters(); foreach ($queryParameters as $queryParameter) { fwrite(STDOUT, 'Query parameter "' . $queryParameter->getKey() . '" is "' . $queryParameter->getValue() . '"' . PHP_EOL); }, <sub>(*12)</sub>

$fragment = $url->getFragment(); fwrite(STDOUT, 'Fragment "' . $fragment . '"' . PHP_EOL);, <sub>(*13)</sub>

$url ->setScheme('http') ->setHostname('yourdomain.com') ->setPort(8080) ->setUsername('doe') ->setPassword('supersecret') ->setPath('path/to/another/resource') ->removeQueryParameterByKey('arg2') ->addQueryParameter(new UrlUtil\QueryParameter('arg1', '456')) ->addQueryParameter(new UrlUtil\QueryParameter('arg3', 'test')) ->setFragment('target');, <sub>(*14)</sub>

fwrite(STDOUT, 'URL "' . $url->buildUrl() . '"' . PHP_EOL);, <sub>(*15)</sub>

will output the following

```{http}
Scheme "https"
Hostname "mydomain.com"
Port "8443"
Username "john"
Password "secret"
Path "/path/to/resource"
Query parameter "arg1" is "123"
Query parameter "arg2" is "test"
Fragment "fragment"
URL "http://doe:supersecret@yourdomain.com:8080/path/to/another/resource?arg1=456&arg3=test#target"

Contribution

Contributing to our projects is always very appreciated.
But: please follow the contribution guidelines written down in the CONTRIBUTING.md document., <sub>(*16)</sub>

License

PHP URL Util is under the MIT license., <sub>(*17)</sub>