PHP Initial Avatar Generator

https://github.com/lasserafn/php-initial-avatar-generator
Admin
PHP Initial Avatar Generator is a PHP library for generating customizable initial-based avatar...
Tokens:24,614
Snippets:270
Trust Score:8.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### background() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Example of setting a background color and generating an avatar.

```php
$avatar->background('#8BC34A')->generate();
```

--------------------------------

### randomBackground() usage examples

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Examples of enabling random background with default settings, custom saturation/luminance, and disabling it.

```php
$avatar->randomBackground();                 // random hue, sat 85%, lum 60%
$avatar->randomBackground(true, 40, 70);     // pastel palette
$avatar->randomBackground(false);            // back to fixed color
```

--------------------------------

### font() usage examples

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Examples of setting a font by path and by GD built-in font number.

```php
$avatar->font('/fonts/OpenSans-Semibold.ttf')->generate();
$avatar->font(2)->generate();            // GD built-in font #2
$avatar->font('/absolute/path/font.ttf')->generate();
```

--------------------------------

### getInitials() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Shows how to retrieve the initials for a name set via name().

```php
$avatar = new InitialAvatar();
$avatar->name('John Doe');
echo $avatar->getInitials(); // JD
```

--------------------------------

### Install via Composer

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Use Composer to add the package to your project dependencies.

```bash
composer require lasserafn/php-initial-avatar-generator
```

--------------------------------

### name() usage examples

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Examples of setting names and explicit initials. The value is passed through the translator and forwarded to the Initials generator.

```php
$avatar->name('Lasse Rafn');            // initials: LR
$avatar->name('MA');                    // explicit initials kept as-is
$avatar->name('Gustav Årgonson');       // dialect letters preserved: GÅ
```

--------------------------------

### autoColor() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Example of generating an avatar with automatic colors based on the name.

```php
$avatar->name('Albert Magnum')->autoColor()->generate(); // deterministic per name
```

--------------------------------

### fontName() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Example of setting a font family for SVG output.

```php
$avatar->fontName('Arial, Helvetica, sans-serif')->generateSvg();
```

--------------------------------

### size() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Generates a 96x96 pixel avatar.

```php
$avatar->size(96)->generate(); // 96x96 image
```

--------------------------------

### Basic generateSvg() example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Simple `generateSvg()` usage: set name via `name()` and directly output the SVG XML string.

```php
$avatar = new InitialAvatar();
echo $avatar->name('Lasse Rafn')->generateSvg()->toXMLString(); // SVG XML string
```

--------------------------------

### preferBold() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Generates an avatar with bold font preference.

```php
$avatar->preferBold()->generate();
```

--------------------------------

### glyph() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets a FontAwesome glyph and generates an avatar with custom font, background, and color.

```php
$avatar->glyph('f007')
       ->font('/fonts/FontAwesome5Free-Regular-400.otf')
       ->background('#ff0000')
       ->color('#fff')
       ->generate();
```

--------------------------------

### Advanced generate() with inline name and driver

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Advanced `generate()` example: uses `gd()` driver, sets font size, background and color, enables rounded and smooth, and passes an emoji name inline. The generated image is saved to a file.

```php
$image = (new InitialAvatar())
    ->gd()
    ->fontSize(0.4)
    ->background('#8BC34A')
    ->color('#fff')
    ->rounded()
    ->smooth()
    ->generate('😅'); // or any unicode name

$image->save('/tmp/avatar.png');
```

--------------------------------

### length() usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the length to 3 and generates initials from a name with three words.

```php
$avatar->name('John Doe Johnson')->length(3)->generate(); // initials: JDJ
```

--------------------------------

### Generate avatar with chained methods

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Chains name(), length(), fontSize(), size(), background(), color(), generate(), and stream() to produce a PNG avatar. The size is set to 96 (48 * 2) for retina displays. The font() method is intentionally not used in this example.

```php
return $avatar->name('Lasse Rafn')
              ->length(2)
              ->fontSize(0.5)
              ->size(96) // 48 * 2
              ->background('#8BC34A')
              ->color('#fff')
              ->generate()
              ->stream('png', 100);
```

--------------------------------

### Custom translator example (Fr)

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Shows a custom French translator implementing Base and registering it via addTranslators(). The translator replaces 'Mr ' and 'Mrs ' with 'M. ' and 'Mme ' and reports source language 'fr'.

```php
use LasseRafn\InitialAvatarGenerator\Translator\Base;

class Fr implements Base
{
    public function translate($words)
    {
        return str_replace(['Mr ', 'Mrs '], ['M. ', 'Mme '], $words);
    }

    public function getSourceLanguage()
    {
        return 'fr';
    }
}

$avatar = (new InitialAvatar())
    ->addTranslators(['fr' => Fr::class])
    ->language('fr')
    ->name('Mr Martin');
```

--------------------------------

### getBackgroundColor() random per call example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Demonstrates that when randomBackground() is enabled, getBackgroundColor() returns a new random color on every call.

```php
$avatar->randomBackground();
$first  = $avatar->getBackgroundColor();
$second = $avatar->getBackgroundColor();
var_dump($first !== $second); // true — random per call
```

