https://github.com/marwan-ahmed-23/tafqit-php

A PHP-based service for converting numbers into text, supporting Arabic and English.
https://github.com/marwan-ahmed-23/tafqit-php

Last synced: 10 days ago
JSON representation

A PHP-based service for converting numbers into text, supporting Arabic and English.

• Host: GitHub
• URL: https://github.com/marwan-ahmed-23/tafqit-php
• Owner: marwan-ahmed-23
• Created: 2024-12-01T00:34:25.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-20T03:49:36.000Z (27 days ago)
• Last Synced: 2024-12-20T04:33:48.146Z (27 days ago)
• Language: PHP
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tafqit (PHP): Number to Text Conversion for Multiple Languages

Tafqit-PHP is a PHP-based service designed to convert numerical values into readable text. Supporting both Arabic and English, this lightweight and modular solution can be easily extended to accommodate additional languages.

---

## 🚀 Features

- Converts numbers into text in Arabic and English.

- Handles large numbers with precision.

- Supports customization for currency and subunit formatting.

- Lightweight and easy to integrate into any PHP project.

## Requirements

- PHP 7.0 or higher.

- Multibyte string extension (enabled by default in PHP).

## 🔧 Installation

1. Clone or download the repository.

2. Include the `src/Tafqit.php` file in your project:

  

    ```bash

    require_once 'path-to-src/Tafqit.php';

    ```

## 📖 Usage

Here's an example of how to use `Tafqit-PHP` to convert numbers to text:

```bash

numberToText("٢٣٤٥", 'ar'); // Outputs: ألفان وثلاثمائة وخمسة وأربعون

```

### Usage with English Numbers

```bash

numberToText("2345", 'en'); // Outputs: Two thousand three hundred forty-five

```

## Currency Example

You can customize it to include currency and subunit formatting for specific languages.

## 📂 Folder Structure

```plaintext

tafqit-php/

├── src/

│   └── Tafqit.php

├── examples/

│   └── example.php

├── tests/

│   └── TafqitTest.php

├── LICENSE

├── .gitignore

└── README.md

```

## Tests

Run the tests using PHPUnit:

```bash

phpunit tests/TafqitTest.php

```

## 🛠️ Contributing

We welcome contributions! Follow these steps to contribute:

1. Fork the repository.

2. Create a new branch:

  

    ```bash

    git checkout -b feature-branch

    ```

    

3. Make your changes and commit them:

  

    ```bash

    git commit -m "Add new feature"

    ```

4. Push to your branch:

    ```bash

    git push origin feature-branch

    ```

5. Open a Pull Request.

## 🌟 Show Your Support

If you found this project helpful, please consider giving it a ⭐ on GitHub. Your support means the world to us!