From 857c5e3a0224c5c8e237d77af96075117aa2619a Mon Sep 17 00:00:00 2001 From: Anatol Belski Date: Sun, 26 Aug 2012 23:48:51 +0000 Subject: [PATCH] added gender ext documentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327302 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/gender/book.xml | 42 ++ reference/gender/configure.xml | 35 + reference/gender/examples.xml | 99 +++ reference/gender/gender.xml | 884 ++++++++++++++++++++++++++ reference/gender/gender/connect.xml | 63 ++ reference/gender/gender/construct.xml | 63 ++ reference/gender/gender/country.xml | 62 ++ reference/gender/gender/get.xml | 73 +++ reference/gender/setup.xml | 61 ++ reference/gender/versions.xml | 34 + 10 files changed, 1416 insertions(+) create mode 100644 reference/gender/book.xml create mode 100644 reference/gender/configure.xml create mode 100644 reference/gender/examples.xml create mode 100644 reference/gender/gender.xml create mode 100644 reference/gender/gender/connect.xml create mode 100644 reference/gender/gender/construct.xml create mode 100644 reference/gender/gender/country.xml create mode 100644 reference/gender/gender/get.xml create mode 100644 reference/gender/setup.xml create mode 100644 reference/gender/versions.xml diff --git a/reference/gender/book.xml b/reference/gender/book.xml new file mode 100644 index 0000000000..d539bbb3d3 --- /dev/null +++ b/reference/gender/book.xml @@ -0,0 +1,42 @@ + + + + + Gender + Gender + + + &reftitle.intro; + + Gender PHP extension is a port of the gender.c program originally written + by Joerg Michael. The main purpose is to find out the gender of firstnames. + The actual database contains >40000 firstnames from 54 countries. + + + + &reference.gender.setup; + &reference.gender.examples; + &reference.gender.gender; + + + + diff --git a/reference/gender/configure.xml b/reference/gender/configure.xml new file mode 100644 index 0000000000..9bedf54fa2 --- /dev/null +++ b/reference/gender/configure.xml @@ -0,0 +1,35 @@ + + + +
+ &reftitle.install; + + + &pecl.info; + &url.pecl.package;gender + + + +
+ + + diff --git a/reference/gender/examples.xml b/reference/gender/examples.xml new file mode 100644 index 0000000000..26816428e7 --- /dev/null +++ b/reference/gender/examples.xml @@ -0,0 +1,99 @@ + + + + &reftitle.examples; +
+ Usage example. + + Gender class usage example. + + + Usage example. + +get($name, $country); + +$data = $gender->country($country); + +switch($result) { + case Gender::IS_FEMALE: + printf("The name %s is female in %s\n", $name, $data['country']); + break; + + + case Gender::IS_MOSTLY_FEMALE: + printf("The name %s is mostly female in %s\n", $name, $data['country']); + break; + + + case Gender::IS_MALE: + printf("The name %s is male in %s\n", $name, $data['country']); + break; + + + case Gender::IS_MOSTLY_MALE: + printf("The name %s is mostly male in %s\n", $name, $data['country']); + break; + + + case Gender::IS_UNISEX_NAME: + printf("The name %s is unisex in %s\n", $name, $data['country']); + break; + + + case Gender::IS_A_COUPLE: + printf("The name %s is both male and female in %s\n", $name, $data['country']); + break; + + + case Gender::NAME_NOT_FOUND: + printf("The name %s was not found for %s\n", $name, $data['country']); + break; + + + case Gender::ERROR_IN_NAME: + echo "There is an error in the given name!\n"; + break; + + default: + echo "An error occured!\n"; + break; + +} +]]> + + +
+ + + + diff --git a/reference/gender/gender.xml b/reference/gender/gender.xml new file mode 100644 index 0000000000..b6bbf672b0 --- /dev/null +++ b/reference/gender/gender.xml @@ -0,0 +1,884 @@ + + + + + + The Gender\Gender class + Gender\Gender + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + Gender\Gender + + + + + Gender\Gender + + + + Constants + + const + integer + Gender\Gender::IS_FEMALE + 70 + + + const + integer + Gender\Gender::IS_MOSTLY_FEMALE + 102 + + + const + integer + Gender\Gender::IS_MALE + 77 + + + const + integer + Gender\Gender::IS_MOSTLY_MALE + 109 + + + const + integer + Gender\Gender::IS_UNISEX_NAME + 63 + + + const + integer + Gender\Gender::IS_A_COUPLE + 67 + + + const + integer + Gender\Gender::NAME_NOT_FOUND + 32 + + + const + integer + Gender\Gender::ERROR_IN_NAME + 69 + + + const + integer + Gender\Gender::ANY_COUNTRY + 0 + + + const + integer + Gender\Gender::BRITAIN + 1 + + + const + integer + Gender\Gender::IRELAND + 2 + + + const + integer + Gender\Gender::USA + 3 + + + const + integer + Gender\Gender::SPAIN + 4 + + + const + integer + Gender\Gender::PORTUGAL + 5 + + + const + integer + Gender\Gender::ITALY + 6 + + + const + integer + Gender\Gender::MALTA + 7 + + + const + integer + Gender\Gender::FRANCE + 8 + + + const + integer + Gender\Gender::BELGIUM + 9 + + + const + integer + Gender\Gender::LUXEMBOURG + 10 + + + const + integer + Gender\Gender::NETHERLANDS + 11 + + + const + integer + Gender\Gender::GERMANY + 12 + + + const + integer + Gender\Gender::EAST_FRISIA + 13 + + + const + integer + Gender\Gender::AUSTRIA + 14 + + + const + integer + Gender\Gender::SWISS + 15 + + + const + integer + Gender\Gender::ICELAND + 16 + + + const + integer + Gender\Gender::DENMARK + 17 + + + const + integer + Gender\Gender::NORWAY + 18 + + + const + integer + Gender\Gender::SWEDEN + 19 + + + const + integer + Gender\Gender::FINLAND + 20 + + + const + integer + Gender\Gender::ESTONIA + 21 + + + const + integer + Gender\Gender::LATVIA + 22 + + + const + integer + Gender\Gender::LITHUANIA + 23 + + + const + integer + Gender\Gender::POLAND + 24 + + + const + integer + Gender\Gender::CZECH_REP + 25 + + + const + integer + Gender\Gender::SLOVAKIA + 26 + + + const + integer + Gender\Gender::HUNGARY + 27 + + + const + integer + Gender\Gender::ROMANIA + 28 + + + const + integer + Gender\Gender::BULGARIA + 29 + + + const + integer + Gender\Gender::BOSNIA + 30 + + + const + integer + Gender\Gender::CROATIA + 31 + + + const + integer + Gender\Gender::KOSOVO + 32 + + + const + integer + Gender\Gender::MACEDONIA + 33 + + + const + integer + Gender\Gender::MONTENEGRO + 34 + + + const + integer + Gender\Gender::SERBIA + 35 + + + const + integer + Gender\Gender::SLOVENIA + 36 + + + const + integer + Gender\Gender::ALBANIA + 37 + + + const + integer + Gender\Gender::GREECE + 38 + + + const + integer + Gender\Gender::RUSSIA + 39 + + + const + integer + Gender\Gender::BELARUS + 40 + + + const + integer + Gender\Gender::MOLDOVA + 41 + + + const + integer + Gender\Gender::UKRAINE + 42 + + + const + integer + Gender\Gender::ARMENIA + 43 + + + const + integer + Gender\Gender::AZERBAIJAN + 44 + + + const + integer + Gender\Gender::GEORGIA + 45 + + + const + integer + Gender\Gender::KAZAKH_UZBEK + 46 + + + const + integer + Gender\Gender::TURKEY + 47 + + + const + integer + Gender\Gender::ARABIA + 48 + + + const + integer + Gender\Gender::ISRAEL + 49 + + + const + integer + Gender\Gender::CHINA + 50 + + + const + integer + Gender\Gender::INDIA + 51 + + + const + integer + Gender\Gender::JAPAN + 52 + + + const + integer + Gender\Gender::KOREA + 53 + + + &Methods; + + + + +
+ + +
+ &reftitle.constants; + + + + 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 + + + + + + +
+ + + + + + &reference.gender.entities.gender; + + + + diff --git a/reference/gender/gender/connect.xml b/reference/gender/gender/connect.xml new file mode 100644 index 0000000000..6bf79daa4e --- /dev/null +++ b/reference/gender/gender/connect.xml @@ -0,0 +1,63 @@ + + + + + + Gender\Gender::connect + Connect to an external name dictionary. + + + + &reftitle.description; + + public booleanGender\Gender::connect + stringdsn + + + Connect to an external name dictionary. Currently only streams are + supported. + + + + + &reftitle.parameters; + + + dsn + + + DSN to open. + + + + + + + + &reftitle.returnvalues; + + Boolean as success of failure. + + + + + diff --git a/reference/gender/gender/construct.xml b/reference/gender/gender/construct.xml new file mode 100644 index 0000000000..2afe90d0ab --- /dev/null +++ b/reference/gender/gender/construct.xml @@ -0,0 +1,63 @@ + + + + + + Gender\Gender::__construct + Construct the Gender object. + + + + &reftitle.description; + + public Gender\Gender::__construct + stringdsn + + + + + + + + &reftitle.parameters; + + + dsn + + + DSN to open. + + + + + + + + &reftitle.returnvalues; + + + + + + + + diff --git a/reference/gender/gender/country.xml b/reference/gender/gender/country.xml new file mode 100644 index 0000000000..bc0fc7d1c3 --- /dev/null +++ b/reference/gender/gender/country.xml @@ -0,0 +1,62 @@ + + + + + + Gender\Gender::country + Get textual country representation. + + + + &reftitle.description; + + public stringGender\Gender::country + integercountry + + + Get textual country representation from a Gender class constant. + + + + + &reftitle.parameters; + + + country + + + Country id identified by Gender class constant. + + + + + + + + &reftitle.returnvalues; + + Returns country name as string or false on failure. + + + + + diff --git a/reference/gender/gender/get.xml b/reference/gender/gender/get.xml new file mode 100644 index 0000000000..ac203ac1d7 --- /dev/null +++ b/reference/gender/gender/get.xml @@ -0,0 +1,73 @@ + + + + + + Gender\Gender::get + Get gender of a name. + + + + &reftitle.description; + + public integerGender\Gender::get + stringname + integercountry + + + Get the gender of the name in a particular country. + + + + + &reftitle.parameters; + + + name + + + Name to check. + + + + + country + + + Country id identified by Gender class constant. + + + + + + + + &reftitle.returnvalues; + + Returns gender of the name. + + + + + + + diff --git a/reference/gender/setup.xml b/reference/gender/setup.xml new file mode 100644 index 0000000000..70dddbdd55 --- /dev/null +++ b/reference/gender/setup.xml @@ -0,0 +1,61 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + This package has no external dependencies. + +
+ +
+ &reftitle.install; + + &pecl.moved; + + + &pecl.info; + &url.pecl.package;gender. + + + &pecl.windows.download; + +
+ +
+ &reftitle.runtime; + &no.config; +
+ + + + + + diff --git a/reference/gender/versions.xml b/reference/gender/versions.xml new file mode 100644 index 0000000000..490eb04cae --- /dev/null +++ b/reference/gender/versions.xml @@ -0,0 +1,34 @@ + + + + + + + + + + + + +