--------------------------------

### Create avatar.php Endpoint

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

A PHP script that generates an avatar based on a GET parameter and streams it as a PNG.

```php
<?php
require 'vendor/autoload.php'; 

use LasseRafn\InitialAvatarGenerator\InitialAvatar;

header('Content-Type: image/png'); // Set the content type to PNG

$avatar = new InitialAvatar();
$name = isset($_GET['name']) ? $_GET['name'] : 'Default User';

// Generate the image
$image = $avatar->name($name)->generate();

// Stream the image directly to the output
echo $image->stream('png', 100);
exit;
```

--------------------------------

### ZhCN translator usage example

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Example usage of the ZhCN translator: sets language to 'zh-CN' and name to '李雷', then echoes initials derived from the pinyin translation.

```php
$avatar = new InitialAvatar();
$avatar->language('zh-CN')->name('李雷');
echo $avatar->getInitials(); // initials derived from implode(' ', Pinyin::name($words))
```

--------------------------------

### Advanced generateSvg() with FontAwesome glyph

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Advanced SVG generation example: uses a FontAwesome glyph, custom font, rounded shape, background and color, then saves the SVG to a file for `<img>` usage.

```php
$svg = (new InitialAvatar())
    ->glyph('f007')                          // FontAwesome "user"
    ->font('/fonts/FontAwesome5Free-Solid-900.otf')
    ->fontName('Font Awesome 5 Free')
    ->rounded()
    ->background('#ff0000')
    ->color('#fff')
    ->generateSvg();

// Store in a file for <img src="..."> usage
file_put_contents('/tmp/avatar.svg', $svg->toXMLString());
```

--------------------------------

### Set language with `language()` before `name()`

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Sets the language for name translation. Must be called before `name()`; unknown languages fall back to 'en'. The second example shows a Chinese name being translated to pinyin before initials are derived.

```php
/**
 * Set language of name, pls use `language` before `name`, just like
 * ```php
 * $avatar->language('en')->name('Mr Green'); // Right
 * $avatar->name('Mr Green')->language('en'); // Wrong
 * ```
 *
 * @param string $language
 *
 * @return $this
 */
public function language($language)
```

```php
$avatar->language('zh-CN')->name('李雷'); // translated to pinyin before initials derivation
```

--------------------------------

### Render FontAwesome glyph avatar

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Uses glyph() instead of name() to display a FontAwesome icon. Requires setting the font to the FontAwesome OTF file. The example renders a red avatar with a white user glyph (unicode f007).

```php
// note that we
// 1) use glyph() instead of name
// 2) change the font to FontAwesome!
return $avatar->glyph('f007')
              ->font('/fonts/FontAwesome5Free-Regular-400.otf')
              ->color('#fff')
              ->background('#ff0000')
              ->generate()
              ->stream('png', 100);
```

--------------------------------

### Add custom translators with `addTranslators()`

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Adds custom translators via a language-key to translator-class map. Custom classes must implement `Base` and take no constructor arguments. The example shows adding a French translator and using it with `language('fr')`.

```php
/**
 * Add new translators designed by user.
 *
 * @param array $translatorMap
 *                             ```php
 *                             $translatorMap = [
 *                             'fr' => 'foo\bar\Fr',
 *                             'zh-TW' => 'foo\bar\ZhTW'
 *                             ];
 *                             ```
 *
 * @return $this
 */
public function addTranslators($translatorMap)
```

```php
$avatar->addTranslators(['fr' => Fr::class])->language('fr')->name('Mr Martin');
```

--------------------------------

### setupImageManager() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that builds the ImageManager instance. Called from the constructor and from gd()/imagick().

```php
protected function setupImageManager()
```

--------------------------------

### Constructor

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Creates a new InitialAvatar instance with default configuration.

```APIDOC
## Constructor

### `__construct()`

```php
public function __construct()
```

Takes no parameters. Creates a new `Intervention\Image\ImageManager` configured with the current driver (`gd` by default, see `setupImageManager()`) and a new `LasseRafn\Initials\Initials` generator instance.

```php
$avatar = new InitialAvatar(); // fully configured with package defaults
```

```

--------------------------------

### Constructor: Create InitialAvatar instance

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Creates a new InitialAvatar instance with default configuration. No parameters are required.

```php
$avatar = new InitialAvatar(); // fully configured with package defaults
```

--------------------------------

### Switch Driver

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Choose between GD and Imagick drivers. Defaults to gd.

```php
$image = $avatar->gd()->generate(); // Uses GD driver
$image = $avatar->imagick()->generate(); // Uses Imagick driver
```

--------------------------------

### generate() basic usage

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Basic usage of `generate()`: instantiate `InitialAvatar`, chain `name()` and `size()`, then output the PNG stream as HTTP response.

```php
use LasseRafn\InitialAvatarGenerator\InitialAvatar;

$avatar = new InitialAvatar();
$image = $avatar->name('Lasse Rafn')->size(96)->generate();

header('Content-Type: image/png');
echo $image->stream('png', 100);
```

--------------------------------

### Generate PNG and SVG from InitialAvatar configuration

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Creates an InitialAvatar instance, sets name, length, font size, size, background, and color, then generates a PNG stream and an SVG XML string from the same configuration.

