aboutsummaryrefslogtreecommitdiff
blob: a441634610fd50478f161bbbb07e57357ccebd33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page geo.php</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/php/lib/geo.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Functions for netgeo lookups.</p>
		
			</div>
</div>
		

	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functiongeo_get_coordinates" id="functiongeo_get_coordinates"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">geo_get_coordinates</span> (line <span class="line-number">45</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get longitude and latitude of an IP.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array containing results or false on failure</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array|false</span>
		<span class="method-name">
			geo_get_coordinates
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span><span class="var-description">: an IP address</span>			</li>
				</ul>
		
	
</div>
<a name="functiongeo_get_country" id="functiongeo_get_country"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">geo_get_country</span> (line <span class="line-number">65</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get country of an IP.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array containing results or false on failure</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|false</span>
		<span class="method-name">
			geo_get_country
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span><span class="var-description">: an IP address</span>			</li>
				</ul>
		
	
</div>
<a name="functiongeo_get_distance" id="functiongeo_get_distance"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">geo_get_distance</span> (line <span class="line-number">16</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calculate the distance between two geo points.</p>
	<ul class="tags">
				<li><span class="field">return:</span> rounded distance in _km_ between these points</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			geo_get_distance
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$lat1</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$lon1</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$lat2</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$lon2</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$lat1</span><span class="var-description">: latitude of first point</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$lon1</span><span class="var-description">: longitude of first point</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$lat2</span><span class="var-description">: latitude of second point</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$lon2</span><span class="var-description">: longitude of second point</span>			</li>
				</ul>
		
	
</div>
<a name="functiongeo_get_record" id="functiongeo_get_record"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">geo_get_record</span> (line <span class="line-number">55</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get complete record based on IP.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array containing results or false on failure</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array|false</span>
		<span class="method-name">
			geo_get_record
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span><span class="var-description">: an IP address</span>			</li>
				</ul>
		
	
</div>
<a name="functiongeo_query" id="functiongeo_query"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">geo_query</span> (line <span class="line-number">27</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Query NetGeo based on API and parse results.</p>
	<ul class="tags">
				<li><span class="field">return:</span> array containing results or false on failure</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array|false</span>
		<span class="method-name">
			geo_query
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$ip</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">'getRecord'</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$ip</span><span class="var-description">: an IP address</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$method</span><span class="var-description">: lookup method, based on NetGeo API.</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Mon,  8 Nov 2004 13:43:04 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>