pyrrah/gravatar-bundle

The simple way to use Gravatar API for Symfony 4.4 to 7

Installs: 28 947

Dependents: 0

Suggesters: 0

Security: 0

Stars: 10

Watchers: 2

Forks: 3

Open Issues: 0

Type:symfony-bundle

v1.4.0 2024-01-20 00:57 UTC

This package is auto-updated.

Last update: 2024-05-01 20:25:42 UTC


README

Latest Version on Packagist Software License Total Contributors Total Downloads

This bundle allows you to display your avatar anywhere on your site, via the Gravatar service.

Requirements

Installation

  1. To install this bundle, run the following Composer command :
composer require pyrrah/gravatar-bundle
  1. 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"

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') ?>" />

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) }}" />

For more information look at the gravatar implementation pages.

Credits

License

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