Documentation for class BpDate



/**
 *  @package:   bpl - brain pies library
 * 	class		BpDate
 * 
 *  @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	dateDiff
	 * Method to get difference between dates
	 * 
	 * @param string	$dateFrom	mandatory	start date
	 * @param string	$dateTo		mandatory	end date
	 * @param string	$interval	optional	the format of difference to return
	 * 
	 * @return string 	the date difference
	 * @return false|float|int|string
	 */

	/**
	 * @method	display
	 * Method to format a date
	 *
	 * @param	string	mandatory	the date string
	 * @param	string	optional	the format required
	 * 
	 * @return	string				the formatted date
	 * 
	 * @since 	1.0.0
	 */

	/**
	 * @method	getAge
	 * Method to get the age of a person given the birth date 
	 *
	 * @param	string	mandatory	date
	 * 
	 * @return	int  	number of years | bool false if null date is given
	 *
	 * @since	1.0.0
	 */

	/**
	 * @method	getNow
	 * Method to get a date now 
	 *
	 * @param	string	optional	date format to return
	 * @param	bool	optional	whether a timezoned date is requested or not
	 * 
	 * @return	string  date in given format - default is db format, timezoned
	 *
	 * @since	1.0.0
	 */

	/**
	 * @method	getTimeZone
	 * Method to retrieve the timezone
	 *
	 * @uses	Bp::getUser()
	 * 
	 * @return	int		the timezone
	 * 
	 * @since 	1.0.0
	 */

	/**
	 * @method	jdate
	 * Method to get a jdate object for a given date 
	 *
	 * @param	string	$date		mandatory	date
	 * @param	string	$format		optional	the format
	 * @param	int		$timezone	optional	the timezone
	 * 
	 * @return	object  JDate
	 *
	 * @since	1.0.0
	 */