README

Gravatar URL构建器（又称Gravatar库）

安装

通过Composer

$ composer require gravatarphp/gravatar

用法

创建一个Gravatar实例，并使用它来创建URL。

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');

您可以通过将最后一个参数设置为true/false来覆盖全局使用的协议（HTTP、HTTPS）。

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);

最后，但同样重要的是，您可以传递默认选项到构建器，并使用它们来生成头像URL。

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']);

参数

如果您传递以下任何参数并开启验证（avatar()方法中的第四个参数），它们的值将与Gravatar文档中定义的允许值进行核对。

• s、size -- 图片大小
• d、default -- 如果没有匹配的Gravatar则显示的默认图片
• f、forcedefault -- 告诉Gravatar即使有匹配的Gravatar也要使用默认图片
• r、rating -- 用于限制Gravatar的观众评级（G、R等）

如果值未通过验证，将抛出InvalidArgumentException。上述未列出的任何参数都不会进行清洗或验证。

注意

配置文件、vCard和二维码请求仅适用于主要电子邮件地址。这是Gravatar的限制。然而，构建器不会抱怨，因为它不知道这是否是您的首选地址。有关更多提示和详细信息，请参阅Gravatar文档。

测试

$ composer test

许可证

本项目受MIT许可证许可。