This package is abandoned. Please consider using an stable alternative for any production code.

Data URI

Starting with version 1.1.0 all URI objects are defined in the League\Uri namespace. The League\Uri\Schemes namespace is deprecated and will be removed in the next major release.

To ease working with Data URIs, the library comes bundle with a URI specific Data class. This class follows RFC2397

Instantiation¶

In addition to the defined named constructors, because data URI represents files, you can also instantiate a new data URI object from a file path using the createFromPath named constructor

<?php

use League\Uri;

$uri = Uri\Data::createFromPath('path/to/my/png/image.png');
echo $uri; //returns 'data:image/png;charset=binary;base64,...'
//where '...' represent the base64 representation of the file
copy 📋

If the file is not readable or accessible an UriException exception will be thrown. The class uses PHP’s finfo class to detect the required mediatype as defined in RFC2045.

Validation¶

Even though all URI properties are defined and accessible attempt to set any component other than the path will result in the object throwing a UriException exception. As adding data to theses URI parts will generate an invalid Data URI.

<?php

use League\Uri;

$uri = Uri\Data::createFromPath('path/to/my/png/image.png');
$uri->getHost(); //return '' an empty string
$uri->withHost('example.com'); // will throw an League\Uri\UriException
copy 📋