GeoIP2-php/doc/v0.8.1/source-class-GeoIp2.Record.AbstractRecord.html
2014-09-12 07:16:05 -07:00

168 lines
10 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="ApiGen 2.8.0">
<meta name="robots" content="noindex">
<title>File GeoIp2/Record/AbstractRecord.php | GeoIP2 PHP API v0.8.1</title>
<link rel="stylesheet" href="resources/style.css?3901564645">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-GeoIp2.html">GeoIp2<span></span></a>
<ul>
<li><a href="namespace-GeoIp2.Database.html">Database</a>
</li>
<li><a href="namespace-GeoIp2.Exception.html">Exception</a>
</li>
<li><a href="namespace-GeoIp2.Model.html">Model</a>
</li>
<li class="active"><a href="namespace-GeoIp2.Record.html">Record</a>
</li>
<li><a href="namespace-GeoIp2.WebService.html">WebService</a>
</li>
</ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-GeoIp2.Record.AbstractPlaceRecord.html">AbstractPlaceRecord</a></li>
<li class="active"><a href="class-GeoIp2.Record.AbstractRecord.html">AbstractRecord</a></li>
<li><a href="class-GeoIp2.Record.City.html">City</a></li>
<li><a href="class-GeoIp2.Record.Continent.html">Continent</a></li>
<li><a href="class-GeoIp2.Record.Country.html">Country</a></li>
<li><a href="class-GeoIp2.Record.Location.html">Location</a></li>
<li><a href="class-GeoIp2.Record.MaxMind.html">MaxMind</a></li>
<li><a href="class-GeoIp2.Record.Postal.html">Postal</a></li>
<li><a href="class-GeoIp2.Record.RepresentedCountry.html">RepresentedCountry</a></li>
<li><a href="class-GeoIp2.Record.Subdivision.html">Subdivision</a></li>
<li><a href="class-GeoIp2.Record.Traits.html">Traits</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text">
<input type="submit" value="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-GeoIp2.Record.html" title="Summary of GeoIp2\Record"><span>Namespace</span></a>
</li>
<li>
<a href="class-GeoIp2.Record.AbstractRecord.html" title="Summary of GeoIp2\Record\AbstractRecord"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
<li>
<a href="geoip2-php-api-v0-8-1-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
</li>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> GeoIp2\Record;
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="AbstractRecord" href="#AbstractRecord">AbstractRecord</a> <span class="php-keyword1">implements</span> \JsonSerializable
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a>{
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$record" href="#$record">$record</a></span>;
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a>
</span><span id="9" class="l"><a class="l" href="#9"> 9: </a> <span class="php-comment">/**
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * @ignore
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> */</span>
</span><span id="12" class="l"><a class="l" href="#12">12: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___construct" href="#___construct">__construct</a>(<span class="php-var">$record</span>)
</span><span id="13" class="l"><a class="l" href="#13">13: </a> {
</span><span id="14" class="l"><a class="l" href="#14">14: </a> <span class="php-var">$this</span>-&gt;record = <span class="php-keyword1">isset</span>(<span class="php-var">$record</span>) ? <span class="php-var">$record</span> : <span class="php-keyword1">array</span>();
</span><span id="15" class="l"><a class="l" href="#15">15: </a> }
</span><span id="16" class="l"><a class="l" href="#16">16: </a>
</span><span id="17" class="l"><a class="l" href="#17">17: </a> <span class="php-comment">/**
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * @ignore
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> */</span>
</span><span id="20" class="l"><a class="l" href="#20">20: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___get" href="#___get">__get</a>(<span class="php-var">$attr</span>)
</span><span id="21" class="l"><a class="l" href="#21">21: </a> {
</span><span id="22" class="l"><a class="l" href="#22">22: </a> <span class="php-comment">// XXX - kind of ugly but greatly reduces boilerplate code</span>
</span><span id="23" class="l"><a class="l" href="#23">23: </a> <span class="php-var">$key</span> = <span class="php-var">$this</span>-&gt;attributeToKey(<span class="php-var">$attr</span>);
</span><span id="24" class="l"><a class="l" href="#24">24: </a>
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;__isset(<span class="php-var">$attr</span>)) {
</span><span id="26" class="l"><a class="l" href="#26">26: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;record[<span class="php-var">$key</span>];
</span><span id="27" class="l"><a class="l" href="#27">27: </a> } <span class="php-keyword1">elseif</span> (<span class="php-var">$this</span>-&gt;validAttribute(<span class="php-var">$attr</span>)) {
</span><span id="28" class="l"><a class="l" href="#28">28: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
</span><span id="29" class="l"><a class="l" href="#29">29: </a> } <span class="php-keyword1">else</span> {
</span><span id="30" class="l"><a class="l" href="#30">30: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> \RuntimeException(<span class="php-quote">&quot;Unknown attribute: </span><span class="php-var">$attr</span><span class="php-quote">&quot;</span>);
</span><span id="31" class="l"><a class="l" href="#31">31: </a> }
</span><span id="32" class="l"><a class="l" href="#32">32: </a> }
</span><span id="33" class="l"><a class="l" href="#33">33: </a>
</span><span id="34" class="l"><a class="l" href="#34">34: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___isset" href="#___isset">__isset</a>(<span class="php-var">$attr</span>)
</span><span id="35" class="l"><a class="l" href="#35">35: </a> {
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;validAttribute(<span class="php-var">$attr</span>) &amp;&amp;
</span><span id="37" class="l"><a class="l" href="#37">37: </a> <span class="php-keyword1">isset</span>(<span class="php-var">$this</span>-&gt;record[<span class="php-var">$this</span>-&gt;attributeToKey(<span class="php-var">$attr</span>)]);
</span><span id="38" class="l"><a class="l" href="#38">38: </a> }
</span><span id="39" class="l"><a class="l" href="#39">39: </a>
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_attributeToKey" href="#_attributeToKey">attributeToKey</a>(<span class="php-var">$attr</span>)
</span><span id="41" class="l"><a class="l" href="#41">41: </a> {
</span><span id="42" class="l"><a class="l" href="#42">42: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">strtolower</span>(<span class="php-keyword2">preg_replace</span>(<span class="php-quote">'/([A-Z])/'</span>, <span class="php-quote">'_\1'</span>, <span class="php-var">$attr</span>));
</span><span id="43" class="l"><a class="l" href="#43">43: </a> }
</span><span id="44" class="l"><a class="l" href="#44">44: </a>
</span><span id="45" class="l"><a class="l" href="#45">45: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_validAttribute" href="#_validAttribute">validAttribute</a>(<span class="php-var">$attr</span>)
</span><span id="46" class="l"><a class="l" href="#46">46: </a> {
</span><span id="47" class="l"><a class="l" href="#47">47: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">in_array</span>(<span class="php-var">$attr</span>, <span class="php-var">$this</span>-&gt;validAttributes);
</span><span id="48" class="l"><a class="l" href="#48">48: </a> }
</span><span id="49" class="l"><a class="l" href="#49">49: </a>
</span><span id="50" class="l"><a class="l" href="#50">50: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_jsonSerialize" href="#_jsonSerialize">jsonSerialize</a>()
</span><span id="51" class="l"><a class="l" href="#51">51: </a> {
</span><span id="52" class="l"><a class="l" href="#52">52: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;record;
</span><span id="53" class="l"><a class="l" href="#53">53: </a> }
</span><span id="54" class="l"><a class="l" href="#54">54: </a>}
</span><span id="55" class="l"><a class="l" href="#55">55: </a></span></code></pre>
<div id="footer">
GeoIP2 PHP API v0.8.1 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
<script src="resources/combined.js?3305629347"></script>
<script src="elementlist.js?2777285962"></script>
</body>
</html>