Yii2 Extension to Gender API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
components
helpers
LICENSE
README.md
composer.json

README.md

Yii2 Gender API

This extension provides the Gender API for the Yii framework 2.0.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist richweber/yii2-gender-api

or add

"richweber/yii2-gender-api": "^1.0.0"

to the require section of your composer.json

Configure

'components' => [
    ...
    'gender' => [
        'class' => 'richweber\gender\components\Gender',
        'serverKey' => '<your private server key>',
    ],
    ...
],

Basic Usage

/** @var \richweber\gender\components\Gender $component */
$component = Yii::$app->gender;

$result = $component->checkName('Roman');
if (!isset($result->errno) && $result->accuracy > 60) {
    $gender = (string) $result->gender;
    var_dump($gender);
}

As multiple names

$result = $component->checkName(['Roman', 'Богдан']);
if (!isset($result->errno)) {
    var_dump($result->result);
}

Localization by country

$result = $component->byLocalization('UA')->checkName('Roman');
if (!isset($result->errno) && $result->accuracy > 60) {
    $gender = (string) $result->gender;
    var_dump($gender);
}

Localization by IP

$result = $component->byIP('54.201.16.177')->checkName('Roman');
if (!isset($result->errno) && $result->accuracy > 60) {
    $gender = (string) $result->gender;
    var_dump($gender);
}

Localization by language

$result = $component->byLanguage('de-DE')->checkName('Roman');
if (!isset($result->errno) && $result->accuracy > 60) {
    $gender = (string) $result->gender;
    var_dump($gender);
}

Get gender by an email address

$result = $component->checkNameByEmail('markus.p@gmail.com');
if (!isset($result->errno) && $result->accuracy > 60) {
    $gender = (string) $result->gender;
    var_dump($gender);
}