Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jwage/purl

Purl is a simple Object Oriented URL manipulation library for PHP 7.2+
https://github.com/jwage/purl

php url

Last synced: 6 days ago
JSON representation

Purl is a simple Object Oriented URL manipulation library for PHP 7.2+

Host: GitHub
URL: https://github.com/jwage/purl
Owner: jwage
License: mit
Created: 2013-01-11T16:24:20.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2021-12-30T14:47:04.000Z (almost 3 years ago)
Last Synced: 2024-11-28T20:04:42.215Z (13 days ago)
Topics: php, url
Language: PHP
Homepage:
Size: 355 KB
Stars: 907
Watchers: 36
Forks: 123
Open Issues: 7
Metadata Files:
- Readme: README.markdown
- License: LICENSE

Awesome Lists containing this project

awesome - jwage/purl - Purl is a simple Object Oriented URL manipulation library for PHP 7.2+ (PHP)
awesome-php - Purl - A URL manipulation library. (Table of Contents / URL)
awesome-projects - Purl - A URL manipulation library. (PHP / URL)
awesome-php - Purl - A URL manipulation library. (Table of Contents / URL)
awesome-php-cn - Purl - 一个URL处理库. (目录 / URL)

README

        Purl

====

Purl is a simple Object Oriented URL manipulation library for PHP 7.2+

[![Build Status](https://secure.travis-ci.org/jwage/purl.png?branch=master)](http://travis-ci.org/jwage/purl)

[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/jwage/purl/badges/quality-score.png?s=7e0e1d4b5d7f6be61a3cd804dba556a0e4d1141d)](https://scrutinizer-ci.com/g/jwage/purl/)

[![Code Coverage](https://scrutinizer-ci.com/g/jwage/purl/badges/coverage.png?s=a02332bc4d6a32df3171f2ba714e4583a70c0154)](https://scrutinizer-ci.com/g/jwage/purl/)

[![Latest Stable Version](https://poser.pugx.org/jwage/purl/v/stable.png)](https://packagist.org/packages/jwage/purl)

[![Total Downloads](https://poser.pugx.org/jwage/purl/downloads.png)](https://packagist.org/packages/jwage/purl)

## Installation

The suggested installation method is via [composer](https://getcomposer.org/):

```sh

composer require jwage/purl

```

Using Purl

----------

Creating Url instances is easy. You can specify the URL you want, or just use the current URL:

```php

use Purl\Url;

$url = new Url('http://jwage.com');

$currentUrl = Url::fromCurrent();

```

You can chain methods together after creating the `Url` like this:

```php

$url = (new Url('http://jwage.com'))

    ->set('scheme', 'https')

    ->set('port', '443')

    ->set('user', 'jwage')

    ->set('pass', 'password')

    ->set('path', 'about/me')

    ->set('query', 'param1=value1&param2=value2')

    ->set('fragment', 'about/me?param1=value1&param2=value2');

echo $url->getUrl(); // https://jwage:[email protected]:443/about/me?param1=value1&param2=value2#about/me?param1=value1&param2=value2

// $url->path becomes instanceof Purl\Path

// $url->query becomes instanceof Purl\Query

// $url->fragment becomes instanceof Purl\Fragment

```

### Path Manipulation

```php

$url = new Url('http://jwage.com');

// add path segments one at a time

$url->path->add('about')->add('me');

// set the path data from a string

$url->path = 'about/me/another_segment'; // $url->path becomes instanceof Purl\Path

// get the path segments

print_r($url->path->getData()); // array('about', 'me', 'another_segment')

```

### Query Manipulation

```php

$url = new Url('http://jwage.com');

$url->query->set('param1', 'value1');

$url->query->set('param2', 'value2');

echo $url->query; // param1=value1&param2=value2

echo $url; // http://jwage.com?param1=value1&param2=value2

// set the query data from an array

$url->query->setData([

    'param1' => 'value1',

    'param2' => 'value2'

]);

// set the query data from a string

$url->query = 'param1=value1&param2=value2'; // $url->query becomes instanceof Purl\Query

print_r($url->query->getData()); //array('param1' => 'value1', 'param2' => 'value2')

```

### Fragment Manipulation

```php

$url = new Url('http://jwage.com');

$url->fragment = 'about/me?param1=value1&param2=value2'; // $url->fragment becomes instanceof Purl\Fragment

```

A Fragment is made of a path and a query and comes after the hashmark (#).

```php

echo $url->fragment->path; // about/me

echo $url->fragment->query; // param1=value1&param2=value2

echo $url; // http://jwage.com#about/me?param1=value1&param2=value2

```

### Extract URLs

You can easily extract urls from a string of text using the `extract` method:

```php

$string = 'some text http://google.com http://jwage.com';

$urls = Url::extract($string);

echo $urls[0]; // http://google.com/

echo $urls[1]; // http://jwage.com/

```

### Join URLs

You can easily join two URLs together using Purl:

```php

$url = new Url('http://jwage.com/about?param=value#fragment');

$url->join('http://about.me/jwage');

echo $url; // http://about.me/jwage?param=value#fragment

```

Or if you have another `Url` object already:

```php

$url1 = new Url('http://jwage.com/about?param=value#fragment');

$url2 = new Url('http://about.me/jwage');

$url1->join($url2);

echo $url1; // http://about.me/jwage?param=value#fragment

```