Joomla\DateTime\DateInterval

Complexity

Total Complexity

17

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	createFromDateString()	0	4	1
A	__get()	0	4	1
A	add()	0	13	1
B	equals()	0	12	7
A	invert()	0	7	2
A	getDateInterval()	0	4	1
A	format()	0	4	1
A	copy()	0	7	1

<?php
/**
 * Part of the Joomla Framework DateTime Package
 *
 * @copyright  Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
 * @license    GNU Lesser General Public License version 2.1 or later; see LICENSE
 */

namespace Joomla\DateTime;

/**
 * DateInterval.
 *
 * @since  2.0.0
 *
 * @property-read  integer  $y       Number of years.
 * @property-read  integer  $m       Number of months.
 * @property-read  integer  $d       Number of days.
 * @property-read  integer  $h       Number of hours.
 * @property-read  integer  $i       Number of minutes.
 * @property-read  integer  $s       Number of seconds.
 * @property-read  integer  $invert  Is 1 if the interval represents a negative time period and 0 otherwise.
 */
final class DateInterval
{
	/**
	 * PHP DateInverval object
	 *
	 * @var    \DateInterval
	 * @since  2.0.0
	 */
	private $interval;

	/**
	 * Constructor.
	 *
	 * @param   \DateInterval|string  $interval  Either a PHP DateInterval object or a string with an interval specification.
	 *
	 * @since   2.0.0
	 */
	public function __construct($interval)
	{
		$this->interval = ($interval instanceof \DateInterval) ? $this->copy($interval) : new \DateInterval($interval);
	}

	/**
	 * Creates a DateInterval object from the relative parts of the string.
	 *
	 * @param   string  $time  A date with relative parts.
	 *
	 * @return  DateInterval
	 *
	 * @since   2.0.0
	 */
	public static function createFromDateString($time)
	{
		return new DateInterval(\DateInterval::createFromDateString($time));
	}

	/**
	 * Creates a DateInterval object by adding another interval into it.
	 * Uses absolute values for addition process.
	 *
	 * @param   DateInterval  $interval  The interval to be added.
	 *
	 * @return  DateInterval
	 *
	 * @since   2.0.0
	 */
	public function add(DateInterval $interval)
	{
		$years   = $this->y + $interval->y;
		$months  = $this->m + $interval->m;
		$days    = $this->d + $interval->d;
		$hours   = $this->h + $interval->h;
		$minutes = $this->i + $interval->i;
		$seconds = $this->s + $interval->s;

		$spec = sprintf('P%sY%sM%sDT%sH%sM%sS', $years, $months, $days, $hours, $minutes, $seconds);

		return new DateInterval($spec);
	}

	/**
	 * Checks if the current interval is equals to the interval given as parameter.
	 *
	 * @param   DateInterval  $interval  The interval to compare.
	 *
	 * @return  boolean
	 *
	 * @since   2.0.0
	 */
	public function equals(DateInterval $interval)
	{
		$years   = $this->y == $interval->y;
		$months  = $this->m == $interval->m;
		$days    = $this->d == $interval->d;
		$hours   = $this->h == $interval->h;
		$minutes = $this->i == $interval->i;
		$seconds = $this->s == $interval->s;
		$invert  = $this->invert == $interval->invert;

		return $years && $months && $days && $hours && $minutes && $seconds && $invert;
	}

	/**
	 * Creates a DateInterval object by inverting the value of the current one.
	 *
	 * @return  DateInterval
	 *
	 * @since   2.0.0
	 */
	public function invert()
	{
		$interval = $this->copy($this->interval);
		$interval->invert = $interval->invert ? 0 : 1;

		return new DateInterval($interval);
	}

	/**
	 * Formats the interval.
	 *
	 * @param   string  $format  Format accepted by PHP DateInterval::format().
	 *
	 * @return  string
	 *
	 * @since   2.0.0
	 */
	public function format($format)
	{
		return $this->interval->format($format);
	}

	/**
	 * Magic method to access properties of the interval.
	 *
	 * @param   string  $name  The name of the property.
	 *
	 * @return  mixed
	 *
	 * @since   2.0.0
	 */
	public function __get($name)
	{
		return $this->interval->$name;
	}

	/**
	 * Returns a PHP DateInterval object.
	 *
	 * @return  \DateInterval
	 *
	 * @since   2.0.0
	 */
	public function getDateInterval()
	{
		return $this->copy($this->interval);
	}

	/**
	 * Creates a copy of PHP DateInterval object.
	 *
	 * @param   \DateInterval  $interval  The object to copy.
	 *
	 * @return  \DateInterval
	 *
	 * @since   2.0.0
	 */
	private function copy(\DateInterval $interval)
	{
		$copy = new \DateInterval($interval->format('P%yY%mM%dDT%hH%iM%sS'));
		$copy->invert = $interval->invert;

		return $copy;
	}
}