foinikas/gravatar

使用Laravel框架快速创建Gravatar

dev-master 2014-07-28 00:00 UTC

This package is not auto-updated.

Last update: 2024-09-24 01:36:00 UTC


README

Travis CI MIT

Laravel Gravatar是一种非常简单的方式,在Laravel 4框架中使用时,可以快速且高效地调用Gravatar并回退到备用图片。

安装

首先,通过Composer安装此软件包。编辑你的项目的composer.json文件,以要求安装foinikas/gravatar。

"require": {
    "foinikas/gravatar": "dev-master"
}

接下来,从终端更新Composer

composer update

一旦此操作完成,下一步是添加服务提供者。打开app/config/app.php,并向提供者数组添加一个新项。

'Foinikas\Gravatar\GravatarServiceProvider'

无需担心注册任何外观(Facade),因为它将自动为你注册一个名为Gravatar的新外观。

使用Gravatar

提供的方法

准备好调用你的第一个Gravatar了吗?好吧,只需创建一个Gravatar图片

Gravatar::image('my@email.com');

或者也许只需要一个Gravatar URL就足够了

Gravatar::url('my@email.com');

就是这样。你的Gravatar已经创建好了!

如果你只需要你的邮箱的哈希值

Gravatar::hash('my@email.com');

很简单,对吧?

参数

Gravatar的image方法可以接受相当多的选项

Gravatar::image($email, array $attrs = null, $size = 50, $default = null, $r = 'g', $secure = false);

Gravatar的url方法可以接受几乎相同的选项,除了$attrs数组

Gravatar::url($email, $size = 50, $default = null, $r = 'g', $secure = false);

Gravatar的hash方法只接受电子邮件地址作为参数

Gravatar::hash($email);

email

用户的电子邮件地址。

注意:如果提供了无效的电子邮件地址,将会抛出异常。

默认值:未提供

attributes

为创建的img标签提供的属性。用法

['class' => 'myClass', 'id' => 'myId'];

默认值:null

size

一个整数,表示你想要的Gravatar的大小。

默认值:50

default

这是当提供的电子邮件地址没有有效的Gravatar时的备用图片。这可以是默认的Gravatar标志,如果默认参数留空,或者可以是Gravatar的API提供的许多选项之一

'404', 'mm', 'identicon', 'monsterid', 'wavatar', 'retro', 'blank'

或者也可以是你选择的自定义图片的URL

'img/myimage.jpg'

如果你提供了自定义图片,那么该软件包将使用Laravel的URL::asset()方法创建一个完整的路径。

默认值:null(Gravatar标志)

rating

Gravatar的评级选项。Gravatar的API选项

'g', 'pg', 'r', 'x'

默认值:'g'

secure

如果你在通过SSL提供服务的页面上显示Gravatar,那么你也将通过SSL提供你的Gravatar。为了实现这一点,只需将其设置为true。

默认值:false

许可证

foinikas创建的所有代码都是开源软件,许可协议为MIT许可证

有关Gravatar API提供的默认选项的更多信息,请访问Gravatar