Cmfcmf\OpenWeatherMap\Util\Unit

Complexity

Total Complexity

13

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	__toString()	0	4	1
A	getUnit()	0	12	4
A	getValue()	0	4	1
A	getDescription()	0	4	1
A	getPrecision()	0	4	1
A	getFormatted()	0	8	2
A	jsonSerialize()	0	9	1

<?php

/*
 * OpenWeatherMap-PHP-API — A PHP API to parse weather data from https://OpenWeatherMap.org.
 *
 * @license MIT
 *
 * Please see the LICENSE file distributed with this source code for further
 * information regarding copyright and licensing.
 *
 * Please visit the following links to read about the usage policies and the license of
 * OpenWeatherMap data before using this library:
 *
 * @see https://OpenWeatherMap.org/price
 * @see https://OpenWeatherMap.org/terms
 * @see https://OpenWeatherMap.org/appid
 */

namespace Cmfcmf\OpenWeatherMap\Util;

use JsonSerializable;

/**
 * The unit class representing a unit object.
 */
class Unit implements JsonSerializable
{
    /**
     * @var float The value.
     *
     * @internal
     */
    private $value;

    /**
     * @var string The value's unit.
     *
     * @internal
     */
    private $unit;

    /**
     * @var string The value's description.
     *
     * @internal
     */
    private $description;

    /**
     * @var float|null The value's measurement precision. Can be null if unknown.
     */
    private $precision;

    /**
     * Create a new unit object.
     *
     * @param float $value The value.
     * @param string $unit The unit of the value.
     * @param string $description The description of the value.
     * @param float|null $precision The precision of the value, or null if unknown.
     *
     * @internal
     */
    public function __construct($value = 0.0, $unit = "", $description = "", $precision = null)
    {
        $this->value = (float)$value;
        $this->unit = (string)$unit;
        $this->description = (string)$description;
        $this->precision = $precision === null ? null : (float)$precision;
    }

    /**
     * Get the value as formatted string with unit.
     *
     * @return string The value as formatted string with unit.
     *
     * The unit is not included if it is empty.
     */
    public function __toString()
    {
        return $this->getFormatted();
    }

    /**
     * Get the value's unit.
     *
     * @return string The value's unit.
     *
     * This also converts 'celsius' to '°C' and 'fahrenheit' to '°F'.
     */
    public function getUnit()
    {
        // Units are inconsistent. Only celsius and fahrenheit are not abbreviated. This check fixes that.
        // Also, the API started to return "metric" as temperature unit recently. Also fix that.
        if ($this->unit == 'celsius' || $this->unit == 'metric') {
            return "°C";
        } elseif ($this->unit == 'fahrenheit') {
            return '°F';
        } else {
            return $this->unit;
        }
    }

    /**
     * Get the value.
     *
     * @return float The value.
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the value's description.
     *
     * @return string The value's description.
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Get the value's precision.
     *
     * @return float|null The value's precision. Can be null if unknown.
     */
    public function getPrecision()
    {
        return $this->precision;
    }

    /**
     * Get the value as formatted string with unit.
     *
     * @return string The value as formatted string with unit.
     *
     * The unit is not included if it is empty.
     */
    public function getFormatted()
    {
        if ($this->getUnit() != "") {
            return $this->getValue() . " " . $this->getUnit();
        } else {
            return (string)$this->getValue();
        }
    }

    /**
     * Get Unit properties when encoding to JSON
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'value' => $this->getValue(),
            'unit' => $this->getUnit(),
            'description' => $this->getDescription(),
            'precision' => $this->getPrecision()
        ];
    }
}