lasserafn / php-initials
A package to generate initials in PHP
Installs: 3 400 734
Dependents: 4
Suggesters: 0
Security: 0
Stars: 41
Watchers: 2
Forks: 5
Open Issues: 2
Requires
- php: ^5.6|^7.0|^7.1|^8.0
Requires (Dev)
- phpunit/phpunit: ^5.7
- satooshi/php-coveralls: ^1.0
README
This is the core of LasseRafn/php-initial-avatar-generator, or well.. the initials generation part of it.
It's framework agnostic, which is different from basically everything else I do, you're welcome.
Supports UTF8 (yes, also emojis.)
Installation
You just require using composer and you're good to go!
composer require lasserafn/php-initials
Usage
As with installation, usage is quite simple. Generating a image is done by running:
use LasseRafn\Initials\Initials; echo (new Initials('Lasse Rafn')); // Output: LR echo (new Initials)->name('Justine Bieber')->generate(); // Output: JB echo (new Initials('John Christian Doe'))->generate(); // Output: JD echo (new Initials)->generate('Leonardo'); // Output: LE echo (new Initials)->length(1)->generate('Camilla'); // Output: C echo (new Initials)->name('Jens Ølsted')->getUrlfriendlyInitials(); // Output: JO
All you'll have to do is either pass in the name in the constructor like so:
echo new Initials('The Name Here'); // TH
or use the name($name)
method, to specify the name.
Supported methods
name($name = 'John Doe')
$initials->name('Albert Magnum')->generate();
length($length = 2)
$initials->name('Albert Magnum')->length(3)->generate();
generate()
This method will output the initials. It's completely optional, you could also just echo out the class as it has a __toString()
method.
$initials->name('Albert Magnum')->generate();
getUrlfriendlyInitials()
Will output url-friendly initials (stripping characters like ÆØÅ)
Requirements
- PHP 5.6, 7.0 or 7.1