wishthis/vendor/ml/iri/ML/IRI/README.md

48 lines
1.3 KiB
Markdown
Raw Normal View History

2022-01-21 08:23:52 +00:00
IRI
==============
This is a simple PHP class to ease IRI handling. Currently it just supports
parsing of IRIs and relative IRI resolution. In the future I will extend it
to support validation and normalization and perhaps also support for IRI
templates.
With more than 700 tests, this class is extensively unit tested:
[![Build Status](https://secure.travis-ci.org/lanthaler/IRI.png?branch=master)](http://travis-ci.org/lanthaler/IRI)
Installation
------------
The easiest way to use IRI is to integrate it as a dependency in your project's
[composer.json](http://getcomposer.org/doc/00-intro.md) file:
```json
{
"require": {
"ml/iri": "1.*"
}
}
```
Installing is then a matter of running composer
php composer.phar install
... and including Composer's autoloader to your project
```php
require('vendor/autoload.php');
```
Of course you can also just download an [archive](https://github.com/lanthaler/IRI/downloads)
from Github.
Credits
------------
Most test cases come either directly from the [URI specification](http://tools.ietf.org/html/rfc3986),
from [Graham Klyne's](http://www.ninebynine.org/Software/HaskellUtils/Network/URITestDescriptions.html),
or [Tim Berners-Lee's](http://dig.csail.mit.edu/2005/ajar/ajaw/test/uri-test-doc.html) test suite.