```php
use LasseRafn\InitialAvatarGenerator\InitialAvatar;

$avatar = new InitialAvatar();
$avatar->name('Lasse Rafn')
       ->length(2)
       ->fontSize(0.5)
       ->size(96)          // 48 * 2
       ->background('#8BC34A')
       ->color('#fff');

// Raster path
$png = $avatar->generate()->stream('png', 100);

// Vector path from the same configuration
$svgXml = $avatar->generateSvg()->toXMLString();
```

--------------------------------

### getInitials()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the generated initials for the current name.

```APIDOC
### Method
`getInitials()`

### Description
Returns the generated initials for the current name, recomputed on each call with the current `keepCase` and `allowSpecialCharacters` settings.

### Return Type
`string`

### Return Value
The initials for the current name.

### Example
```php
$avatar = new InitialAvatar();
$avatar->name('John Doe');
echo $avatar->getInitials(); // JD
```

### Source
`src/InitialAvatar.php:453`
```

--------------------------------

### getInitials() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the generated initials for the current name, recomputed on each call with the current keepCase and allowSpecialCharacters settings.

```php
/**
 * Will return the generated initials.
 *
 * @return string
 */
public function getInitials()
```

--------------------------------

### imagick()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the image driver to Imagick and rebuilds the ImageManager. Requires the Imagick PHP extension (>= 6.5.7).

```APIDOC
## `imagick()`

### Description
Sets the image driver to Imagick and rebuilds the ImageManager. Requires the Imagick PHP extension (>= 6.5.7).

### Method
`imagick()`

### Parameters
None.

### Returns
`$this` (chainable)

### Example
```php
$avatar->imagick()->generate();
```

```

--------------------------------

### Enable Smooth Rounding

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Apply a resizing hack to make rounded edges smoother. Defaults to false.

```php
$image = $avatar->rounded()->smooth()->generate();
```

--------------------------------

### imagick() - Use Imagick driver

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the driver to 'imagick' and rebuilds the ImageManager. Requires the Imagick PHP extension (>= 6.5.7). Returns $this for chaining.

```php
$avatar->imagick()->generate();
```

--------------------------------

### gd()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the image driver to GD (the default) and rebuilds the ImageManager. Requires GD >= 2.0.

```APIDOC
## `gd()`

### Description
Sets the image driver to GD (the default) and rebuilds the ImageManager. Requires GD >= 2.0.

### Method
`gd()`

### Parameters
None.

### Returns
`$this` (chainable)

### Example
```php
$avatar->gd()->generate();
```

```

--------------------------------

### size()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets both width and height of the avatar image to the same value. Returns the instance for chaining.

```APIDOC
## `size()`

### Description
Sets the avatar/image size in pixels.

### Method
`size`

### Parameters
- `$size` (int) - Required - Width and height in pixels (proxy for `width($x)->height($x)`)

### Returns
`$this` (chainable)

### Example
```php
$avatar->size(96)->generate(); // 96x96 image
```

```

--------------------------------

### getDriver() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the set driver, either 'gd' or 'imagick'.

```php
/**
 * Will return the set driver.
 *
 * @return string
 */
public function getDriver()
```

--------------------------------

### background()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the background color. Disables random background mode. Chainable.

```APIDOC
## background()

### Description
Sets the background color of the avatar. Disables random background mode.

### Method
`background($background)`

### Parameters
- **$background** (string) - Required - Color value accepted by the image driver, e.g. `'#ff0000'`

### Returns
`$this` - Chainable.

### Behavior
Casts to string and sets `randomBgColor = false`.

### Example
```php
$avatar->background('#8BC34A')->generate();
```

### Source
`src/InitialAvatar.php:203`
```

--------------------------------

### size() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the avatar/image size in pixels. Casts to int and sets both width and height. Returns $this for chaining.

```php
/**
 * Set the avatar/image size in pixels.
 *
 * @param int $size
 *
 * @return $this
 */
public function size($size)
```

--------------------------------

### background() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Defines the background() method that sets the background color. Accepts a string color value. Returns $this for chaining. Casts to string and disables random background mode.

```php
/**
 * Set the background color.
 *
 * @param string $background
 *
 * @return $this
 */
public function background($background)
```

--------------------------------

### gd() - Use GD driver

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the driver to 'gd' (the default) and rebuilds the ImageManager. Requires GD >= 2.0. Returns $this for chaining.

```php
$avatar->gd()->generate();
```

--------------------------------

### InitialAvatar class declaration

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

The full class skeleton showing all protected properties and their default values. Use this to understand the container of state consumed by the generate() and generateSvg() methods. The class follows a fluent builder pattern where every configuration method returns $this.

