Documentation for class BpUsr



/**
 *  @package:   bpl - brain pies library
 * 	class		BpUser
 * 
 *  @author:    BrainPies Team
 *  @copyright: BrainPies Team
 *  @link:		https://brainpies.com
 * 
 *  @license:   GNU/GPL v.3.0 or any later version
 *  @link:		https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL
 * 
 *  @version:   1.0.0
 * 
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 3 of the License, or (at your option)
 * any later version.

 * This program is distributed 'as is', 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 General Public License for
 * more details.

 * You should have received a copy of the GNU General Public License along
 * with this program (COPYING); if not, go to http://www.fsf.org/ or write
 * to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

	/**
	 * @method	getGeoData
	 * Method to get user's geographic data
	 *
	 * @param	string	$ip		mandatory	the user IP
	 * 
	 * @return	object			all user's geographic data
	 *
	 * @since	1.0.0
	 * 
	 * 
	 *	return the following object keys:
	 *		->regionName	the region name, ie: Lombardy
	 *		->city			the city, ie: Milan
	 *		->zip			the zip code, ie: 
	 *		->status		returns 'success' if the query succeded		
	 *		->timeZone		ie: 'Europe/Madrid'
	 *		->isp			return the internet service provider name
	 *		->lon			longitude numeric position, ie: 7.24261999130249
	 *		->countryCode	ie: ES
	 *		->region		the region, if available, ie: Lombardy
	 *		->lat			latitude numeric position, ie: 15.883201599121094
	 *		->query			the IP checked
	 *		->country		the country, ie: Italy
	 *		->org			the Internet service provider
	*/

	/**
	 * @method	communicate
	 * Method to query the user's IP
	 *
	 * @param	string	$ip		mandatory	the user IP
	 * 
	 * @access	private
	 * 
	 * @return	array			all user's geographic data
	 *
	 * @since	1.0.0
	 */

	/**
	 * @method	getBrowser
	 * Method to retrieve browser info
	 * 
	 * @author	ruudrp@live.nl
	 * @link	php.net/get_browser
	 * 
	 * @return	array
	 * 
	 * @since	1.0.0
	 * 
	 * 		return the following object keys:
	 * 			->userAgent
	 * 			->name
	 * 			->version
	 * 			->platform
	 * 			->pattern
	 */

	/**
	 * @method	getIp
	 * Method to retrieve the sanitized IP address
	 *
	 * @return	string
	 * 
	 * @since	1.0.0
	 */