Skip to content

Migrate ext/geoip to doc-extensions #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jordikroon wants to merge 63 commits into
base: main
Choose a base branch
from
+2,564 −0
Open

Migrate ext/geoip to doc-extensions #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
386bcd6
Initial revision for PECL GeoIP documentation
olivierhill Aug 22, 2006
76fc3fc
Fix return type
vrana Aug 24, 2006
e9af163
move maxmind.* urls to entities. add mising refpurposes tags
nunoplopes Sep 8, 2006
4299efc
Upgrade to DocBook5: - All id attributes are now xml:id - Add docbook…
bjori Jun 20, 2007
1dcc5dc
Documenting new functions found in newer releases
olivierhill Aug 23, 2007
2277726
fix build
philip Aug 23, 2007
85a0a8a
correct the title and description of example.
Aug 25, 2007
68062dd
WS - Removal of TABs.
Nov 1, 2007
4e1b828
New function in 1.0.2
olivierhill Nov 21, 2007
fba5296
MFB: Rename "functions.xml" to entities.<dirname>.xml
bjori Dec 10, 2007
6f00557
MFB: Upgrade to the new-reference-structure - (Created missing setup …
bjori Dec 22, 2007
bbe1b9f
Use the &Functions; entity (patch by Felipe)
bjori Dec 25, 2007
3bc77a7
Unified <title> and <titleabbrev> in every extensions book.xml/refere…
philip May 30, 2008
0b463f4
Contains version information (when functions became available in PHP)…
philip Oct 30, 2008
93f6fde
Fixed example.
db- Dec 1, 2008
a957560
Adding missing version info for new function
olivierhill Dec 3, 2008
f85d039
Fixed simple spelling errors
philip Dec 16, 2008
1f6d4b0
Adding missing documentation for geoip_continent_code_by_name()
olivierhill Dec 19, 2008
3c4e33e
Documenting new fields available with recent releases
olivierhill Dec 19, 2008
cde01fc
Documentation for new GeoIP functions
olivierhill Dec 23, 2008
e5107c2
Initializers - part 6
vrana Jan 19, 2009
0c1a5b3
fixed properties
nilgun Jul 11, 2009
ef853c2
Normalized the sgml-default-dtd-file local-variable line for those st…
Sep 25, 2009
339e73e
W/S tabs
Feb 3, 2010
a7035b8
Converted to utf-8
Mar 28, 2010
5ce8a37
Converted to UTF-8
Mar 29, 2010
a094f64
Reverted r297058
Mar 29, 2010
d6694f2
Converted remaining files to utf-8
Mar 29, 2010
eb97d43
To make it less confusing I changed to: Internet connection type.
Aug 3, 2010
b61aab1
Fixed bug #53122 (output doesn't match code)
KalleZ Oct 22, 2010
cf00212
Extension purpose is not needed anymore
vrana Jul 15, 2011
537be5d
Standardise on single style of quotes for XML tag.
Aug 16, 2011
7fdd6f0
Linkable reference constants
vrana Feb 28, 2012
b5b7690
many bugs
krakjoe Nov 15, 2012
f2e4b51
Fix the link to Maxmind's ISO 3166 page.
LawnGnome Mar 20, 2013
bb0110e
Fix bug #64721: geoip_continent_code_by_name() code list
cweiske Apr 26, 2013
bc89f0d
fix docbook, table wants <caption> not <title>
cweiske Apr 26, 2013
c010b54
fix markup
salathe Apr 27, 2013
15fce68
Delete redundant <!-- Membership: -->
vrana May 23, 2013
0c8e42d
Add documentation for GeoIP ini entry
olivierhill Apr 29, 2014
07f294a
Adding documentation for new GeoIP functions
olivierhill Apr 30, 2014
e36569b
Adding version information for new functions
olivierhill May 1, 2014
06aba1b
Making the XML definition consistent across the entire project.
Sep 5, 2014
fbc9062
svn:keywords, svn:eol-style, svn:ignore all set appropriately.
Sep 23, 2014
e958fc0
Warn about missing GeoIP2 database support.
cweiske Feb 22, 2017
0f4d0ff
Fix svn:eol-style, svn:keywords and svn:mime-type on XML files. No co…
Sep 2, 2017
3d4a8eb
Remove trailing fullstop in <refpurpose>
vrana Jan 25, 2018
04810d6
Fix example
cmb69 May 8, 2018
12bd853
Add PECL in front of version numbers in changelogs
cmb69 Oct 25, 2020
bec487f
Use canonical type names
cmb69 Nov 2, 2020
6101408
Document false and null return types
vrana Nov 28, 2020
e9e02c1
Document false and null return types
vrana Nov 28, 2020
198aa48
Revert revision 351727 from phpdoc/en/trunk: Document false and null …
cmb69 Nov 28, 2020
216976e
Revert revision(s) 351724 from phpdoc/en/trunk: Document false and nu…
cmb69 Nov 28, 2020
8bbdf99
xi:include INI settings documented elsewhere in ini.list
cmb69 Feb 24, 2021
6b80563
Fix lone section order issues in various extensions
Girgias Jun 6, 2021
aa530cb
Fix extension doc membership
Girgias May 20, 2021
0e255f2
Remove references to "double" and use float instead (#1848)
Girgias Sep 27, 2022
733e92d
Replace PHP_INI_* with INI_* constants
Girgias Jan 26, 2024
3656c4c
Remove empty resources pages (#3545)
haszi Jul 26, 2024
0272a25
geoip: fix XML to get remove of useless wrapping para tags (#5119)
Girgias Jan 16, 2026
31e7a05
geoip: fix XML by converting para to simpara tags via script (#5131)
Girgias Jan 18, 2026
558507a
Mark version.xml files as do-not-translate (#5662)
alfsb Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions reference/geoip/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="utf-8"?>
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.geoip">
<?phpdoc extension-membership="pecl" ?>
<title>Geo IP Location</title>
<titleabbrev>GeoIP</titleabbrev>

<preface xml:id="intro.geoip">
&reftitle.intro;
<simpara>
The GeoIP extension allows you to find the location of an IP address. City,
State, Country, Longitude, Latitude, and other information as all, such as
ISP and connection type can be obtained with the help of GeoIP.
</simpara>
<warning>
<simpara>
This extension does not support MaxMind's current "GeoIP2" databases,
only the "GeoIP legacy" database files.
</simpara>
</warning>
</preface>

&reference.geoip.setup;

Check failure on line 22 in reference/geoip/book.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (extensions) 

book.xml: XML parse error: Entity 'pecl.moved' not defined
&reference.geoip.constants;
&reference.geoip.reference;

</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
190 changes: 190 additions & 0 deletions reference/geoip/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="geoip.constants">
&reftitle.constants;
&extension.constants;

Check failure on line 5 in reference/geoip/constants.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (extensions) 

constants.xml: XML parse error: Entity 'extension.constants' not defined
<variablelist>
<varlistentry xml:id="constant.geoip-country-edition">
<term>
<constant>GEOIP_COUNTRY_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-region-edition-rev0">
<term>
<constant>GEOIP_REGION_EDITION_REV0</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-city-edition-rev0">
<term>
<constant>GEOIP_CITY_EDITION_REV0</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-org-edition">
<term>
<constant>GEOIP_ORG_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-isp-edition">
<term>
<constant>GEOIP_ISP_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-city-edition-rev1">
<term>
<constant>GEOIP_CITY_EDITION_REV1</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-region-edition-rev1">
<term>
<constant>GEOIP_REGION_EDITION_REV1</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-proxy-edition">
<term>
<constant>GEOIP_PROXY_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-asnum-edition">
<term>
<constant>GEOIP_ASNUM_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-netspeed-edition">
<term>
<constant>GEOIP_NETSPEED_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-domain-edition">
<term>
<constant>GEOIP_DOMAIN_EDITION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>

</simpara>
</listitem>
</varlistentry>
</variablelist>
<simpara>
The following constants are for net speed:
</simpara>
<variablelist>
<varlistentry xml:id="constant.geoip-unknown-speed">
<term>
<constant>GEOIP_UNKNOWN_SPEED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-dialup-speed">
<term>
<constant>GEOIP_DIALUP_SPEED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-cabledsl-speed">
<term>
<constant>GEOIP_CABLEDSL_SPEED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.geoip-corporate-speed">
<term>
<constant>GEOIP_CORPORATE_SPEED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara/>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
89 changes: 89 additions & 0 deletions reference/geoip/functions/geoip-asnum-by-name.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.geoip-asnum-by-name">
<refnamediv>
<refname>geoip_asnum_by_name</refname>
<refpurpose>Get the Autonomous System Numbers (ASN)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>geoip_asnum_by_name</methodname>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
</methodsynopsis>

<simpara>
The <function>geoip_asnum_by_name</function> function will return the Autonomous
System Numbers (ASN) associated with an IP address.
</simpara>

</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<simpara>
The hostname or IP address.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns the ASN on success, or &false; if the address
cannot be found in the database.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title>A <function>geoip_asnum_by_name</function> example</title>
<simpara>
This will output the ASN of the host www.example.com.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
$asn = geoip_asnum_by_name('www.example.com');

if ($asn) {
echo 'The ASN is: ' . $asn;
}
?>
]]>
</programlisting>
&example.outputs;

Check failure on line 60 in reference/geoip/functions/geoip-asnum-by-name.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (extensions) 

geoip-asnum-by-name.xml: XML parse error: Entity 'example.outputs' not defined
<screen>
<![CDATA[
The ASN is: AS15133 EdgeCast Networks, Inc
]]>
</screen>
</example>
</refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Loading
Loading