PHPXRef 0.7.1 : Unnamed Project : Detail view of Location.php

[Source view] [Print] [Project Stats]

+----------------------------------------------------------------------+ | PHP version 5 | +----------------------------------------------------------------------+ | Copyright (C) 2004 MaxMind LLC | +----------------------------------------------------------------------+ | This library is free software; you can redistribute it and/or | | modify it under the terms of the GNU Lesser General Public | | License as published by the Free Software Foundation; either | | version 2.1 of the License, or (at your option) any later version. | | | | This library is distributed in the hope that it will be useful, | | but WITHOUT ANY WARRANTY; without even the implied warranty of | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | | Lesser General Public License for more details. | | | | You should have received a copy of the GNU Lesser General Public | | License along with this library; if not, write to the Free Software | | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 | | USA, or view it online at http://www.gnu.org/licenses/lgpl.txt. | +----------------------------------------------------------------------+ | Authors: Jim Winstead <jimw@apache.org> (original Maxmind version) | | Hans Lellelid <hans@xmpl.org> | +----------------------------------------------------------------------+

Author:	Hans Lellelid <hans@xmpl.org>
License:	LGPL http://www.gnu.org/licenses/lgpl.txt
File Size:	201 lines (6 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Net_GeoIP_Location:: (9 methods):
  distance()
  serialize()
  unserialize()
  set()
  __set()
  getData()
  __get()
  __toString()
  __isset()

Class: Net_GeoIP_Location - X-Ref

This class represents a location record as returned by Net_GeoIP::lookupLocation().

This class is primarily a collection of values (the public properties of the class), but
there is also a distance() method to calculate the km distance between two points.

distance(Net_GeoIP_Location $loc) X-Ref

Calculate the distance in km between two points.

param: Net_GeoIP_Location $loc The other point to which distance will be calculated.
return: float The number of km between two points on the globe.

serialize() X-Ref

magic method to make it possible
to store this object in cache when
automatic serialization is on
Specifically it makes it possible to store
this object in memcache

return: array

unserialize($serialized) X-Ref

unserialize a representation of the object

param: array $serialized The serialized representation of the location
return: void

set($name, $val) X-Ref

Setter for elements of $this->aData array

param: string $name The variable to set
param: string $val The value
return: object $this object

__set($name, $val) X-Ref

No description

getData() X-Ref

Getter for $this->aData array

return: array

__get($name) X-Ref

Magic method to get value from $this->aData array

param: string $name The var to get
return: mixed string if value exists or null if it is empty of

__toString() X-Ref

String representation of the object

return: string text and result of print_r of $this->aData array

__isset($name) X-Ref

Magic method
makes it possible to check if specific record exists
and also makes it possible to use empty() on any property

param: strign $name The name of the var to check
return: bool

PHP Cross Reference of Unnamed Project

/lib/pear/Net/GeoIP/ -> Location.php (summary)

Defines 1 class