```php
class InitialAvatar
{
    /** @var ImageManager */
    protected $image;

    /** @var Initials */
    protected $initials_generator;

    protected $driver = 'gd'; // imagick or gd
    protected $fontSize = 0.5;
    protected $name = 'John Doe';
    protected $width = 48;
    protected $height = 48;
    protected $bgColor = '#f0e9e9';
    protected $fontColor = '#8b5d5d';
    protected $rounded = false;
    protected $smooth = false;
    protected $autofont = false;
    protected $keepCase = false;
    protected $allowSpecialCharacters = true;
    protected $fontFile = '/fonts/OpenSans-Regular.ttf';
    protected $fontName = 'OpenSans, sans-serif';
    protected $generated_initials = 'JD';
    protected $preferBold = false;
    protected $randomBgColor = false;

    /** Language eg.en zh-CN. @var string */
    protected $language = 'en';

    /** Role translator. @var Base */
    protected $translator;

    protected $translatorMap = [
        'en'    => En::class,
        'tr'    => Tr::class,
        'zh-CN' => ZhCN::class,
    ];
}
```

--------------------------------

### getSize() method signature (deprecated)

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Deprecated method that returns the current width. Use getWidth() / getHeight() instead.

```php
/**
 * @deprecated for getWidth and getHeight
 */
public function getSize()
```

--------------------------------

### autoColor()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Automatically generates deterministic font and background colors based on the provided name. Chainable.

```APIDOC
## autoColor()

### Description
Automatically sets font and background colors based on the supplied name. The hue is derived from the name using `crc32($this->name) % 360`, then converted to a hex background using `convertHSLtoRGB()`. Contrasting black/white font color is chosen with `getContrastColor()`. The same name always yields the same colors.

### Method
public autoColor(bool $foreground = true, bool $background = true, int $saturation = 85, int $luminance = 60)

### Parameters
- **$foreground** (bool) - Default: `true` - Accepted but ignored; the font color is always set.
- **$background** (bool) - Default: `true` - Accepted but ignored; the background color is always set.
- **$saturation** (int) - Default: `85` - HSL saturation (0–100).
- **$luminance** (int) - Default: `60` - HSL luminance (0–100).

### Returns
`$this` - Chainable.

### Notes
- `$this->name` must be set beforehand, call `name()` before `autoColor()`.

### Example
```php
$avatar->name('Albert Magnum')->autoColor()->generate(); // deterministic per name
```

### Source
`src/InitialAvatar.php:254`
```

--------------------------------

### Enable AutoFont

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Automatically detect the language script and select a compatible font. Defaults to false.

```php
$image = $avatar->autoFont()->generate();
```

--------------------------------

### autoColor() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Defines the autoColor() method that automatically sets font and background colors based on the name. Accepts optional booleans and saturation/luminance integers. Returns $this for chaining. The foreground and background parameters are ignored; both colors are always set. The name must be set beforehand.

```php
/**
 * Automatically set a font and/or background color based on the supplied name.
 *
 * @param bool $foreground
 * @param bool $background
 *
 * @return $this
 */
public function autoColor(bool $foreground = true, bool $background = true, int $saturation = 85, int $luminance = 60)
```

--------------------------------

### getContrastColor() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that computes luminance contrast ratio and returns black or white based on threshold 5.

```php
protected function getContrastColor($hexColor)
```

--------------------------------

### getDriver()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the current image driver.

```APIDOC
### Method
`getDriver()`

### Description
Returns the image driver being used.

### Return Values
`string` — `'gd'` or `'imagick'`

### Source
`src/InitialAvatar.php:492`
```

--------------------------------

### smooth() - Smooth rounded edges

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Enables a resizing hack to smooth edges of rounded avatars. Only has an effect when rounded() is also enabled. When both are active, the font size is computed from the downscaled width. Returns $this for chaining.

```php
$avatar->rounded()->smooth()->generate();
```

--------------------------------

### Enable Auto Color

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Automatically choose a background color based on the name and a contrasting font color.

```php
// Will choose a background color based on `name` and a contrasting font color. The color for a specific name will always be the same.
$image = $avatar->autoColor()->generate();
```

--------------------------------

### autoFont($autofont = true)

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets whether to detect the character script and use a font that supports it. Uses LasseRafn\StringScript detection; supported scripts: Arabic, Armenian, Bengali, Georgian, Hebrew, Mongolian, Thai, Tibetan, Turkish (Latin), Chinese, Japanese.

```APIDOC
## `autoFont($autofont = true)`

### Description
Sets whether to detect the character script and use a font that supports it. Uses LasseRafn\StringScript detection; supported scripts: Arabic, Armenian, Bengali, Georgian, Hebrew, Mongolian, Thai, Tibetan, Turkish (Latin), Chinese, Japanese.

### Method
`autoFont($autofont = true)`

### Parameters
- **$autofont** (bool) - Optional - Default: `true` - Detect the written script of the initials and pick a bundled font that supports it.

### Returns
`$this` (chainable)

### Example
```php
$avatar->autoFont()->generate('الحزمة'); // Arabic
$avatar->autoFont()->generate('こんにちは'); // Japanese
```

```

--------------------------------

### color() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Defines the color() method that sets the font color. Accepts a string color value. Returns $this for chaining. Casts to string.

```php
/**
 * Set the font color.
 *
 * @param string $color
 *
 * @return $this
 */
public function color($color)
```

--------------------------------

### height()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the height of the avatar image. Returns the instance for chaining.

