diego-brocanelli/image-gravatar-php

Library for get images Gravatar

1.0.0 2020-11-07 17:40 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpstan/phpstan: 0.12.x-dev
• phpunit/phpunit: ^9

MIT

• Diego Brocanelli

README

Component to search and obtain images registered in the Gravatar service.

Requirements

• PHP >= 7.4;
• Composer.

Tests

To run the component tests, run the command below.

composer tests

Code Analysis

The command below will run PHPStan level 4 analysis.

composer code-analysis

How to use

Instalation

composer require diego-brocanelli/image-gravatar-php dev-master

Getting image URL

<?php

require_once __DIR__.'/vendor/autoload.php';

use DiegoBrocanelli\Gravatar\Gravatar;

$email = '[e-mail]';
$gravatar = new Gravatar($email);

$url = $gravatar->buildURL(); // return: https://www.gravatar.com/avatar/dfeea822891ef9e6df82ec9f4a74cf8d?s=80&d=mm&r=g

Getting an image tag

<?php

require_once __DIR__.'/vendor/autoload.php';

use DiegoBrocanelli\Gravatar\Gravatar;

$email = '[e-mail]';
$gravatar = new Gravatar($email);

$image = $gravatar->buildImage(); // return: <img src='https://www.gravatar.com/avatar/dfeea822891ef9e6df82ec9f4a74cf8d?s=80&d=mm&r=g'/>

Configurations

Image Size

It can be used between 1px - 2048px, by default used 80px;

Example:

<?php

require_once __DIR__.'/vendor/autoload.php';

use DiegoBrocanelli\Gravatar\Gravatar;

$email = '[e-mail]';
$gravatar = new Gravatar($email);

$gravatar->setImageSize(200); // return image 200px

Image Set

The following options are available [404 | mm | identicon | monsterid | wavatar] 'mm' is used by default.

Example:

<?php

require_once __DIR__.'/vendor/autoload.php';

use DiegoBrocanelli\Gravatar\Gravatar;

$email = '[e-mail]';
$gravatar = new Gravatar($email);

$gravatar->setImageSet('wavatar');

Maximum rating

We have the following options available [g | pg | r | x] 'g' is used by default.

Exemple:

<?php

require_once __DIR__.'/vendor/autoload.php';

use DiegoBrocanelli\Gravatar\Gravatar;

$email = '[e-mail]';
$gravatar = new Gravatar($email);

$gravatar->setMaxRating('pg');

Image Options

We can include attributes in our image, thus facilitating its use, in the example below the CSS class 'image-gravatar' is inserted

Exemple:

<?php

require_once __DIR__.'/vendor/autoload.php';

use DiegoBrocanelli\Gravatar\Gravatar;

$email = '[e-mail]';
$gravatar = new Gravatar($email);

$gravatar->setImageOptions(array('class' => 'image-gravatar'));

$gravatar->buildImage(); // return: <img src='https://www.gravatar.com/avatar/dfeea822891ef9e6df82ec9f4a74cf8d?s=80&d=mm&r=g' class="image-gravatar"/>

Author

Diego Brocanelli Francisco

License

MIT