library identicon {🖫 0, ⚐ 6, ★ 0}

baruch4413/identicon

A PHP library for generating identicons.

Saturday, March 3, 2018
by Baruch4413
Repository
1 Watchers
0 Stars
0 Installations

PHP
0 Dependents
0 Suggesters
12 Forks
0 Open issues
6 Versions
0 % Grown

The README.md

PHP Identicon Generator

, _(*1)

This is a PHP library which generates identicons based on a given string. Currently only SVG format is supported as it offers the best combination of efficiency, quality, file size and ease of use., _(*2)

For integration with a symfony application, there is BitverseIdenticonBundle, _(*3)

Installation

Install using composer:, _(*4)

$ composer require baruch4413/identicon

Usage

The code below, will create a rings-identicon from the string "hello world", and save it to helloworld.svg., _(*5)

<?php

use Bitverse\Identicon\Identicon;
use Bitverse\Identicon\Color\Color;
use Bitverse\Identicon\Generator\RingsGenerator;
use Bitverse\Identicon\Preprocessor\MD5Preprocessor;

$generator = new RingsGenerator();
$generator->setBackgroundColor(Color::parseHex('#EEEEEE'));

$identicon = new Identicon(new MD5Preprocessor(), $generator);

$icon = $identicon->getIcon('hello world');

file_put_contents('helloworld.svg', $icon);

Identicon object

Identicon is the main service that's responsible for providing the identicons based on a given string. In order to do that, it's required to pass a preprocessor and a generator into it's constructor., _(*6)

You can then call the getIcon() function to create a new icon., _(*7)

Preprocessor

A preprocessor is an object that implements Bitverse\Identicon\Preprocessor\PreprocessorInterface., _(*8)

The role of the preprocessor is to conduct any action on the string before it's passed to the generate() method of the generator. This includes hashing., _(*9)

Currently, the library only includes MD5Preprocessor, which hashes the given string using MD5 algorithm., _(*10)

Generator

Generator is responsible for actually generating the icon from the hash produced by the preprocessor., _(*11)

Any object can be a generator as long as it implements Bitverse\Identicon\Generator\GeneratorInterface., _(*12)

Currently the library provides two generators by default:, _(*13)

RingsGenerator produces identicons made out of a centerpiece and three rings of different lengths and rotation., _(*14)
PixelsGenerator generates 5x5 pixels icons, similar to the ones used on github., _(*15)