README

通过用户名、文件或 URL 为 Yii2 生成头像。

功能

• 通过用户名生成头像
• 从文件或 URL（仅限 http）生成头像
• 自动根据用户名选择背景颜色
• 文本对比颜色
• 字体样式和大小自定义
• 背景纹理（目前有 2 种）

依赖

• PHP 7
• PHP GD
• zertex/avatar-generator

安装

使用 composer 安装

composer require zertex/yii2-avatar-generator

或添加

"zertex/yii2-avatar-generator": "*"

到你的 composer.json 文件的 require 部分。

配置

添加到 common/config/main.php 或 config/web.php

'components' => [
    ...
    'avatar' => [
        'class' => \zertex\avatar_generator\AvatarGenerator::class,
        'images_folder' => 'path_to_image_files',
        'images_url' => 'url_to_image_files',
        'size_width' => 300,            // default: 300
        'font' => 'path_to_ttf_font',   // default: Play-Bold // may use aliases
        'font_size' => 200,             // default: 200
        'salt' => 'random_salt',        // salt for image file names
        'texture' => ['sun', 'rain'],   // texture name
        'text_over_image' => true,      // draw text over image (for avatar from file)
        'texture_over_image' => true,   // draw texture over image (for avatar from file)
    ],
],

• images_folder - 必需 图片文件夹
• images_url - 必需 图片文件夹的 URL
• size_width - 原始图片边宽。默认: 300
• font - TTF 字体文件的路径。Yii2 别名准备就绪。默认: Play-Bold.ttf
• font_size - 字体大小。默认: 300
• salt - 用于图片文件名的随机垃圾数据
• texture - 纹理名称：sun, rain。默认：空
• text_over_image - 在图片上绘制文本。针对从文件创建的头像。默认：true
• texture_over_image - 在图片上绘制纹理。针对从文件创建的头像。默认：true

使用

Yii::$app->avatar->show('username', [width], [file or url], [new_file_name]);

使用默认图像分辨率进行简单使用

<?= Yii::$app->avatar->show('John Smith') ?>

边宽为 150 像素的图像

<?= Yii::$app->avatar->show('John Smith', 150) ?>

默认图像分辨率的现有文件图像

<?= Yii::$app->avatar->show('John Smith', null, '/path/JM_Avatar.jpg') ?>

或

<?= Yii::$app->avatar->show('John Smith', null, 'http://site.org/JM_Avatar.jpg') ?>

边宽为 150 像素的现有文件图像

<?= Yii::$app->avatar->show('John Smith', 150, '/path/JM_Avatar.jpg') ?>

不使用 Yii2 包装使用

您可以使用头像生成器而不使用 Yii2 包装。只需安装 https://github.com/zertex/avatar-generator

屏幕截图

示例

https://zertex.ru/yii2-avatar-generator