A simple Laravel 8+ client for the Genderize.io API. It provides a fluent interface for easy request building.
Laravel | php | use repository | use branch/tag |
---|---|---|---|
12.x, 11.x | 8.4, 8.3, 8.2 | https://github.com/pixelpeter/laravel-genderize-api-client | master, v12.x |
10.x | 8.3, 8.2, 8.1 | https://github.com/pixelpeter/laravel-genderize-api-client | master, v10.x |
9.x, 8.x | 8.2, 8.1, 8.0 | https://github.com/pixelpeter/laravel-genderize-api-client | v8.x |
5.7, 5.6 | 7.3, 7.2, 7.1 | https://github.com/pixelpeter/laravel5-genderize-api-client | 2.0.x |
5.5 | 7.2, 7.1, 7.0 | https://github.com/pixelpeter/laravel5-genderize-api-client | 1.1.x/2.0.x |
composer require pixelpeter/laravel-genderize-api-client
Add the alias in app/config/app.php
'aliases' => [ ... 'Genderize' => Pixelpeter\Genderize\Facades\Genderize::class, ... ];
This is only needed when you have an API key from Genderize.io
php artisan vendor:publish --provider="Pixelpeter\Genderize\GenderizeServiceProvider"
useGenderize; Genderize::name('Peter')->get();
useGenderize; Genderize::name(['John', 'Jane'])->get(); // or for better readability you can use the plural Genderize::names(['John', 'Jane'])->get();
useGenderize; Genderize::name('John')->country('US')->lang('EN')->get();
useGenderize; $response = Genderize::name('Peter')->get(); print$response->result->gender; // 'male'print$response->result->name; // 'Peter'print$response->result->probability; '0.99'print$response->result->count; 144print$response->result->isMale(); trueprint$response->result->isFemale(); falseprint$response->result->isNotMale(); falseprint$response->result->isNotFemale(); true
useGenderize; $response = Genderize::names(['John', 'Jane'])->country('US')->lang('EN')->get(); foreach($response->resultas$row) { print$row->name; }
useGenderize; $response = Genderize::name('Peter')->get(); print$response->meta->code; // 200 - HTTP response codeprint$response->meta->limit; // 1000 - Max number of allowed requestsprint$response->meta->remaining; // 950 - Number of requests leftprint$response->meta->reset->diffInSeconds(); // Carbon\Carbon - time left till reset
Refer to Genderize.io API Documentation for more examples and documentation.
Run the tests with:
vendor/bin/phpunit
The MIT License (MIT). Please see License File for more information.