rackbeat/laravel-ui-avatars

ui-avatars.com和LasseRafn/php-initial-avatar-generator的官方Laravel包装器

1.2 2023-03-18 03:00 UTC

This package is auto-updated.

Last update: 2024-09-18 10:01:31 UTC


README

Build Status Coverage Total Downloads Latest Stable Version License

安装

您只需要使用composer,一切就绪!

composer require rackbeat/laravel-ui-avatars

服务提供者会自动注册。

设置

要设置配置文件,您可以通过以下方式发布它

php artisan vendor:publish --provider="Rackbeat\UIAvatars\UIAvatarsServiceProvider"

您可以在config/ui-avatars.php中编辑该文件。

用法

1. 将Rackbeat\UIAvatars\HasAvatar特质添加到您的模型(例如App\Users

// ...
class User extends Authenticatable {
  use \Rackbeat\UIAvatars\HasAvatar;
  // ...
}

2. 在您的模型上创建一个新方法。

此方法实际上是一个代理,用于调用HasAvatar方法。它将返回电子邮件的Gravatar,并回退到使用ui-avatars.com API的头像。

public function getAvatar( $size = 64 ) {
  return $this->getGravatar( $this->email, $size );
}

注意:只有通过API使用Gravatar,本地生成的头像不可用。

3. (可选)重定义名称字段

假设您不是在Laravel中使用默认的User模型,您可以覆盖用于名称的字段。

public function getAvatarNameKey( ) {
  return 'full_name';
}

可用方法

getInitials($length=null)

返回用于头像的名称生成的初始字母。

默认$length可以在config/ui-avatars.php中定义(length键)

getUrlfriendlyAvatar($size=null)

返回格式化的头像URL(URL或base64)。

示例用法

<img src="{{ $user->getUrlfriendlyAvatar() }}" />

默认$size可以在config/ui-avatars.php中定义(image_size键)

getAvatarBase64($size=null)

返回头像的base64表示。

默认$size可以在config/ui-avatars.php中定义(image_size键)

getAvatarImage($size=null)

返回头像的Image对象。

默认$size可以在config/ui-avatars.php中定义(image_size键)

getGravatar($email, $size=null)

返回使用指定电子邮件的Gravatar图像链接,如果失败则使用我们的生成器(假设提供者为api

默认$size可以在config/ui-avatars.php中定义(image_size键)

可用选项

您可以在配置文件中指定不同的选项。

要求

  • PHP >= 7.1