Documentation

Textavatar
in package

Table of Contents

Properties

$colors  : mixed
$font  : mixed
$fontColor  : mixed
$storage  : mixed

Methods

__construct()  : mixed
exists()  : mixed
Determines if the initials file exists
generate()  : mixed
Generates the text based avatar
getAvatar()  : mixed
Generates the avatar
getColors()  : mixed
Initializes the colors available on the system
getFileName()  : mixed
Generate the unique file name for a particular initials
getFilePath()  : mixed
Retrieves the file path for a specific initials
getInitials()  : mixed
Given a particular name, retrieve the initials
getRandomColor()  : mixed
Retrieves a random color
getRGB()  : mixed
Converts color code into RGB

Properties

Methods

__construct()

public __construct([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []

exists()

Determines if the initials file exists

public exists(mixed $initials) : mixed
Parameters
$initials : mixed
Tags
since
4.0.0
access

public

generate()

Generates the text based avatar

public generate(mixed $initials) : mixed
Parameters
$initials : mixed
Tags
since
4.0.0
access

public

getAvatar()

Generates the avatar

public getAvatar(mixed $name[, mixed $characters = 2 ]) : mixed
Parameters
$name : mixed
$characters : mixed = 2
Tags
since
4.0.0
access

public

getColors()

Initializes the colors available on the system

public getColors(mixed $colors) : mixed
Parameters
$colors : mixed
Tags
since
4.0.0
access

public

getFileName()

Generate the unique file name for a particular initials

public getFileName(mixed $initials) : mixed
Parameters
$initials : mixed
Tags
since
4.0.0
access

public

getFilePath()

Retrieves the file path for a specific initials

public getFilePath(mixed $initials[, mixed $uri = false ]) : mixed
Parameters
$initials : mixed
$uri : mixed = false
Tags
since
4.0.0
access

public

getInitials()

Given a particular name, retrieve the initials

public getInitials(mixed $name[, mixed $characters = 2 ]) : mixed
Parameters
$name : mixed
$characters : mixed = 2
Tags
since
4.0.0
access

public

getRandomColor()

Retrieves a random color

public getRandomColor(mixed $initials) : mixed
Parameters
$initials : mixed
Tags
since
4.0.0
access

public

getRGB()

Converts color code into RGB

public getRGB(mixed $code) : mixed
Parameters
$code : mixed
Tags
since
4.0.0
access

public


        
On this page

Search results