Download the PHP package joke-php/avatar without Composer
On this page you can find all versions of the php package joke-php/avatar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download joke-php/avatar
More information about joke-php/avatar
Files in joke-php/avatar
Package avatar
Short Description Module for the Joke framework for generating avatars based on nickname
License MIT
Informations about the package avatar
Joke Avatar
Библиотека для генерации квадратных PNG-аватаров на основе никнейма для PHP-фреймворка Joke.
Возможности
- Генерация квадратных PNG-аватаров на основе никнейма
- 6 встроенных тем оформления:
default,dark,warm,nature,ocean,sunset - Декоративные квадраты на аватаре (случайное количество, размер и цвет)
- Отображение первых двух символов никнейма
- Кэширование сгенерированных аватаров в
var/cache/avatars/ - Поддержка TrueType-шрифтов с автоматическим поиском системных шрифтов
- Проверка доступной памяти перед генерацией больших изображений
- PSR-4 автозагрузка, строгая типизация (
strict_types=1), PER-CS3
Требования
- PHP ^8.5
- PHP-расширение
ext-gd - Фреймворк
joke-php/joke^2.0
Установка
Использование
1. Регистрация сервис-провайдера
Добавьте AvatarProvider в файл bootstrap/kernel.php:
2. Конфигурация (опционально)
Создайте файл config/avatar.php для настройки размера и тем:
3. Генерация аватара в контроллере
4. Маршрут
Структура модуля
Темы оформления
Каждая тема содержит:
| Параметр | Описание |
|---|---|
background_colors |
Массив цветов фона (выбирается случайно) |
text_color |
Цвет текста |
decorative_colors |
Массив цветов декоративных квадратов |
decorative_min |
Минимальное количество квадратов |
decorative_max |
Максимальное количество квадратов |
decorative_size_min |
Минимальный размер квадрата (px) |
decorative_size_max |
Максимальный размер квадрата (px) |
Кэширование
Сгенерированные аватары кэшируются в директории var/cache/avatars/.
Ключ кэша — MD5-хеш от комбинации никнейма и темы.
При повторном запросе возвращается сохранённый файл.
Исключения
AvatarException— базовое исключение модуля (наследуетJokeException)AvatarGenerationException— ошибка при работе с GD (наследуетAvatarException)
Docker
Модуль можно запустить как самостоятельный микросервис через Docker.
Требования
- Docker Engine 24+
- Docker Compose v2+
Запуск
После запуска сервис доступен на http://localhost:8000.
Важно: При использовании флага
-fDocker Compose не подхватываетdocker-compose.override.ymlавтоматически. Если вы создали override-файл, указывайте его явно через дополнительный флаг-f:
Примеры запросов
Для браузера: Откройте
http://localhost:8000/avatar/Alice— сервер вернёт PNG-изображение. Встроенный PHP-сервер может не устанавливать корректный Content-Type для некоторых браузеров, поэтому изображение может отображаться не во всех браузерах. Для гарантированного результата используйтеcurl -o avatar.png http://localhost:8000/avatar/Alice.
Смена порта
Если порт 8000 занят, укажите другой через docker-compose.override.yml в корне проекта:
Запуск с override-файлом:
После этого сервис будет доступен на http://localhost:8080.
Привязка домена
Для доступа по доменному имени используйте reverse proxy (например, Nginx):
Либо укажите домен в docker-compose.override.yml через сети:
Остановка
Особенности
- Мультистейдж сборка: финальный образ содержит только runtime-зависимости
- Кэш аватаров сохраняется в Docker volume
avatar-cache - HEALTHCHECK через эндпоинт
/health - Запуск от непривилегированного пользователя
avatar - Для production рекомендуется использовать Nginx в качестве reverse proxy
Тестовое приложение
В репозитории доступно тестовое приложение для локальной проверки:
После запуска откройте в браузере:
http://localhost:8000/avatar/Alicehttp://localhost:8000/avatar/Bob?theme=darkhttp://localhost:8000/avatar/Charlie?theme=ocean
Разработка
Генерация кода
Весь исходный код данного модуля полностью создан AI-агентом SourceCraft Code Assistant (на базе Claude 3.5 Sonnet) в рамках проекта Joke.
- Архитектура и планирование: AI-агент в режиме Architect
- Реализация: AI-агент в режиме Code
- Отладка и тестирование: AI-агент в режиме Debug
- Оркестрация сложных задач: AI-агент в режиме Orchestrator
Генерация выполнялась в среде разработки VS Code с использованием Roo Code (расширение для AI-ассистированной разработки). Человек выступал в роли ревьюера и постановщика задач.
Лицензия
MIT