pyrrah / gravatar-bundle
The simple way to use Gravatar API for Symfony 6 and Symfony 7
Installs: 67 728
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 2
Forks: 5
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=8.1
- symfony/framework-bundle: ^6.4|^7.0
- symfony/templating: ^6.4|^7.0
Requires (Dev)
- symfony/phpunit-bridge: ^6.1|^7.0
Suggests
- twig/twig: For Gravatar twig extension usage
README
This bundle allows you to display your avatar anywhere on your site, via the Gravatar service.
Requirements
- Symfony 6.4 to 7.x
- PHP 8.1 or higher
- A Gravatar account - it's free!
Installation
- To install this bundle, run the following Composer command :
composer require pyrrah/gravatar-bundle
- If you always have some default for your gravatars such as size, rating or default it can be configured in your config :
# config/packages/pyrrah_gravatar.yaml pyrrah_gravatar: rating: "g" size: 80 default: "mp" format: "base64"
Note
The format option is specific to the bundle to choose the output format :
- url (default) : returns the https URL of the Gravatar image
- base64 : returns a base64-formatted image generated from the Gravatar URL
By using the "base64" option, you hide from your users the email hash used in the Gravatar URL.
Usage
All you have to do is use the helper like this example:
<img src="<?php echo $view['gravatar']->getUrl('alias@domain.tld') ?>" />
Or with parameters:
<img src="<?php echo $view['gravatar']->getUrl('alias@domain.tld', '80', 'g', 'defaultimage.png', 'base64') ?>" />
The only required parameter is the email adress. The rest have default values.
If you use twig you can use the helper like this example:
<img src="{{ gravatar('alias@domain.tld') }}" />
Or if you want to check if a gravatar email exists:
{% if gravatar_exists('alias@domain.tld') %}
The email is an gravatar email
{% endif %}
Or with parameters:
<img src="{{ gravatar('alias@domain.tld', size, rating, default, format) }}" />
For more information look at the gravatar implementation pages.
Credits
License
The MIT License (MIT). Please see License File for more information.