php-extended/php-ulid-object

A simple implementation of the php-extended/php-ulid-interface library

4.0.0 2022-05-31 07:46 UTC

README

A simple implementation of the php-extended/php-ulid-interface library.

coverage build status

/!\ This library only works with 64-bits runtimes of php /!\

Installation

The installation of this library is made via composer. Download composer.phar from their website. Then add to your composer.json :

	"require": {
		...
		"php-extended/php-ulid-object": "^3"
		...
	}

Then run php composer.phar update to install this library. The autoloading of all classes of this library is made through composer's autoloader.

Basic Usage

This library may be used the following way :


use PhpExtended\Ulid\Ulid;

$ulid = new Uuid(0x123456789, 0x123456789, 0x123456789);

$ulid->__toString(); // 0004HMASW904HMASW904HMASW9

To parse an ulid, do :


use PhpExtended\Ulid\UlidParser;

$parser = new UlidParser();
$ulid = $parser->parse('<put here your ulid string>');
// $ulid instanceof UlidInterface

To create an ulid, do :


use PhpExtended\Uuid\UlidRandomFactory;

$factory = new UlidRandomFactory();
$ulid = $factory->create(); // 01EKEWH5HYSHZPMYCGVT44YZJ6

License

MIT (See license file).