README

🇵🇱 Słownie to biblioteka PHP umożliwiająca zamianę liczb na zapis słowny w języku polskim.

🇬🇧 Słownie is a PHP library that converts numbers into words in Polish.

📦 Installation

Using Composer

Install this package via Composer:

{
    "require": {
        "vlaim/slownie": "^1"
    }
}

Run:

composer require vlaim/slownie

🚀 Basic Usage

The main method to convert numbers to words:

Slownie::convert($number, bool $hideGrosze = false, bool $hideZlote = false)

Parameters:

• $number (int | float | string) – The number to convert.
• $hideGrosze (bool, default: false) – If true, omits grosze (00/100).
• $hideZlote (bool, default: false) – If true, omits "złoty/złotych/złote".

Examples:

Convert a number to words:

Slownie::convert(10348);
// Output: "dziesięć tysięcy trzysta czterdzieści osiem złotych 00/100"

Hide grosze:

Slownie::convert(10348, true);
// Output: "dziesięć tysięcy trzysta czterdzieści osiem złotych"

Hide "złoty/złotych/złote":

Slownie::convert(10348, true, true);
// Output: "dziesięć tysięcy trzysta czterdzieści osiem"

🧪 Running Tests

To run tests, use:

composer test

🛠 Issues & Support

For bug reports and feature requests, visit the GitHub Issue Tracker.

Feel free to open an issue if you have any questions.

📜 License

vlaim/slownie is released under the MIT License.