rdx\units\Quantity

Complexity

Total Complexity

22

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	8
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	convert()	0	4	1
A	validateUnit()	0	6	2
A	validUnit()	0	12	3
B	__construct()	0	17	5
A	to()	0	5	1
	convertor()	0	1	?
A	convertUsingTable()	0	15	3
A	convertUsingMethods()	0	13	3
A	convertTo()	0	4	1
A	all()	0	12	3

<?php

namespace rdx\units;

use rdx\units\exceptions\ConversionException;

abstract class Quantity {

	// The sub class must set these, since every Quantity has different units
	// const BASE_UNIT = 'l';

	// static public $default_unit = self::BASE_UNIT;

47% of this comment could be valid code. Did you maybe forget this after debugging?

	// static public $units = array();

54% of this comment could be valid code. Did you maybe forget this after debugging?

	/**
	 * Convert without the bother of an object
	 */
	static public function convert( $amount, $fromUnit, $toUnit ) {
		$quantity = new static($amount, $fromUnit);
		return $quantity->to($toUnit);
	}

	/**
	 * Throw a ConversionException if the given unit isn't valid for the called class
	 */
	static public function validateUnit( &$unit ) {
		if ( !static::validUnit($unit) ) {
			$quantity = (new \ReflectionClass(get_called_class()))->getShortName();
			throw new ConversionException("Can't import '$quantity' as '$unit'.");
		}
	}

	/**
	 * Check if the given unit is valid for the called class
	 */
	static public function validUnit( &$unit ) {
		if ( $unit === 'base' ) {
			$unit = static::BASE_UNIT;
			return true;
		}

		$units = static::$units;
		if ( isset($units[0]) ) {
			return in_array($unit, $units);
		}
		return isset($units[$unit]);
	}



	public $original_unit = '';
	public $unit = '';
	public $amount = 0;

	/**
	 *
	 */
	public function __construct( $amount, $unit = null, $convertToDefault = true ) {
		// Invalid unit!
		if ( $unit ) {
			static::validateUnit($unit);
		}

		$this->amount = $amount;
		$this->unit = $unit ?: $this::$default_unit;

		$this->original_unit = $this->unit;

		// Convert incoming unit into storage unit
		if ( $convertToDefault && $this->unit != $this::$default_unit ) {
			$this->amount = $this->to($this::$default_unit);
			$this->unit = $this::$default_unit;
		}
	}

	/**
	 * Convert object amount to another unit, and return, don't save
	 */
	public function to( $toUnit ) {
		static::validateUnit($toUnit);

		return $this->convertor($toUnit);
	}

	/**
	 * The convertor heart, that every sub class needs
	 */
	abstract protected function convertor( $toUnit );

	/**
	 * The default convertor, using the Quantity's conversion table
	 */
	protected function convertUsingTable( $toUnit ) {
		$this::validateUnit($toUnit);

		$amount = $this->amount;

		// First convert from `$this->unit` to `BASE_UNIT`
		$factor = $this::$units[$this->unit];
		$amount = $factor < 0 ? -$factor / $amount : $amount * $factor;

		// Then convert from `BASE_UNIT` to `$toUnit`
		$factor = $this::$units[$toUnit];
		$amount = $factor < 0 ? -$factor / $amount : $amount / $factor;

		return $amount;
	}

	/**
	 * Advanded convertor, using unit-base-unit methods
	 */
	protected function convertUsingMethods( $toUnit ) {
		$amount = $this->amount;

		if ( $this->unit != $this::BASE_UNIT ) {
			$amount = call_user_func(array($this, $this->unit . 'to' . $this::BASE_UNIT), $amount);
		}

		if ( $this::BASE_UNIT != $toUnit ) {
			$amount = call_user_func(array($this, $this::BASE_UNIT . 'to' . $toUnit), $amount);
		}

		return $amount;
	}

	/**
	 * Convert the object to another standard unit
	 */
	public function convertTo( $unit ) {
		$this->amount = $this->to($unit);
		$this->unit = $unit;
	}

	/**
	 * Return this quantity in all known units
	 */
	public function all() {
		$all = array();
		foreach ( $this::$units as $unit => $conversion ) {
			if ( is_int($unit) ) {
				$unit = $conversion;
			}

			$all[$unit] = $this->to($unit);
		}

		return $all;
	}

}