gravatarphp / gravatar
Gravatar URL builder which is most commonly called as a Gravatar library
Fund package maintenance!
gmponos
sagikazarmark
Installs: 369 576
Dependents: 4
Suggesters: 0
Security: 0
Stars: 12
Watchers: 4
Forks: 8
Open Issues: 2
Requires
- php: ^7.1
Requires (Dev)
- phpspec/phpspec: ^5.1
This package is auto-updated.
Last update: 2024-09-29 04:51:10 UTC
README
Gravatar URL builder (aka. a Gravatar library)
Install
Via Composer
$ composer require gravatarphp/gravatar
Usage
Create a Gravatar
instance and use it for creating URLs.
use Gravatar\Gravatar; // Defaults: no default parameter, use HTTPS $gravatar = new Gravatar([], true); // Returns https://secure.gravatar.com/avatar/EMAIL_HASH $gravatar->avatar('user@domain.com'); // Returns https://secure.gravatar.com/avatar/EMAIL_HASH // The fourth parameter enables validation and will prevent the // size parameter from being added to the URL generated. $gravatar->avatar('user@domain.com', ['s' => 9001], true, true); // Returns https://secure.gravatar.com/EMAIL_HASH $gravatar->profile('user@domain.com'); // Returns https://secure.gravatar.com/EMAIL_HASH.vcf $gravatar->vcard('user@domain.com'); // Returns https://secure.gravatar.com/EMAIL_HASH.qr $gravatar->qrCode('user@domain.com');
You can override the globally used protocol (HTTP, HTTPS) by setting the last parameter to true/false.
use Gravatar\Gravatar; $gravatar = new Gravatar(); // Returns http://www.gravatar.com/avatar/EMAIL_HASH $gravatar->avatar('user@domain.com', [], false); // Returns http://www.gravatar.com/EMAIL_HASH $gravatar->profile('user@domain.com', false); // Returns http://www.gravatar.com/EMAIL_HASH.vcf $gravatar->vcard('user@domain.com', false); // Returns http://www.gravatar.com/EMAIL_HASH.qr $gravatar->qrCode('user@domain.com', false);
Last, but not least, you can pass default options to the builder and use them to generate avatar URLs.
use Gravatar\Gravatar; $gravatar = new Gravatar([ 'size' => 500, ]); // Returns https://secure.gravatar.com/avatar/EMAIL_HASH?size=500&r=g $gravatar->avatar('user@domain.com', ['r' => 'g']);
Parameters
If you pass any of the following parameters and turn validation on (fourth parameter in the avatar()
method), their values will be checked against the allowed values defined in the Gravatar documentation:
s
,size
-- The image sized
,default
-- The default image to display if there is no matching Gravatarf
,forcedefault
-- Tell Gravatar to use the default image even if there is a matching Gravatarr
,rating
-- The audience rating (G
,R
, etc.) to restrict the Gravatar to
If the value fails validation, an InvalidArgumentException
will be thrown.
Any parameters not listed above are not sanitized or validated in anyway.
Notes
Profile, vCard and QR Code requests will only work with the primary email address. This is a limitation of Gravatar. However the builder won't complain, since it doesn't know if it is your primary address or not. For more tips and details check the Gravatar documentation.
Testing
$ composer test
License
The project is licensed under the MIT License.