Download the PHP package hosmelq/name-of-person without Composer
On this page you can find all versions of the php package hosmelq/name-of-person. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package name-of-person
Name of Person
Inspired by Basecamp's name_of_person Ruby gem, but built for modern PHP applications.
Introduction
Handle person names in your PHP applications with elegant formatting options. Transform names between multiple presentation formats. This package provides a clean, type-safe way to parse, store, manipulate, and display person names consistently across your application.
Key Features:
- 🎯 Multiple Format Options: nine different ways to display names (full, familiar, abbreviated, initials, sorted, possessive, mentionable)
- 🎨 Smart Parsing: Intelligently handles full name strings and edge cases
- 🌍 Unicode Support: Full international name support with proper multibyte handling
- 🔧 Pure PHP: Core functionality works in any PHP project
- ⚡ Laravel Integration: Native Eloquent casting for seamless database integration
Requirements
This package requires PHP 8.2 or higher. Laravel integration requires Laravel 11 or higher.
Installation
You can install the package via composer:
Basic Usage
Creating PersonName Objects
The core PersonName
class works in any PHP application:
Available Methods
Basic Properties
first
(readonly property)
Returns the first name as a string.
last
(readonly property)
Returns the last name as a string, or null
if no last name was provided.
Display Methods
abbreviated()
Returns the first initial plus full last name: "F. Last"
familiar()
Returns the first name plus last initial with a period: "First L."
full()
Returns the complete name in "First Last" format.
initials()
Returns all initials from the name, excluding parentheses and brackets.
mentionable()
Returns lowercase, space-free version of the familiar name for mentions.
possessive()
Returns the possessive form of the name with appropriate apostrophe placement.
You can also specify which format to make possessive:
sorted()
Returns the name in "Last, First" format suitable for sorting.
Utility Methods
equals()
Compares two PersonName objects for equality.
String and JSON Conversion
PersonName implements both Stringable
and JsonSerializable
interfaces:
Performance Note: All computed properties (familiar, abbreviated, sorted, etc.) are cached for performance. The first call computes the value, later calls return the cached result.
Error Handling
The package throws InvalidArgumentException
in these cases:
Unicode Support
The package fully supports international names:
Laravel Integration
When using Laravel, you can leverage the included cast for seamless Eloquent integration:
Configuration
The package works out of the box with Laravel's casting system. By default, it expects first_name
and last_name
columns in your database, but you can customize this:
Alternatively, you can use the fluent helper method:
Usage Examples
Basic Usage
JSON Serialization
Testing
Credits
- Hosmel Quintana
- Inspired by Basecamp's name_of_person Ruby gem
- All Contributors
License
The MIT License (MIT). Please see License File for more information.