shoormax/gravatar

Gravatar URL构建器,通常被称为Gravatar库

v2.0.0 2019-01-08 21:43 UTC

This package is not auto-updated.

Last update: 2024-09-27 09:44:31 UTC


README

Latest Version Software License Build Status Code Coverage Quality Score Total Downloads

Gravatar URL构建器,通常被称为Gravatar库。

安装

通过Composer

$ composer require shoormax/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文档中定义的允许值进行核对

  • ssize -- 图片大小
  • ddefault -- 如果没有匹配的Gravatar,则显示的默认图片
  • fforcedefault -- 告诉Gravatar即使在有匹配的Gravatar的情况下也要使用默认图片
  • rrating -- 限制Gravatar的观众评级(GR等)

如果值验证失败,将抛出InvalidArgumentException。上述未列出的任何参数均未进行清理或验证。

注意

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

测试

$ composer test

致谢

许可

MIT许可(MIT)。有关更多信息,请参阅许可文件