nahid/url-factory

UrlFactory is a PHP package for working with URLs

v1.0.0-a.1 2022-08-20 15:20 UTC

Requires

• php: >=8.0
• jeremykendall/php-domain-parser: dev-develop
• psr/http-client: 1.0.x-dev
• psr/http-factory: 1.0.x-dev
• psr/simple-cache: 3.0.x-dev
• spatie/url-signer: dev-main

Requires (Dev)

• symfony/var-dumper: 6.0.x-dev

MIT

• Nahid Bin Azhar

• url
• uri
• domain
• url-parser
• url-builder
• url-factory
• url-extractor

README

UrlFactory is a PHP package for working with URLs. Its offer you to best developer experience to manage and manipulate URLs. UrlFactory offers simple, yet powerful ways of working with query string, paths and domain.

Requirements

• php >= 8.0

• ext-json

• ext-intl

Installation

UrlFactory is available on Packagist. You can directly install it in any package by running this command bellow

composer require nahid/url-factory

Configuration

There are no extra configuration needed to run this package, but by passing config you can take more control over this package.

Default Config

// use Nahid\UrlFactory\Enum;
[
    Enum::CONFIG_KEY => 'secret-key',
    Enum::CONFIG_SIGNER => MD5UrlSigner::class,
    Enum::CONFIG_PSR_CACHE_INTERFACE => null,
    Enum::CONFIG_PSR_CLIENT_INTERFACE => null,
    Enum::CONFIG_PSR_REQUEST_FACTORY_INTERFACE => null,
]

you can modify it as you want and pass into UrlFactory when initialize

Syntax

new Url([string $url, [array $config]]);

Both arguments of the construct are optional

Initialization

use Nahid\UrlFactory\Url;
use Nahid\UrlFactory\Enum;


$url = new Url('http://app.staging.google.com.bd/private/search?q=bangladesh&page=1&limit=20', [
    Enum::CONFIG_KEY => 'random-secret-key',
]);

We use http://app.staging.google.com.bd/private/search?q=bangladesh&page=1&limit=20 for our next examples

Example

URL Extract and Fetch

use Nahid\UrlFactory\Url;
use Nahid\UrlFactory\Enum;


$url = new Url('http://app.staging.google.com.bd/private/search?q=bangladesh&page=1&limit=20', [
    Enum::CONFIG_KEY => 'random-secret-key',
]);

echo $url->getScheme() . "\n";
echo $url->getQuery() . "\n";
var_dump($url->getQueryParam()) . "\n";
echo $url->getPath() . "\n";
echo $url->domain()->getSubdomain() . "\n";
echo $url->domain()->getSuffix() . "\n";
echo $url->domain()->getTld() . "\n";

Output

http
q=bangladesh&page=1&limit=20
['q' => 'bangladesh', 'page '=> 1, 'limit' => 20]
private/search
app.staging
com.bd
com

URL Modification

use Nahid\UrlFactory\Url;
use Nahid\UrlFactory\Enum;


$url = new Url('http://app.staging.google.com.bd/private/search?q=bangladesh&page=1&limit=20', [
    Enum::CONFIG_KEY => 'random-secret-key',
]);


$url->useSchemeHttps()
    ->usePath('query')
    ->useQueryParams(['search'=> 'dhaka'])
    ->useFragment('top')
    ->domain(function(\Nahid\UrlFactory\Domain $domain) {
        $domain->useBaseName('bing')
            ->useSuffix('co.in')
            ->useSubdomain('app');
    });

echo $url->get()

Output

https://app.bing.co.in/query?search=dhaka#top

Signed URL

use Nahid\UrlFactory\Url;
use Nahid\UrlFactory\Enum;


$url = new Url('http://app.staging.google.com.bd/private/search?q=bangladesh&page=1&limit=20', [
    Enum::CONFIG_KEY => 'random-secret-key',
]);


$url->useSchemeHttps()
    ->usePath('query')
    ->useQueryParams(['search'=> 'dhaka'])
    ->useFragment('top')
    ->domain(function(\Nahid\UrlFactory\Domain $domain) {
        $domain->useBaseName('bing')
            ->useSuffix('co.in')
            ->useSubdomain('app');
    });

echo $url->sign(7)->get(); // Generate signed URL with 7 days validity
 

Output

https://app.bing.co.in/query?search=dhaka&expires=1661613403&signature=5fd3f94c145731a085f6964cb3c4d03d#top

API List

There are lots of API are available with this package. We'll update it ASAP