README

This package provides a PHP OOP builder for unavatar.

Installation

You can install the package via composer:

composer require astrotomic/php-unavatar

Usage

To create an Unavatar instance you can simply create one or use one of the static helper methods. Please refer to the unavatar docs for a full documentation of possibilities.

use Astrotomic\Unavatar\Unavatar;

$unavatar = new Unavatar('email@example.com');
Unavatar::email('email@example.com');
Unavatar::username('Astrotomic');
Unavatar::domain('astrotomic.info');
Unavatar::github('Astrotomic');

Fallback

You can also add a fallback image URL that's used if no image is found.

$unavatar->fallback('https://example.com/image.jpg');

URL

You can call toUrl() on your Unavatar instance to retrieve the full generated URL.

$unavatar->toUrl();

https://unavatar.now.sh/email%40example.com/?fallback=https%3A%2F%2Fexample.com%2Fimage.jpg

HTML img-tag

You can also call toImg() on your Unavatar instance to get a full HTML <img/> tag.

$unavatar->toImg(['loading' => 'lazy']);

<img
  alt="email@example.com's avatar"
  loading="lazy"
  src="https://unavatar.now.sh/email%40example.com/?fallback=https%3A%2F%2Fexample.com%2Fimage.jpg"
/>

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

• Tom Witkowski
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth