hariadi/siapa

A simple PHP library for parsing complex Malay names into their individual components

v1.2.0 2025-05-15 13:05 UTC

Requires

• php: ^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.75
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^9.6

MIT

• Hariadi Hinta

• helpers
• parser
• utf-8
• utils
• name
• UTF
• methods
• malay
• gender

README

Malay Name Parser A smart parser for extracting components from complex Malay names:

• ✅ Salutation
• ✅ First Name
• ✅ Last Name (excluding patronyms like "bin"/"binti")
• ✅ Gender detection

💡 Example Usage

use Hariadi\Siapa\Siapa;

$siapa = Siapa::name("Dato' Dr. Ir. Hj. Hariadi Bin Hinta");

echo $siapa->salutation(); // Dato' Dr. Ir. Hj.
echo $siapa->first();      // Hariadi
echo $siapa->last();       // Hinta
echo $siapa->gender();     // M

📦 Install

Install via Composer:

composer require hariadi/siapa

Then include the autoloader:

require 'vendor/autoload.php';

Alternatively, require the class manually:

require_once 'path/to/Siapa/src/Siapa.php';

🧱 Object-Oriented Usage

use Hariadi\Siapa\Siapa;

$siapa = Siapa::name('Hariadi Hinta', 'UTF-8');
echo $siapa->first(); // Hariadi

🧪 Methods

If $encoding is not provided, it defaults to mb_internal_encoding().

salutation()

Returns the full salutation, if detected.

Siapa::name('Datuk Dr. Ir. Hariadi Hinta')->salutation(); // Datuk Dr. Ir.

givenName(bool $withMiddle = false)

Returns full name without salutation. Optionally excludes middle markers (e.g., bin, binti).

Siapa::name("Dato' Hariadi Bin Hinta")->givenName();       // Hariadi Hinta
Siapa::name("Dato' Hariadi Bin Hinta")->givenName(true);  // Hariadi Bin Hinta

first()

Returns the detected first name:

Siapa::name('Hariadi Hinta')->first(); // Hariadi

last()

Returns the last name (without bin/binti):

Siapa::name('Hariadi Bin Hinta')->last(); // Hinta

gender(bool $short = true)

Detects gender. Returns 'M'/'F' or 'Male'/'Female'.

Siapa::name('Pn. Nurul Hidayah')->gender();      // F
Siapa::name('Pn. Nurul Hidayah')->gender(false); // Female

Gender Detection Heuristics

1. Defaults to Male

2. If last name contains any of:

   • Binti, Bte, A/P, Pn., Puan, Cik etc.

3. If salutation contains female honorifics

4. If first name matches any name in female.txt

✅ Tests

Run tests using PHPUnit:

git clone https://github.com/hariadi/Siapa.git
cd Siapa
vendor/bin/phpunit

📄 License

Released under the MIT License.