```APIDOC
## `height()`

### Description
Sets the avatar/image height in pixels.

### Method
`height`

### Parameters
- `$height` (int) - Required - Height in pixels

### Returns
`$this` (chainable)

```

--------------------------------

### width()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the width of the avatar image. Returns the instance for chaining.

```APIDOC
## `width()`

### Description
Sets the avatar/image width in pixels.

### Method
`width`

### Parameters
- `$width` (int) - Required - Width in pixels

### Returns
`$this` (chainable)

```

--------------------------------

### generate() method signature with PHPDoc

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Public method `generate()` with optional `$name` parameter, returning an `Intervention\Image\Image`. Documented in the source code with PHPDoc annotation.

```php
/**
 * Generate the image.
 *
 * @param null|string $name
 *
 * @return Image
 */
public function generate($name = null)
```

--------------------------------

### Set Avatar Size

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Set both width and height simultaneously. Defaults to 48.

```php
// will be 96x96 pixels.
$image = $avatar->size(96)->generate();
```

--------------------------------

### smooth($smooth = true)

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets whether to make rounding smoother with a resizing hack. Only has an effect when `rounded()` is also enabled. When both are active the font size is computed from the downscaled width.

```APIDOC
## `smooth($smooth = true)`

### Description
Sets whether to make rounding smoother with a resizing hack. Only has an effect when `rounded()` is also enabled. When both are active the font size is computed from the downscaled width.

### Method
`smooth($smooth = true)`

### Parameters
- **$smooth** (bool) - Optional - Default: `true` - Render the rounded avatar at 5× size, then downscale to smooth edges.

### Returns
`$this` (chainable)

### Example
```php
$avatar->rounded()->smooth()->generate();
```

```

--------------------------------

### font() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Defines the font() method that sets the font file by path or integer 1-5. Accepts a string or integer. Returns $this for chaining. Paths are resolved lazily at render time.

```php
/**
 * Set the font file by path or int (1-5).
 *
 * @param string|int $font
 *
 * @return $this
 */
public function font($font)
```

--------------------------------

### En

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Identity translator for English. Default fallback for any unknown language key.

```APIDOC
## `En`

### Description
Identity translator for English. Default fallback for any unknown language key.

### Methods

#### `translate($words)`

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `$words` | string | — | The words to translate. |

**Returns:** `$words` unchanged.

#### `getSourceLanguage()`

**Returns:** `'en'`.

### Source
`src/Translator/En.php:5`
```

--------------------------------

### width() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the avatar/image width in pixels. Casts to int. Height is unaffected. Returns $this for chaining.

```php
/**
 * Set the avatar/image width in pixels.
 *
 * @param int $width
 *
 * @return $this
 */
public function width($width)
```

--------------------------------

### generateRandomColor() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that generates a random color, stores it as bgColor, derives fontColor, and returns the hex string.

```php
protected function generateRandomColor(int $saturation = 85, int $luminance = 60)
```

--------------------------------

### preferBold()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets a flag to prefer bold fonts when generating the avatar. Returns the instance for chaining.

```APIDOC
## `preferBold()`

### Description
Prefer bold fonts (if possible).

### Method
`preferBold`

### Parameters
None

### Returns
`$this` (chainable)

### Example
```php
$avatar->preferBold()->generate();
```

```

--------------------------------

### randomBackground()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Enables or disables random background color generation with configurable saturation and luminance. Chainable.

```APIDOC
## randomBackground()

### Description
Enables or disables random background colors for each avatar. When enabled, a random color is generated immediately and on every call to `getBackgroundColor()`, resulting in different outputs for each `generate()` or `generateSvg()`. The font color is derived from the background color using `getContrastColor()`.

### Method
public randomBackground($random = true, int $saturation = 85, int $luminance = 60)

### Parameters
- **$random** (bool) - Optional (default: `true`) - Enable or disable random background colors.
- **$saturation** (int) - Optional (default: `85`) - HSL saturation (0–100).
- **$luminance** (int) - Optional (default: `60`) - HSL luminance (0–100).

### Returns
`$this` - Chainable.

### Examples
```php
$avatar->randomBackground();            // random hue, sat 85%, lum 60%
$avatar->randomBackground(true, 40, 70); // pastel palette
$avatar->randomBackground(false);       // back to fixed color
```

### Source
`src/InitialAvatar.php:220`
```

--------------------------------

### getFontFile()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the font file parameter.

```APIDOC
### Method
`getFontFile()`

### Description
Returns the configured font file path or GD built-in font index.

### Return Values
`string|int` — font path or GD font index 1–5

### Source
`src/InitialAvatar.php:522`
```

--------------------------------

### name() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the name used for generating initials. Accepts a full name or explicit initials. Returns $this for chaining.

```php
/**
 * Set the name used for generating initials.
 *
 * @param string $nameOrInitials
 *
 * @return $this
 */
public function name($nameOrInitials)
```

--------------------------------

### Set Font Size

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Set the font size as a percentage of the image size. Defaults to 0.5.

```php
$image = $avatar->fontSize(0.25)->generate(); // Font will be 25% of image size.
```

--------------------------------

