yzalis / identicon
Create awesome unique avatar.
Installs: 843 711
Dependents: 29
Suggesters: 0
Security: 0
Stars: 579
Watchers: 15
Forks: 94
Open Issues: 11
Requires
- php: >=5.5.0
Requires (Dev)
- ext-imagick: *
- fzaninotto/faker: ^1.2.0
- phpunit/phpunit: ^4.0 || ^5.0
This package is auto-updated.
Last update: 2021-03-04 10:33:22 UTC
README
Identicon is a library which generate an identicon image based on a string.
Here is some examples of awesome results!
Installation
The recommended way to install Identicon is through composer.
Just add the library to your project:
composer require yzalis/identicon
Usage
Images are generated in PNG format with transparent background.
The string can be an email, an IP address, a username, an ID or something else.
Generate an identicon
Create a new Identicon
object.
$identicon = new \Identicon\Identicon();
Then you can generate and display an identicon image
$identicon->displayImage('foo');
or generate and get the image data
$imageData = $identicon->getImageData('bar');
or generate and get the base 64 image uri ready for integrate into an HTML img tag.
$imageDataUri = $identicon->getImageDataUri('bar');
<img src="<?php echo $imageDataUri; ?>" alt="bar Identicon" />
Change the size
By default the size will be 64 pixels. If you want to change the image size just add a secondary parameter. 512 x 512px in this example.
$identicon->displayImage('foo', 512);
Color
The color is automatically generated according to the string hash but you can chose to specify a color by adding a third argument.
Color can be an hexadecimal with 6 characters
$identicon->displayImage('bar', 64, 'A87EDF');
or an array with red, green, blue value
$identicon->displayImage('foo', 64, array(200, 100, 150));
That's it!
Generate an identicon on SVG format
The only thing you need to change it this one:
$identicon = new \Identicon\Identicon(new SvgGenerator()); $imageDataUri = $identicon->getImageDataUri('bar'); <img src="<?= $imageDataUri; ?>" alt="bar Identicon" />
Unit Tests
To run unit tests, you'll need and a set of dependencies you can install using Composer:
php composer.phar install
Once installed, just launch the following command:
./vendor/bin/phpunit
Everything should be ok.
Credits
- Benjamin Laugueux benjamin@laugueux.org
- All contributors
Inspired by Github blog post about Identicon.
License
Identicon is released under the MIT License. See the bundled LICENSE file for details.