Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deligoez/tckimlikno
Turkish Identification Number Verification & Validation Package for Laravel
https://github.com/deligoez/tckimlikno
composer laravel laravel-package mernis php tckimlikno
Last synced: 3 months ago
JSON representation
Turkish Identification Number Verification & Validation Package for Laravel
- Host: GitHub
- URL: https://github.com/deligoez/tckimlikno
- Owner: deligoez
- License: mit
- Created: 2019-06-26T07:43:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T11:28:34.000Z (9 months ago)
- Last Synced: 2024-04-29T12:37:53.277Z (9 months ago)
- Topics: composer, laravel, laravel-package, mernis, php, tckimlikno
- Language: PHP
- Homepage:
- Size: 74.2 KB
- Stars: 23
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
# TCKimlikNo
[![MIT Licensed][ico-license]](license.md)
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[![Build Status][ico-travis]][link-travis]
[![Quality Score][ico-scrutinizer]][link-scrutinizer]
[![StyleCI][ico-styleci]][link-styleci]
Turkish Identification Number Verification & Validation Package for Laravel.
## Installation
Via Composer
``` bash
$ composer require deligoez/tckimlikno
```
If you are using Laravel 5.5+, the package will automatically register the service provider for you.
## Usage
``` php
use Deligoez\TCKimlikNo\TCKimlikNo;
// Verifies Citizenship Number According to it's Algorithm.
// Returns Boolean
TCKimlikNo::verify('12345678901'); // Returns false
TCKimlikNo::verify('10000000146'); // Returns true
// Verifies Parameters and validates all using nvi.gov.tr API
// Returns Boolean
TCKimlikNo::validate('10000000146', 'Yunus Emre', 'Deligöz', '1900')
// Auto Uppercase Disabled
TCKimlikNo::validate('10000000146', 'YUNUS EMRE', 'DELİGÖZ', '1900', false)
```
## Available Laravel Validation Rules
### TCKimlikNoVerify
```php
// In a Form Request Class
public function rules()
{
return [
'tckimlikno' => ['required', new TCKimlikNoVerify()],
];
}
```
```php
// In a Controller
use Deligoez\TCKimlikNo\Rules\TCKimlikNoVerify;
/**
* Store a tckn.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validatedData = $request->validate([
'tckn' => ['bail', 'required', new TCKimlikNoVerify()],
]);
// tckn is valid...
}
```
### TCKimlikNoValidate
```php
// In a Form Request Class
public function rules()
{
return [
'tckimlikno' => ['required', new TCKimlikNoValidate(
$name,
$surname,
$birthYear,
$autoUppercase // Optional, defaults to true
)],
];
}
```
## Faker Provider
```php
use Deligoez\TCKimlikNo\Provider\TCKimlikNoFakerProvider;
$faker = Faker\Factory::create();
$faker->addProvider(new TCKimlikNoFakerProvider($faker));
// a Random Valid TCKN
$tckn = $faker->tckn; // 60174067810
```
## Changelog
Please see the [changelog](changelog.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [contributing.md](contributing.md) for details and a todo list.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Yunus Emre Deligöz][link-author]
- [Turan Karatuğ](https://github.com/tkaratug)
- [Faruk Can](https://github.com/frkcn)
- [Hakan Özdemir](https://github.com/hozdemir)
- [Mecit](https://github.com/Mecit)
- [All Contributors][link-contributors]
## License
MIT. Please see the [license file](license.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/deligoez/tckimlikno.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/deligoez/tckimlikno.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/deligoez/tckimlikno/master.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/193854934/shield
[ico-scrutinizer]: https://img.shields.io/scrutinizer/g/deligoez/tckimlikno.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/deligoez/tckimlikno
[link-downloads]: https://packagist.org/packages/deligoez/tckimlikno
[link-travis]: https://travis-ci.org/deligoez/tckimlikno
[link-styleci]: https://styleci.io/repos/193854934
[link-scrutinizer]: https://scrutinizer-ci.com/g/deligoez/tckimlikno
[link-author]: https://github.com/deligoez
[link-contributors]: ../../contributors