### autoFont() - Detect script and use supporting font

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Enables detection of the character script and uses a bundled font that supports it. Uses LasseRafn\StringScript detection. Supported scripts include Arabic, Armenian, Bengali, Georgian, Hebrew, Mongolian, Thai, Tibetan, Turkish (Latin), Chinese, Japanese. Returns $this for chaining.

```php
$avatar->autoFont()->generate('الحزمة'); // Arabic
$avatar->autoFont()->generate('こんにちは'); // Japanese
```

--------------------------------

### font()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the font file by path or GD built-in font integer (1-5). Chainable.

```APIDOC
## font()

### Description
Sets the font file for the avatar text. Accepts a path to a `.ttf` or `.otf` file, or an integer 1–5 to use the corresponding GD built-in font. Paths are resolved lazily by `findFontFile()`: tried as-is, then relative to the package `src/` dir; if the preferred bold variants don't exist, falls back to GD built-in font `1`.

### Method
public font($font)

### Parameters
- **$font** (string|int) - Required - Path to a `.ttf`/`.otf` file, or an integer 1–5 for GD built-in font.

### Returns
`$this` - Chainable.

### Examples
```php
$avatar->font('/fonts/OpenSans-Semibold.ttf')->generate();
$avatar->font(2)->generate();            // GD built-in font #2
$avatar->font('/absolute/path/font.ttf')->generate();
```

### Source
`src/InitialAvatar.php:273`
```

--------------------------------

### name()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the name used for generating initials. Accepts a full name or explicit initials and returns the instance for chaining.

```APIDOC
## `name()`

### Description
Sets the name used for generating initials.

### Method
`name`

### Parameters
- `$nameOrInitials` (string) - Required - Full name (e.g. `'John Doe'`) or explicit initials (e.g. `'JD'`)

### Returns
`$this` (chainable)

### Example
```php
$avatar->name('Lasse Rafn');            // initials: LR
$avatar->name('MA');                    // explicit initials kept as-is
$avatar->name('Gustav Årgonson');       // dialect letters preserved: GÅ
```

```

--------------------------------

### height() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the avatar/image height in pixels. Casts to int. Width is unaffected. Returns $this for chaining.

```php
/**
 * Set the avatar/image height in pixels.
 *
 * @param int $height
 *
 * @return $this
 */
public function height($height)
```

--------------------------------

### language()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Selects the translator applied to names by `name()`. Full signature, parameters, and usage: [translator.md#language](translator.md#language).

```APIDOC
## `language()`

### Description
Selects the translator applied to names by `name()`. Full signature, parameters, and usage: [translator.md#language](translator.md#language).

### Method
`language()`

### Parameters
Refer to [translator.md#language](translator.md#language).

### Returns
Refer to [translator.md#language](translator.md#language).

```

--------------------------------

### getFontFile() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the configured font path or GD built-in font index 1–5.

```php
/**
 * Will return the font file parameter.
 *
 * @return string|int
 */
public function getFontFile()
```

--------------------------------

### getSize()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Deprecated getter for width.

```APIDOC
### Method
`getSize()`

### Description
Deprecated. Returns the current width. Use `getWidth()` instead.

### Return Values
`int`

### Source
`src/InitialAvatar.php:560`
```

--------------------------------

### getWidth()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the avatar width.

```APIDOC
### Method
`getWidth()`

### Description
Returns the avatar width in pixels (default 48).

### Return Values
`int`

### Source
`src/InitialAvatar.php:570`
```

--------------------------------

### Generate an Avatar

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Basic usage to instantiate the generator and create an image from a name.

```php
$avatar = new LasseRafn\InitialAvatarGenerator\InitialAvatar();

$image = $avatar->name('Lasse Rafn')->generate();
```

--------------------------------

### color()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the font color for the avatar text. Chainable.

```APIDOC
## color()

### Description
Sets the font color for the avatar text. Casts the parameter to string.

### Method
public color($color)

### Parameters
- **$color** (string) - Required - Font color value, e.g. `'#fff'`.

### Returns
`$this` - Chainable.

### Source
`src/InitialAvatar.php:239`
```

--------------------------------

### Return type annotation for Intervention\Image\Image

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/types.md

Shows the docblock return type annotation for the generate() method, indicating it returns an Intervention\Image\Image instance. This is an external type from the intervention/image package.

```php
// Return type annotation (docblock) in src/InitialAvatar.php:417
 * @return Image   // Intervention\Image\Image
```

--------------------------------

### getSmooth() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns whether the 5× supersampling smoothing hack is enabled.

```php
/**
 * Will return the smooth parameter.
 *
 * @return bool
 */
public function getSmooth()
```

--------------------------------

### makeSvgAvatar method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Protected method that builds an SVG document with a background shape and centered text, embedding the font file as a @font-face source.

```php
/**
 * @return SVG
 */
protected function makeSvgAvatar()
```

--------------------------------

### Enable Rounded Corners

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Enable rounded corners for the avatar. Defaults to false.

```php
$image = $avatar->rounded()->generate();
```

--------------------------------

### getFontSize()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the font size parameter as a fraction.

```APIDOC
### Method
`getFontSize()`

### Description
Returns the font size fraction (default 0.5).

### Return Values
`float`

### Source
`src/InitialAvatar.php:512`
```

