juststeveking/uri-builder

A simple URI builder in PHP that is slightly opinionated

v1.1.0 2020-10-30 11:07 UTC

This package is auto-updated.

Last update: 2020-11-30 11:20:50 UTC


README

URI Builder

Latest Version PHP Version tests Scrutinizer Code Quality Total Downloads

A simple URI builder in PHP that is slightly opinionated

Purpose

The purpose of this package is to provide a fluent interface to build JSON:API compliant URI strings.

Usage

Using the built in parse_url in PHP will produce the following output:

[
    "scheme" => "https",
    "host" => "www.domain.com",
    "path" => "/api/v1/resource"
    "query" => "include=test,another&sort=-name",
]

This is fine for basic usage. To use this very opinionated package:

Building Pragmatically

$url = Uri::build()
           ->addScheme('https')
           ->addHost('www.domain.com')
           ->addPath('api/v1/resource')
           ->addQuery('include=test,another&sort=-name')
           ->addFragment('static-link-to-element');

Creating from a String

$url = Uri::fromString('https://www.domain.com/api/v1/resource?include=test,another&sort=-name')

Converting back to a String

$url = Uri::build()
           ->addScheme('https')
           ->addHost('www.domain.com')
           ->addPath('api/v1/resource')
           ->addQuery('include=test,another&sort=-name');

$string = $url->toString();

// optionally
echo (string) $url;

The toString method has an optional parameter which will allow you to urlencode the query parameters before returning the URI.

$url = Uri::build()
           ->addScheme('https')
           ->addHost('www.domain.com')
           ->addPath('api/v1/resource')
           ->addQuery('include=test,another&sort=-name');

$string = $url->toString(true)

Adding Query Parameters after creation

Creating query parameters after creation is pretty simple. You can pass through anything that isn't:

  • An Object
  • An Array

It has a helper option on the end of the function which will convert booleans to strings.

public function addQueryParam(string $key, $value, bool $covertBoolToString = false)

The following is how you use it:

$url = Uri::fromString('https://www.domain.com/api/v1/resource');
$url->addQueryParam('include', 'test,another,options')
    ->addQueryParam('published', true, true);

The output will be: https://www.domain.com/api/v1/resource?include=test,another,options&published=true