dsn.md

Supporting Enqueue

Enqueue is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:

• Become a sponsor
• Become our client

---

DSN Parser.

The enqueue/dsn tool helps to parse DSN\URI string. The tool is used by Enqueue transports to parse DSNs.

Installation

composer req enqueue/dsn 0.9.x

Examples

Basic usage:

<?php

use Enqueue\Dsn\Dsn;

$dsn = Dsn::parseFirst('mysql+pdo://user:password@localhost:3306/database?connection_timeout=123');

$dsn->getSchemeProtocol(); // 'mysql'
$dsn->getScheme(); // 'mysql+pdo'
$dsn->getSchemeExtensions(); // ['pdo']
$dsn->getUser(); // 'user'
$dsn->getPassword(); // 'password'
$dsn->getHost(); // 'localhost'
$dsn->getPort(); // 3306

$dsn->getQueryString(); // 'connection_timeout=123'
$dsn->getQuery(); // ['connection_timeout' => '123']
$dsn->getString('connection_timeout'); // '123'
$dsn->getDecimal('connection_timeout'); // 123  

Parse Cluster DSN:

<?php

use Enqueue\Dsn\Dsn;

$dsns = Dsn::parse('mysql+pdo://user:password@foo:3306,bar:5678/database?connection_timeout=123');

count($dsns); // 2

$dsns[0]->getUser(); // 'user'
$dsns[0]->getPassword(); // 'password'
$dsns[0]->getHost(); // 'foo'
$dsns[0]->getPort(); // 3306

$dsns[1]->getUser(); // 'user'
$dsns[1]->getPassword(); // 'password'
$dsns[1]->getHost(); // 'bar'
$dsns[1]->getPort(); // 5678  

Some parts could be omitted:

<?php
use Enqueue\Dsn\Dsn;

$dsn = Dsn::parseFirst('sqs:?key=aKey&secret=aSecret&token=aToken');

$dsn->getSchemeProtocol(); // 'sqs'
$dsn->getScheme(); // 'sqs'
$dsn->getSchemeExtensions(); // []
$dsn->getUser(); // null
$dsn->getPassword(); // null
$dsn->getHost(); // null
$dsn->getPort(); // null

$dsn->getString('key'); // 'aKey'
$dsn->getString('secret'); // 'aSecret'

Get typed query params:

<?php
use Enqueue\Dsn\Dsn;

$dsn = Dsn::parseFirst('sqs:?decimal=12&octal=0666&float=1.2&bool=1&array[0]=val&array[1]=123');

$dsn->getDecimal('decimal'); // 12
$dsn->getOctal('decimal'); // 0666
$dsn->getFloat('float'); // 1.2
$dsn->getBool('bool'); // true
$dsn->getArray('array')->getString(0); // val
$dsn->getArray('array')->getDecimal(1); // 123
$dsn->getArray('array')->toArray(); // [val]

Throws exception if DSN not valid:

<?php
use Enqueue\Dsn\Dsn;

$dsn = Dsn::parseFirst('foo'); // throws exception here

Throws exception if cannot cast query parameter:

<?php
use Enqueue\Dsn\Dsn;

$dsn = Dsn::parseFirst('mysql:?connection_timeout=notInt');

$dsn->getDecimal('connection_timeout'); // throws exception here

back to index