--------------------------------

### getFontSize() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the font size fraction (0.5 by default).

```php
/**
 * Will return the font size parameter.
 *
 * @return float
 */
public function getFontSize()
```

--------------------------------

### getColor() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the font color parameter.

```php
/**
 * Will return the font color parameter.
 *
 * @return string
 */
public function getColor()
```

--------------------------------

### Generate SVG Avatar

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Initialize the avatar generator and output the result as an SVG XML string.

```php
$avatar = new LasseRafn\InitialAvatarGenerator\InitialAvatar();

echo $avatar->name('Lasse Rafn')->generateSvg()->toXMLString(); // returns SVG XML string
```

--------------------------------

### findFontFile() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that resolves the font file. No exception is thrown; unresolvable fonts silently degrade to GD built-in font 1.

```php
protected function findFontFile()
```

--------------------------------

### getColor()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the font color parameter.

```APIDOC
### Method
`getColor()`

### Description
Returns the font color (hex string). This may be the configured color or the contrast color after `autoColor()` / `randomBackground()`.

### Return Values
`string`

### Source
`src/InitialAvatar.php:502`
```

--------------------------------

### getWidth() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the avatar width in pixels (48 by default).

```php
/**
 * Will return the width parameter.
 *
 * @return int
 */
public function getWidth()
```

--------------------------------

### length() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the maximum number of characters in the generated initials. Defaults to 2. Returns $this for chaining.

```php
/**
 * Set the length of the generated initials.
 *
 * @param int $length
 *
 * @return $this
 */
public function length($length = 2)
```

--------------------------------

### language()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Sets the language used for name translation. Must be called before name() to take effect. Unknown languages fall back to English.

```APIDOC
## language()

### Description
Sets the language of the name for translation. Must be called before `name()` for the translation to apply. Unknown languages fall back to `'en'`.

### Method
`language($language)`

### Parameters
- `$language` (string) - Required - Language key resolved against the translator map; empty/falsy falls back to `'en'`.

### Returns
`$this` (chainable)

### Example
```php
$avatar->language('zh-CN')->name('李雷'); // translated to pinyin before initials derivation
```
```

--------------------------------

### getHeight()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the avatar height.

```APIDOC
### Method
`getHeight()`

### Description
Returns the avatar height in pixels (default 48).

### Return Values
`int`

### Source
`src/InitialAvatar.php:580`
```

--------------------------------

### getBackgroundColor() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the background color parameter. If randomBgColor is enabled, generates a new random color each time.

```php
/**
 * Will return the background color parameter.
 * If randomBgColor is enabled, generates a new random color each time.
 *
 * @return string
 */
public function getBackgroundColor()
```

--------------------------------

### Display Avatars in HTML

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Reference the avatar.php endpoint in an img tag to display generated avatars on a webpage.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Avatar Example</title>
</head>
<body>
    <h1>User Avatar</h1>
    <!-- Use the PHP endpoint as the image source -->
    <img src="avatar.php?name=John Doe" alt="Avatar for John Doe" width="100" height="100">

    <img src="avatar.php?name=Jane Smith" alt="Avatar for Jane Smith" width="100" height="100">
</body>
</html>
```

--------------------------------

### Set Font File

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Specify a custom font file path. Defaults to /fonts/OpenSans-Regular.ttf.

```php
// will be Semibold
$image = $avatar->font('/fonts/OpenSans-Semibold.ttf')->generate();
```

--------------------------------

### length()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets the maximum number of characters for the generated initials. Returns the instance for chaining.

```APIDOC
## `length()`

### Description
Sets the length of the generated initials.

### Method
`length`

### Parameters
- `$length` (int) - Optional - Default: `2` - Maximum number of characters in the generated initials

### Returns
`$this` (chainable)

### Example
```php
$avatar->name('John Doe Johnson')->length(3)->generate(); // initials: JDJ
```

```

--------------------------------

### convertHSLtoRGB() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that converts HSL values to hex or RGB array. Contains an assert that raises AssertionError in debug builds for out-of-range hue.

```php
protected function convertHSLtoRGB($h, $s, $l, $toHex = true)
```

--------------------------------

### glyph()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets a unicode glyph (e.g., FontAwesome icon) to be used as the avatar content. Decodes the hex code and passes it to name().

```APIDOC
## `glyph()`

### Description
Transforms a unicode string to the proper format.

### Method
`glyph`

### Parameters
- `$char` (string) - Required - Unicode code point in hex, without the leading `\u` (e.g. `'f007'` for the FontAwesome user icon)

### Returns
`$this` (chainable)

### Example
```php
$avatar->glyph('f007')
       ->font('/fonts/FontAwesome5Free-Regular-400.otf')
       ->background('#ff0000')
       ->color('#fff')
       ->generate();
```

```

--------------------------------

### preferBold() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Prefer bold fonts if possible. Sets $preferBold to true. Returns $this for chaining.

```php
/**
 * Prefer bold fonts (if possible).
 *
 * @return $this
 */
