Book/gender-Phpdoc专题
Determine gender of firstnames
目录
- 简介
- 安装／配置
- 范例
- Gender\Gender — The Gender\Gender class
- Gender\Gender::connect — Connect to an external name dictionary
- Gender\Gender::__construct — Construct the Gender object
- Gender\Gender::country — Get textual country representation
- Gender\Gender::get — Get gender of a name
- Gender\Gender::isNick — Check if the name0 is an alias of the name1
- Gender\Gender::similarNames — Get similar names
简介
类摘要
Gender\Gender
class Gender\Gender {
/* Constants */
const int
Gender\Gender::IS_FEMALE = 70 ;
const int
Gender\Gender::IS_MOSTLY_FEMALE =
102 ;
const int
Gender\Gender::IS_MALE = 77 ;
const int
Gender\Gender::IS_MOSTLY_MALE = 109
;
const int
Gender\Gender::IS_UNISEX_NAME = 63 ;
const int
Gender\Gender::IS_A_COUPLE = 67 ;
const int
Gender\Gender::NAME_NOT_FOUND = 32 ;
const int
Gender\Gender::ERROR_IN_NAME = 69 ;
const int
Gender\Gender::ANY_COUNTRY = 0 ;
const int
Gender\Gender::BRITAIN = 1 ;
const int
Gender\Gender::IRELAND = 2 ;
const int
Gender\Gender::USA = 3 ;
const int
Gender\Gender::SPAIN = 4 ;
const int
Gender\Gender::PORTUGAL = 5 ;
const int
Gender\Gender::ITALY = 6 ;
const int
Gender\Gender::MALTA = 7 ;
const int
Gender\Gender::FRANCE = 8 ;
const int
Gender\Gender::BELGIUM = 9 ;
const int
Gender\Gender::LUXEMBOURG = 10 ;
const int
Gender\Gender::NETHERLANDS = 11 ;
const int
Gender\Gender::GERMANY = 12 ;
const int
Gender\Gender::EAST_FRISIA = 13 ;
const int
Gender\Gender::AUSTRIA = 14 ;
const int
Gender\Gender::SWISS = 15 ;
const int
Gender\Gender::ICELAND = 16 ;
const int
Gender\Gender::DENMARK = 17 ;
const int
Gender\Gender::NORWAY = 18 ;
const int
Gender\Gender::SWEDEN = 19 ;
const int
Gender\Gender::FINLAND = 20 ;
const int
Gender\Gender::ESTONIA = 21 ;
const int
Gender\Gender::LATVIA = 22 ;
const int
Gender\Gender::LITHUANIA = 23 ;
const int
Gender\Gender::POLAND = 24 ;
const int
Gender\Gender::CZECH_REP = 25 ;
const int
Gender\Gender::SLOVAKIA = 26 ;
const int
Gender\Gender::HUNGARY = 27 ;
const int
Gender\Gender::ROMANIA = 28 ;
const int
Gender\Gender::BULGARIA = 29 ;
const int
Gender\Gender::BOSNIA = 30 ;
const int
Gender\Gender::CROATIA = 31 ;
const int
Gender\Gender::KOSOVO = 32 ;
const int
Gender\Gender::MACEDONIA = 33 ;
const int
Gender\Gender::MONTENEGRO = 34 ;
const int
Gender\Gender::SERBIA = 35 ;
const int
Gender\Gender::SLOVENIA = 36 ;
const int
Gender\Gender::ALBANIA = 37 ;
const int
Gender\Gender::GREECE = 38 ;
const int
Gender\Gender::RUSSIA = 39 ;
const int
Gender\Gender::BELARUS = 40 ;
const int
Gender\Gender::MOLDOVA = 41 ;
const int
Gender\Gender::UKRAINE = 42 ;
const int
Gender\Gender::ARMENIA = 43 ;
const int
Gender\Gender::AZERBAIJAN = 44 ;
const int
Gender\Gender::GEORGIA = 45 ;
const int
Gender\Gender::KAZAKH_UZBEK = 46 ;
const int
Gender\Gender::TURKEY = 47 ;
const int
Gender\Gender::ARABIA = 48 ;
const int
Gender\Gender::ISRAEL = 49 ;
const int
Gender\Gender::CHINA = 50 ;
const int
Gender\Gender::INDIA = 51 ;
const int
Gender\Gender::JAPAN = 52 ;
const int
Gender\Gender::KOREA = 53 ;
/* 方法 */
public bool
connect ( <span
class="methodparam">string $dsn )
public <span
class="methodname">__construct ([ <span
class="methodparam">string $dsn ] )
public <span
class="type">arrayfalse <span
class="methodname">country ( <span
class="type">int $country )
public int <span
class="methodname">get ( <span
class="type">string $name [, <span
class="methodparam">int $country ] )
public array
isNick ( <span
class="type">string $name0 , <span
class="methodparam">string $name1 [,
int
$country ] )
public array
similarNames ( <span
class="methodparam">string $name [,
int
$country ] )
}
预定义常量
Gender\Gender::IS_FEMALE
Gender\Gender::IS_MOSTLY_FEMALE
Gender\Gender::IS_MALE
Gender\Gender::IS_MOSTLY_MALE
Gender\Gender::IS_UNISEX_NAME
Gender\Gender::IS_A_COUPLE
Gender\Gender::NAME_NOT_FOUND
Gender\Gender::ERROR_IN_NAME
Gender\Gender::ANY_COUNTRY
Gender\Gender::BRITAIN
Gender\Gender::IRELAND
Gender\Gender::USA
Gender\Gender::SPAIN
Gender\Gender::PORTUGAL
Gender\Gender::ITALY
Gender\Gender::MALTA
Gender\Gender::FRANCE
Gender\Gender::BELGIUM
Gender\Gender::LUXEMBOURG
Gender\Gender::NETHERLANDS
Gender\Gender::GERMANY
Gender\Gender::EAST_FRISIA
Gender\Gender::AUSTRIA
Gender\Gender::SWISS
Gender\Gender::ICELAND
Gender\Gender::DENMARK
Gender\Gender::NORWAY
Gender\Gender::SWEDEN
Gender\Gender::FINLAND
Gender\Gender::ESTONIA
Gender\Gender::LATVIA
Gender\Gender::LITHUANIA
Gender\Gender::POLAND
Gender\Gender::CZECH_REP
Gender\Gender::SLOVAKIA
Gender\Gender::HUNGARY
Gender\Gender::ROMANIA
Gender\Gender::BULGARIA
Gender\Gender::BOSNIA
Gender\Gender::CROATIA
Gender\Gender::KOSOVO
Gender\Gender::MACEDONIA
Gender\Gender::MONTENEGRO
Gender\Gender::SERBIA
Gender\Gender::SLOVENIA
Gender\Gender::ALBANIA
Gender\Gender::GREECE
Gender\Gender::RUSSIA
Gender\Gender::BELARUS
Gender\Gender::MOLDOVA
Gender\Gender::UKRAINE
Gender\Gender::ARMENIA
Gender\Gender::AZERBAIJAN
Gender\Gender::GEORGIA
Gender\Gender::KAZAKH_UZBEK
Gender\Gender::TURKEY
Gender\Gender::ARABIA
Gender\Gender::ISRAEL
Gender\Gender::CHINA
Gender\Gender::INDIA
Gender\Gender::JAPAN
Gender\Gender::KOREA
Gender\Gender::connect
Connect to an external name dictionary
说明
public bool
Gender\Gender::connect ( <span
class="methodparam">string $dsn )
Connect to an external name dictionary. Currently only streams are supported.
参数
dsn
DSN to open.
返回值
Boolean as success of failure.
Gender\Gender::__construct
Construct the Gender object
说明
public <span
class="methodname">Gender\Gender::__construct ([ <span
class="methodparam">string $dsn ] )
Create a Gender object optionally connecting to an external name dictionary. When no external database was given, compiled in data will be used.
参数
dsn
DSN to open.
返回值
Gender\Gender::country
Get textual country representation
说明
public <span
class="type">arrayfalse <span
class="methodname">Gender\Gender::country ( <span
class="methodparam">int $country )
Returns the textual representation of a country from a Gender class constant.
参数
country
A country ID specified by a <span
class="classname">Gender\Gender class constant.
返回值
Returns an array with the short and full names of the country on success
或者在失败时返回 false.
范例
示例 #1 Using <span class="methodname">Gender\Gender::country
$gender = new Gender\Gender;
var_dump($gender->country(Gender\Gender::BRITAIN));以上例程会输出：
array(2) {
'country_short' =>
string(2) "UK"
'country' =>
string(13) "Great Britain"
}Gender\Gender::get
Get gender of a name
说明
public int <span
class="methodname">Gender\Gender::get ( <span
class="methodparam">string $name [,
int
$country ] )
Get the gender of the name in a particular country.
参数
name
Name to check.
country
Country id identified by Gender class constant.
返回值
Returns gender of the name.
Gender\Gender::isNick
Check if the name0 is an alias of the name1
说明
public array
Gender\Gender::isNick ( <span
class="methodparam">string $name0 ,
string
$name1 [, <span
class="type">int $country ] )
Check whether the name0 is a nick of the name1.
参数
name0
Name to check.
name1
Name to check.
country
Country id identified by Gender class constant. If ommited ANY_COUNTRY
is used.
返回值
成功时返回 true， 或者在失败时返回 false。
Gender\Gender::similarNames
Get similar names
说明
public array
Gender\Gender::similarNames ( <span
class="methodparam">string $name [,
int
$country ] )
Get similar names for the given name and country.
参数
name
Name to check.
country
Country id identified by Gender class constant. If ommited ANY_COUNTRY
is used.
返回值
Returns an array with the similar names found.