README

A PHP library providing functions specific to Latvian language and data formats, including Latvian text comparison, sorting according to Latvian alphabet rules, and validation of Latvian personal identification codes.

Installation

Install the package via Composer:

composer require vairogs/functions-latvian

Requirements

PHP 8.4 or higher

Usage

There are two ways to use this package: via the Functions class or by directly using the traits.

Using the Functions Class

The Functions class provides utilities for working with Latvian-specific data and text.

use Vairogs\Functions\Latvian\Functions;

// Create a new Functions instance
$functions = new Functions();

// Validate a Latvian personal identification code
$isValid = $functions->validatePersonCode('32XXXXXXXXX'); // For new format
$isValid = $functions->validatePersonCode('XXXXXXXXXXX'); // For old format

// Sort an array of names according to Latvian alphabet rules
$names = [
    ['name' => 'Ēriks'],
    ['name' => 'Andris'],
    ['name' => 'Čalis'],
    ['name' => 'Zane'],
];
$functions->sortLatvian($names, 'name');
// Result: Andris, Čalis, Ēriks, Zane

// Compare two strings using Latvian alphabet rules
$result = $functions->compare(['name' => 'Ēriks'], ['name' => 'Andris'], 'name');
// Result: positive integer (Ēriks comes after Andris in Latvian alphabet)

Using Traits Directly

Alternatively, you can use the traits directly in your own classes:

use Vairogs\Functions\Latvian\Traits\_Compare;
use Vairogs\Functions\Latvian\Traits\_SortLatvian;
use Vairogs\Functions\Latvian\Traits\_ValidatePersonCode;

class MyClass
{
    // Import the traits you need
    use _Compare;
    use _SortLatvian;
    use _ValidatePersonCode;

    public function doSomething(): void
    {
        // Validate a Latvian personal identification code
        $isValid = $this->validatePersonCode('32XXXXXXXXX');

        // Sort an array of names according to Latvian alphabet rules
        $names = [
            ['name' => 'Ēriks'],
            ['name' => 'Andris'],
            ['name' => 'Čalis'],
            ['name' => 'Zane'],
        ];
        $this->sortLatvian($names, 'name');

        // Compare two strings using Latvian alphabet rules
        $result = $this->compare(['name' => 'Ēriks'], ['name' => 'Andris'], 'name');
    }
}

Note that some traits may depend on other helper traits. For example, the _ValidatePersonCode trait uses _ValidatePersonCodeNew and _ValidatePersonCodeOld internally. The Functions class handles these dependencies for you, but if you use the traits directly, you may need to include these helper traits as well.

Features

For a complete list of all functions available in this package, see Features.

License

This package is licensed under the BSD-3-Clause License.

About Vairogs

This package is part of the vairogs/vairogs project - a comprehensive PHP library and Symfony bundle that provides a collection of utilities, components, and integrations for Symfony applications.

The main project includes:

Various utility functions and components
Doctrine ORM tools and extensions
API Platform integrations
Symfony bundle for easy configuration
And much more

If you find this Latvian functions component useful, you might want to check out the full Vairogs project for additional tools and utilities that can enhance your Symfony application development.

To install the complete package:

composer require vairogs/vairogs

vairogs / functions-latvian

Maintainers

Details