This repository has been archived by the owner on Feb 2, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Daniel Schröder
committed
Jun 30, 2016
1 parent
e33792b
commit 747670a
Showing
1 changed file
with
22 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,50 @@ | ||
| #Uniform Resource Names (URN) | ||
| # Uniform Resource Names (URN) | ||
|
|
||
| A PHP 5.3+ library for generating RFC 2141 compliant uniform resource names (URN) | ||
| [](https://packagist.org/packages/gravitymedia/urn) | ||
| [](LICENSE.md) | ||
| [](https://travis-ci.org/GravityMedia/Urn) | ||
| [](https://scrutinizer-ci.com/g/GravityMedia/Urn/code-structure) | ||
| [](https://scrutinizer-ci.com/g/GravityMedia/Urn) | ||
| [](https://packagist.org/packages/gravitymedia/urn) | ||
| [](https://www.versioneye.com/user/projects/54a6c39d27b014005400004b) | ||
|
|
||
| [](https://packagist.org/packages/gravitymedia/urn) | ||
| [](https://packagist.org/packages/gravitymedia/urn) | ||
| [](https://packagist.org/packages/gravitymedia/urn) | ||
| [](https://travis-ci.org/GravityMedia/Urn) | ||
| [](https://scrutinizer-ci.com/g/GravityMedia/Urn/?branch=master) | ||
| [](https://scrutinizer-ci.com/g/GravityMedia/Urn/?branch=master) | ||
| [](https://www.versioneye.com/user/projects/54a6c39d27b014005400004b) | ||
| A PHP library for generating RFC 2141 compliant uniform resource names (URN). | ||
|
|
||
| ##Requirements## | ||
| ## Requirements | ||
|
|
||
| This library has the following requirements: | ||
|
|
||
| - PHP 5.3+ | ||
| - PHP 5.6+ | ||
|
|
||
| ##Installation## | ||
| ## Installation | ||
|
|
||
| Install composer in your project: | ||
| Install Composer in your project: | ||
|
|
||
| ```bash | ||
| $ curl -s https://getcomposer.org/installer | php | ||
| ``` | ||
|
|
||
| Create a `composer.json` file in your project root: | ||
|
|
||
| ```json | ||
| { | ||
| "require": { | ||
| "gravitymedia/urn": "dev-master" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Install via composer: | ||
| Require the package via Composer: | ||
|
|
||
| ```bash | ||
| $ php composer.phar install | ||
| $ php composer.phar require gravitymedia/urn | ||
| ``` | ||
|
|
||
| ##Usage## | ||
| ## Usage | ||
|
|
||
| ```php | ||
| // require autoloader | ||
| require 'vendor/autoload.php'; | ||
|
|
||
| // import classes | ||
| use GravityMedia\Urn\Urn; | ||
|
|
||
| // define URN string | ||
| $urnString = 'urn:example-namespace-id:just_an_example'; | ||
|
|
||
| // check if string is a valid URN | ||
| var_dump(Urn::isValid($urnString)); | ||
|
|
||
| // create URN from string | ||
| $urn = Urn::fromString($urnString); | ||
| // create URN object from string | ||
| $urn = Urn::fromString('urn:example-namespace-id:just_an_example'); | ||
|
|
||
| // dump namespace identifier | ||
| var_dump($urn->getNamespaceIdentifier()); | ||
| var_dump($urn->getNamespaceIdentifier()); // string(20) "example-namespace-id" | ||
|
|
||
| // dump namespace specific string | ||
| var_dump($urn->getNamespaceSpecificString()); | ||
| var_dump($urn->getNamespaceSpecificString()); // string(15) "just_an_example" | ||
| ``` |