https://github.com/persian-tools/php-persian-tools

An anthology of a variety of tools for the Persian language in PHP
https://github.com/persian-tools/php-persian-tools

Last synced: 13 days ago
JSON representation

An anthology of a variety of tools for the Persian language in PHP

• Host: GitHub
• URL: https://github.com/persian-tools/php-persian-tools
• Owner: persian-tools
• License: mit
• Created: 2021-03-04T11:07:57.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-19T08:12:32.000Z (over 1 year ago)
• Last Synced: 2025-04-13T06:16:28.516Z (13 days ago)
• Language: PHP
• Size: 223 KB
• Stars: 24
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


	


		

	

	
Persian Tools PHP

	
PersianTools PHP is a standalone, library-agnostic PHP Library that enables some of the Persian features for use in the PHP.


[![Latest Stable Version](https://poser.pugx.org/persian-tools/php-persian-tools/v/stable)](https://packagist.org/packages/persian-tools/php-persian-tools)

[![Total Downloads](https://poser.pugx.org/persian-tools/php-persian-tools/downloads)](https://packagist.org/packages/persian-tools/php-persian-tools)

[![Build Status](https://github.com/persian-tools/php-persian-tools/workflows/Continuous%20Integration/badge.svg)](https://github.com/persian-tools/php-persian-tools/actions)

[![Code Style](https://github.styleci.io/repos/214197383/shield?style=flat)](https://github.styleci.io/repos/214197383)

[![Code Coverage](https://codecov.io/gh/persian-tools/php-persian-tools/branch/master/graph/badge.svg?sanitize=true)](https://codecov.io/gh/persian-tools/php-persian-tools)

[![License](https://poser.pugx.org/persian-tools/php-persian-tools/license)](https://packagist.org/packages/persian-tools/php-persian-tools)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](https://github.com/persian-tools/php-persian-tools)

![status](https://img.shields.io/badge/under_development-lightblue.svg)





## Features

- [x] Adding ordinal suffixes

- [x] Converting Persian words to number

- [x] Converting Persian numbers to word

- [x] Adding and removing separator to/from numbers

- [ ] Converting Persian numbers to Arabic / English numbers and reverse

- [ ] Checking a string has/is Persian

- [x] Validating Iranians national id

- [ ] Finding city and province names by national id

- [ ] Calculating bills

- [ ] Checking IBAN of the bank account (_SHEBA_)

- [x] Validating ATM card number

- [x] Finding name of banks by ATM card number

- [ ] Getting information from vehicle plate

- [x] Fixing and decoding URLs with whitespace

## Getting started

You can install the package via composer:

```bash

composer require persian-tools/php-persian-tools

```

## Usage

``` php

// soon ...

```

## Testing

``` bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Thank you for your interest in [contributing](CONTRIBUTING.md)! Please feel free to put up a PR for any issue or feature request.

### Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Ali Torki](https://github.com/ali-master)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.