bowphp/gravatar

A Bow Framework Gravatar package for retrieving gravatar image URLs or checking the existance of an image.

dev-main 2024-12-10 07:01 UTC

Requires

• php: >=7.4

Requires (Dev)

• php: >=7.4
• bowphp/framework: ^5
• squizlabs/php_codesniffer: 3.*

MIT

• Franck

• gravatar
• avatar
• bowphp

README

Installation

First, pull in the package through Composer via the command line:

composer require bowphp/gravatar

Usage

Within your controllers or views, you can use

Gravatar::get('[e-mail]');

This will return the URL to the gravatar image of the specified email address. In case of a non-existing gravatar, it will return return a URL to a placeholder image. You can set the type of the placeholder in the configuration option fallback. For more information, visit gravatar.com

Alternatively, you can check for the existence of a gravatar image by using

Gravatar::exists('[e-mail]');

This will return a boolean (true or false).

Or you can pass a url to a custom image using the fallback method:

Gravatar::fallback('http://urlto.example.com/avatar.jpg')->get('[e-mail]');

Configuration

You can create different configuration groups to use within your application and pass the group name as a second parameter to the get-method:

There is a default group in config/gravatar.php which will be used when you do not specify a second parameter.

If you would like to add more groups, feel free to edit the config/gravatar.php file. For example:

return [
	'default' => [
		'size'   => 80,
		'fallback' => 'mm',
		'secure' => false,
		'maximumRating' => 'g',
		'forceDefault' => false,
		'forceExtension' => 'jpg',
 	],

 'small-secure' => [
    'size'   => 30,
    'secure' => true,
	],

	'medium' => [
    'size'   => 150,
	],
];

then you can use the following syntax:

Gravatar::get('[e-mail]', 'small-secure'); // will use the small-secure group
Gravatar::get('[e-mail]', 'medium'); // will use the medium group
Gravatar::get('[e-mail]', 'default'); // will use the default group
Gravatar::get('[e-mail]'); // will use the default group

Alternatively, you could also pass an array directly as the second parameter as inline options. So, instead of passing a configuration key, you pass an array, which will be merged with the default group:

Gravatar::get('[e-mail]', ['size' => 200]);