runmybusiness/initialcon

Create a GMail esque avatar based on the users intials & a persistant identifier such as an email address.

Initial based icon generator for PHP

, _(*1)

        , _(*2)

Installation

The recommended way to install Initialcon is through composer., _(*3)

Just create a composer.json file for your project:, _(*4)

``` json { "require": { "runmybusiness/initialcon": "*" } }, <sub>(*5)</sub>

And run these two commands to install it:

``` bash
$ wget http://getcomposer.org/composer.phar
$ php composer.phar install

Now you can add the autoloader (if your framework doesn't already do this for you), and you will have access to the library:, <sub>(*6)</sub>

``` php displayImage('TS', 'tom@test.com'); ``` or generate and get the image data ``` php $imageData = $initialcon->getImageData('TS', 'tom@test.com'); ``` or generate and get the base 64 image uri ready for integrate into an HTML img tag. ``` php $imageDataUri = $initialcon->getImageDataUri('HI', 'hello@test.com'); ``` ``` html , <sub>(*7)</sub>

### 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
$initialcon->displayImage('TS', 'tom@test.com', 512);

Color

The color is automaticaly generated according to the string hash but you can chose to specify a color by adding a third argument., <sub>(*8)</sub>

Color can be an hexadecimal with 6 characters, <sub>(*9)</sub>

``` php $initialcon->displayImage('TS', 'tom@test.com', 64, 'A87EDF');, <sub>(*10)</sub>

### Image Object

You can also grab the Image object to add more manipulation to the final icon (such as rounded corders, opacity, etc).
We use the [Intervention](http://image.intervention.io/) library for image creation so all of its' methods are available to you.

```php
$initialcon->getImageObject('TS', 'tom@test.com', 512);

That's it!, <sub>(*11)</sub>

Unit Tests

To run unit tests, you'll need and a set of dependencies you can install using Composer:, <sub>(*12)</sub>

php composer.phar install

Once installed, just launch the following command:, <sub>(*13)</sub>

phpunit

Everythings should be ok., <sub>(*14)</sub>

Credits

• Originally forkeed from Benjamin Laugueux's great Identicon library at (https://github.com/yzalis/Initialcon)

License

Initialcon is released under the MIT License. See the bundled LICENSE file for details., <sub>(*15)</sub>