public function preferBold()
```

--------------------------------

### Set Initials Length

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Set the number of characters to display as initials. Defaults to 2.

```php
$image = $avatar->name('John Doe Johnson')->length(3)->generate(); // 3 letters = JDJ
```

--------------------------------

### keepCase($keepCase = true)

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Sets whether to skip uppercasing the name. Passed through to the Initials generator at generation time.

```APIDOC
## `keepCase($keepCase = true)`

### Description
Sets whether to skip uppercasing the name. Passed through to the Initials generator at generation time.

### Method
`keepCase($keepCase = true)`

### Parameters
- **$keepCase** (bool) - Optional - Default: `true` - Keep the original casing instead of uppercasing initials.

### Returns
`$this` (chainable)

### Example
```php
$avatar->keepCase()->generate('john doe'); // lowercase initials
```

```

--------------------------------

### generateSvg()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Generates a vector SVG avatar. Accepts an optional name parameter; behaves exactly like in generate(). Returns an SVG\SVG object from the meyfa/php-svg package.

```APIDOC
## generateSvg()

### Description
Generates a vector SVG avatar. Accepts an optional name parameter; behaves exactly like in generate(). Returns an SVG\SVG object from the meyfa/php-svg package.

### Method
generateSvg()

### Endpoint
LasseRafn\InitialAvatarGenerator\InitialAvatar::generateSvg()

### Parameters
- `$name` (string|null) - Optional - Optional name/initials; behaves exactly like in `generate()`.

### Returns
- `SVG\SVG` - A vector document from meyfa/php-svg (v0.9). The package's README serializes it with `toXMLString()`. The node tree (`getDocument()`, `addChild()`) is available for post-processing.

### Request Example
php
$avatar = new InitialAvatar();
echo $avatar->name('Lasse Rafn')->generateSvg()->toXMLString(); // SVG XML string


### Advanced Example
php
$svg = (new InitialAvatar())
    ->glyph('f007')                          // FontAwesome "user"
    ->font('/fonts/FontAwesome5Free-Solid-900.otf')
    ->fontName('Font Awesome 5 Free')
    ->rounded()
    ->background('#ff0000')
    ->color('#fff')
    ->generateSvg();

// Store in a file for <img src="..."> usage
file_put_contents('/tmp/avatar.svg', $svg->toXMLString());


### Response
#### Success Response
- `SVG\SVG` - A vector document object.

#### Response Example
php
$svg->toXMLString();

```

--------------------------------

### Base::translate($words)

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/translator.md

Translates the given name before initials are derived. Implementations should return the transformed string.

```APIDOC
## Base::translate($words)

### Description
Translates the supplied name before initials are derived. The returned value is passed to `InitialAvatar::name()`.

### Method
`translate`

### Parameters
- **$words** (string) - Required - The name to translate before initials generation.

### Returns
`mixed` - The translated string (implemented translators return strings).

### Example
```php
public function translate($words)
{
    return str_replace(['Mr ', 'Mrs '], ['M. ', 'Mme '], $words);
}
```
```

--------------------------------

### randomBackground() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar.md

Defines the randomBackground() method that enables or disables random background colors. Accepts optional boolean and saturation/luminance integers. Returns $this for chaining. When enabled, generates a new random color on every call to getBackgroundColor().

```php
/**
 * Set background color to be randomly generated for each avatar.
 *
 * @param bool $random
 * @param int  $saturation Saturation value (0-100)
 * @param int  $luminance  Luminance value (0-100)
 *
 * @return $this
 */
public function randomBackground($random = true, int $saturation = 85, int $luminance = 60)
```

--------------------------------

### getFontByScript() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that selects a font based on script detection using LasseRafn\StringScript tests against getInitials().

```php
protected function getFontByScript()
```

--------------------------------

### getKeepCase() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns the keepCase parameter, indicating whether casing is preserved.

```php
/**
 * Will return the keepCase parameter.
 *
 * @return bool
 */
public function getKeepCase()
```

--------------------------------

### Set Avatar Width

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Set the width of the avatar in pixels. Defaults to 48.

```php
// will be 96 pixels wide.
$image = $avatar->width(96)->generate();
```

--------------------------------

### generateSvg() method signature with PHPDoc

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Public method signature of `generateSvg()` with optional `$name`, returning an `SVG\SVG`. Documented in the source with PHPDoc annotation.

```php
/**
 * Generate the image.
 *
 * @param null|string $name
 *
 * @return SVG
 */
public function generateSvg($name = null)
```

--------------------------------

### Set Background Color

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/README.md

Set the background color of the avatar. Defaults to #f0e9e9.

```php
// will be red
$image = $avatar->background('#ff0000')->generate();
```

--------------------------------

### getKeepCase()

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Returns whether case is preserved.

```APIDOC
### Method
`getKeepCase()`

### Description
Returns the casing-preservation flag.

### Return Values
`bool`

### Source
`src/InitialAvatar.php:590`
```

--------------------------------

### translate() method signature

Source: https://github.com/lasserafn/php-initial-avatar-generator/blob/master/_autodocs/api-reference/initial-avatar-output.md

Declares the protected method that applies translation to every name passed to name().

```php
protected function translate($nameOrInitials)
```
Tokens:
Raw