D3Public/GeoIP
8
0
Fork 0
Code Pull Requests Releases Activity
177b6ebce6
GeoIP/sources/DevReferences/html/classd3_geo_i_p.html
DanielSeifert 77c40f050a add documentations
2013-04-22 09:21:42 +00:00

395 lines
17 KiB
HTML
Raw Blame History

<!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GeoIP: d3GeoIP Klassenreferenz</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Erzeugt von Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Suchen');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Hauptseite</span></a></li>
<li class="current"><a href="annotated.html"><span>Datenstrukturen</span></a></li>
<li><a href="files.html"><span>Dateien</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Suchen" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Datenstrukturen</span></a></li>
<li><a href="classes.html"><span>Datenstruktur-Verzeichnis</span></a></li>
<li><a href="functions.html"><span>Datenstruktur-Elemente</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Öffentliche Methoden</a> &#124;
<a href="#pro-methods">Geschützte Methoden</a> &#124;
<a href="#pro-attribs">Geschützte Attribute</a> </div>
<div class="headertitle">
<h1>d3GeoIP Klassenreferenz</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="d3GeoIP" --><table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Öffentliche Methoden</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a095c5d389db211932136b53f25f39685">__construct</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a3aa6333b831ad872025474a56d35515b">getUserLocationCountryObject</a> ($sIP=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a0b98151420fed0f00390a58ccc609240">getIP</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a8550bf3b70b0beb02e6a7ccbf55debc7">LoadByIPNum</a> ($iIPNum)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#ab9b1be141036130b41cdeba204da530b">getCountryObject</a> ($sISOAlpha)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a80898fe71b6332ce97b5b29d353c7396">getCountryFallBackObject</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a4d1669acbc1161ff20b5c263c3ad1580">setCountryLanguage</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a1617a803e13d0bb78be376d9684be428">setCountryCurrency</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a71cf8ac749c550fee26fd41156885a66">performShopSwitch</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a67f268e4e41a016fde1f868443201313">performURLSwitch</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a41a70964c577acdfcf864c434f321e15">getShopUrls</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Geschützte Methoden</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#ac121b372f03a4479fea3e927de3d2000">_getNumIp</a> ($sIP)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#af258c93cb3b731079d236125c7e9e94c">_getModConfig</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a622405233b8ddffd3b142834dc7d4eef">_getLog</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Geschützte Attribute</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classd3_geo_i_p.html#a8231a97f481f05d16c75135a924d5ab9">$_sClassName</a> = 'd3geoip'</td></tr>
</table>
<hr/><h2>Beschreibung der Konstruktoren und Destruktoren</h2>
<a class="anchor" id="a095c5d389db211932136b53f25f39685"></a><!-- doxytag: member="d3GeoIP::__construct" ref="a095c5d389db211932136b53f25f39685" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__construct </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class constructor, initiates parent constructor (parent::oxI18n()).</p>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>null </dd></dl>
</div>
</div>
<hr/><h2>Dokumentation der Elementfunktionen</h2>
<a class="anchor" id="a622405233b8ddffd3b142834dc7d4eef"></a><!-- doxytag: member="d3GeoIP::_getLog" ref="a622405233b8ddffd3b142834dc7d4eef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_getLog </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get d3log instance</p>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>object </dd></dl>
</div>
</div>
<a class="anchor" id="af258c93cb3b731079d236125c7e9e94c"></a><!-- doxytag: member="d3GeoIP::_getModConfig" ref="af258c93cb3b731079d236125c7e9e94c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_getModConfig </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get modcfg instance</p>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>object </dd></dl>
</div>
</div>
<a class="anchor" id="ac121b372f03a4479fea3e927de3d2000"></a><!-- doxytag: member="d3GeoIP::_getNumIp" ref="ac121b372f03a4479fea3e927de3d2000" args="($sIP)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">_getNumIp </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"> <em>sIP</em>&#160;)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get IP number by IP address</p>
<dl><dt><b>Parameter:</b></dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$sIP</td><td>IP address </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>int IP number </dd></dl>
</div>
</div>
<a class="anchor" id="a80898fe71b6332ce97b5b29d353c7396"></a><!-- doxytag: member="d3GeoIP::getCountryFallBackObject" ref="a80898fe71b6332ce97b5b29d353c7396" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getCountryFallBackObject </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get oxcountry object for fallback, if set</p>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>object </dd></dl>
</div>
</div>
<a class="anchor" id="ab9b1be141036130b41cdeba204da530b"></a><!-- doxytag: member="d3GeoIP::getCountryObject" ref="ab9b1be141036130b41cdeba204da530b" args="($sISOAlpha)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getCountryObject </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"> <em>sISOAlpha</em>&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get oxcountry object by ISO alpha 2 ID</p>
<dl><dt><b>Parameter:</b></dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$sISOAlpha</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>object </dd></dl>
</div>
</div>
<a class="anchor" id="a0b98151420fed0f00390a58ccc609240"></a><!-- doxytag: member="d3GeoIP::getIP" ref="a0b98151420fed0f00390a58ccc609240" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getIP </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get IP address from client or set test IP address</p>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>string </dd></dl>
</div>
</div>
<a class="anchor" id="a41a70964c577acdfcf864c434f321e15"></a><!-- doxytag: member="d3GeoIP::getShopUrls" ref="a41a70964c577acdfcf864c434f321e15" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getShopUrls </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get all shop urls</p>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>array </dd></dl>
</div>
</div>
<a class="anchor" id="a3aa6333b831ad872025474a56d35515b"></a><!-- doxytag: member="d3GeoIP::getUserLocationCountryObject" ref="a3aa6333b831ad872025474a56d35515b" args="($sIP=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">getUserLocationCountryObject </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"> <em>sIP</em> = <code>false</code>&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get oxcountry object by given IP address (optional)</p>
<dl><dt><b>Parameter:</b></dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$sIP</td><td>optional </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>object </dd></dl>
</div>
</div>
<a class="anchor" id="a8550bf3b70b0beb02e6a7ccbf55debc7"></a><!-- doxytag: member="d3GeoIP::LoadByIPNum" ref="a8550bf3b70b0beb02e6a7ccbf55debc7" args="($iIPNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LoadByIPNum </td>
<td>(</td>
<td class="paramtype">$&#160;</td>
<td class="paramname"> <em>iIPNum</em>&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get ISO alpha 2 ID by IP number</p>
<dl><dt><b>Parameter:</b></dt><dd>
<table class="params">
<tr><td class="paramtype">int</td><td class="paramname">$iIPNum</td><td>IP number </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Rückgabe:</b></dt><dd>string </dd></dl>
</div>
</div>
<a class="anchor" id="a71cf8ac749c550fee26fd41156885a66"></a><!-- doxytag: member="d3GeoIP::performShopSwitch" ref="a71cf8ac749c550fee26fd41156885a66" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">performShopSwitch </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check module active state and perform switching to user country specific shop (EE only) </p>
</div>
</div>
<a class="anchor" id="a67f268e4e41a016fde1f868443201313"></a><!-- doxytag: member="d3GeoIP::performURLSwitch" ref="a67f268e4e41a016fde1f868443201313" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">performURLSwitch </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check module active state and perform switching to user country specific url </p>
</div>
</div>
<a class="anchor" id="a1617a803e13d0bb78be376d9684be428"></a><!-- doxytag: member="d3GeoIP::setCountryCurrency" ref="a1617a803e13d0bb78be376d9684be428" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">setCountryCurrency </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check module active state and set user country specific currency </p>
</div>
</div>
<a class="anchor" id="a4d1669acbc1161ff20b5c263c3ad1580"></a><!-- doxytag: member="d3GeoIP::setCountryLanguage" ref="a4d1669acbc1161ff20b5c263c3ad1580" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">setCountryLanguage </td>
<td>(</td>
<td class="paramname">&#160;)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>check module active state and set user country specific language </p>
</div>
</div>
<hr/><h2>Dokumentation der Datenelemente</h2>
<a class="anchor" id="a8231a97f481f05d16c75135a924d5ab9"></a><!-- doxytag: member="d3GeoIP::$_sClassName" ref="a8231a97f481f05d16c75135a924d5ab9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">$_sClassName = 'd3geoip'<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:<ul>
<li>copy_this/core/<a class="el" href="d3geoip_8php.html">d3geoip.php</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>Alle</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Datenstrukturen</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Dateien</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Funktionen</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variablen</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Erzeugt am Mon Jul 23 2012 17:44:31 für GeoIP von&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
View Git Blame Copy Permalink