# Identicon

**Repository Path**: wangyoko/Identicon

## Basic Information

- **Project Name**: Identicon
- **Description**: Generate awesome and unique identicons with beautiful colors
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-22
- **Last Updated**: 2021-02-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Identicon generator for PHP

[![Build Status](https://secure.travis-ci.org/yzalis/Identicon.png)](http://travis-ci.org/yzalis/Identicon)
[![codecov.io](https://codecov.io/github/yzalis/Identicon/coverage.svg?branch=master)](https://codecov.io/github/yzalis/Identicon?branch=master)

**Identicon** is a library which generate an [identicon](http://en.wikipedia.org/wiki/Identicon) image based on a string.

Here is some examples of awesome results!

![Identicon example #1](doc/benjaminAtYzalisDotCom.png)  
![Identicon example #2](doc/Benjamin.png)  
![Identicon example #3](doc/8.8.8.8.png)  
![Identicon example #4](doc/8.8.4.4.png)  
![Identicon example #5](doc/yzalis.png)

## Installation

The recommended way to install Identicon is through composer.

Just add the library to your project:

``` bash
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.

``` php
$identicon = new \Identicon\Identicon();
```

Then you can generate and display an identicon image

``` php
$identicon->displayImage('foo');
```

or generate and get the image data

``` php
$imageData = $identicon->getImageData('bar');
```

or generate and get the base 64 image uri ready for integrate into an HTML img tag.

``` php
$imageDataUri = $identicon->getImageDataUri('bar');
```
``` html
<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.

``` php
$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

``` php
$identicon->displayImage('bar', 64, 'A87EDF');
```

or an array with red, green, blue value

``` php
$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:
``` php
$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](https://github.com/yzalis/Identicon/graphs/contributors)

Inspired by Github [blog post](https://github.com/blog/1586-identicons) about Identicon.


## License

Identicon is released under the MIT License. See the bundled LICENSE file for details.