ranvis/identicon

Identicon with variable complexity.

Identicon

Identicon with variable complexity., _(*1)

Samples

https://github.com/ranvis/identicon/wiki/Samples, _(*2)

License

BSD 2-Clause License, _(*3)

Installation

composer require ranvis/identicon:1.0.*, _(*4)

1.1 or later may have visual incompatibility with 1.0., _(*5)

Upgrading

1.0.x is fully compatible with 1.0.0., _(*6)

See CHANGES.md for the details., _(*7)

Example Usage

use Ranvis\Identicon;

require_once __DIR__ . '/vendor/autoload.php';

//$hash = md5($userId . 'YOUR_RANDOM_SALT_HERE_&ar/1R#S[|=hDF');

$hash = $_GET['hash'] ?? '';
//$hash = isset($_GET['hash']) ? $_GET['hash'] : ''; // PHP 5
if (!preg_match('/\A[0-9a-f]{32}\z/', $hash)) {
    http_response_code(404);
    exit;
}

$tile = new Identicon\Tile();
$identicon = new Identicon\Identicon(64, $tile);
header('Cache-Control: public, max-age=31556952');
$identicon->draw($hash)->output();

Quick Reference

Identicon::__construct()

__construct($maxSize, TileInterface $tile, $tiles = 6, $colors = 2, $highQuality = true), _(*8)

• int $maxSize maximum size of the icon to draw
• TileInterface $tile tile to use
• int $tiles complexity of the icon
• int $colors maximum usable colors
• bool $highQuality prefer quality over memory and speed

Identicon->getMinimumHashLength()

getMinimumHashLength(): int, _(*9)

get number of hex characters required to draw icon., _(*10)

Identicon->draw()

draw($hash): $this, _(*11)

draw icon to internal buffer., _(*12)

• string $hash arbitrary hex string

returns $this., _(*13)

Identicon->output()

output($size = null, $compression = -1, $filters = -1): bool, _(*14)

print PNG image to stdout with Content-Type header., _(*15)

• int $size image size
• int $compression PNG compression level
• int $filters PNG filter flags to use

returns true on success., _(*16)

Identicon->save()

save($filePath, $size = null, $compression = -1, $filters = -1): bool, _(*17)

save PNG image to file., _(*18)

• string $filePath file path to save
• int $size image size
• int $compression PNG compression level
• int $filters PNG filter flags to use

returns true on success., _(*19)

Identicon->getImage()

getImage($size = null): resource, _(*20)

get icon image., _(*21)

• int $size image size

returns GD image., _(*22)