astrotomic/laravel-unavatar

Laravel integration of unavatar service.

0.5.0 2024-06-25 14:14 UTC

Requires

• php: ^8.0
• ext-json: *
• astrotomic/php-unavatar: ^0.3.0
• illuminate/support: ^8.0 || ^9.0 || ^10.0 || ^11.0
• illuminate/view: ^8.0 || ^9.0 || ^10.0 || ^11.0

Requires (Dev)

• gajus/dindent: ^2.0
• laravel/pint: ^1.0
• orchestra/testbench: ^6.0 || ^7.0 || ^8.0 || ^9.0
• phpunit/phpunit: ^9.3 || ^10.0

MIT

• Tom Witkowski

• laravel
• avatar
• astrotomic
• unavatar
• laravel-unavatar

README

This package provides a Laravel wrapper for unavatar.

Installation

You can install the package via composer:

composer require astrotomic/laravel-unavatar
php artisan vendor:publish --provider="Astrotomic\LaravelUnavatar\UnavatarServiceProvider" --tag=config

Usage

Most of the logic and possibilities is inherited from the astrotomic/php-unavatar base package. On top this package adds some Laravel specific possibilities. The \Astrotomic\LaravelUnavatar\Unavatar class implements several interfaces:

• \Illuminate\Contracts\Support\Renderable
• \Illuminate\Contracts\Support\Responsable
• \Illuminate\Contracts\Support\Htmlable
• \Illuminate\Contracts\Support\Jsonable
• \JsonSerializable
• \Illuminate\Contracts\Support\Arrayable

So you can use the use your Unavatar instances in your controllers as response but for sure also in your views. The last three ones will use the unavatar JSON API - so they will start a HTTP request.

Blade Component

The package provides a blade component you can use in your views.

<x-unavatar::img :email="$user->email" :alt="$user->name" />

<img
  src="https://unavatar.now.sh/[e-mail]"
  alt="Gummibeer"
  loading="lazy"
/>

You can also publish the used view and customize it.

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