搜索kikter / avatars
官方 Laravel 封装 avatars.com 和 LasseRafn/php-initial-avatar-generator
Requires
- php: ^7.3|^8.0
- laravel/framework: ~5.5|~5.6|~5.7|~5.8|~5.9|~6.0|^7.0|^8.0|^9.0
- lasserafn/php-initial-avatar-generator: ^4.0
Requires (Dev)
- phpunit/phpunit: ^7.0
- satooshi/php-coveralls: ^1.0
This package is auto-updated.
Last update: 2024-09-29 06:22:19 UTC
README
安装
只需使用 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