php-value-object/temperature

Temperature ValueObject for PHP. Easy to use with implementation of Kelvin, Celsius and Fahrenheit

Maintainers

Details

github.com/PHPValueObject/Temperature

Source

Issues

Installs: 21

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 5

Forks: 1

Open Issues: 0

v0.2 2018-02-05 19:56 UTC

Requires

  • php: >=7.0

Requires (Dev)

MIT 3cae342d0542e795a79cdcdc8a3a26344fdfae3b

  • Martin Hlavac <public.woop@mhlavac.net>

This package is not auto-updated.

Last update: 2024-12-14 04:00:12 UTC

README

Build Status Latest Stable Version License PHPStan

This repository provides Temperature ValueObject implementation for PHP that is easy to use and easily allow your classes to depend on Temperature object instead of just float or string.

Install

You can install this package via composer

composer require php-value-object/temperature

Example

function isItWarm(Temperature $temperature) : bool
{
    $hot = new Celsius(23);
    if($temperature->gte($hot)) {
      return true; // t-shirt time
    }
    
    return false; // jacket time
}

$temperature = new Kelvin(0);
isItWarm($temperature); // false

Usage

The temperature classes are supported: Celsius, Fahrenheit and Kelvin.

It is possible to compare them via helper methods:

  • eq - equals
  • gt - greater than
  • gte - greater than or equals
  • lt - less than
  • lte - less than or equals
  • compareTo - returns -1, 0, 1 if less than, equal or greater than

To introduce new temperature class simply extend Temperature.

Licence

MIT

Contributing

Any contributions are welcome

Building & Development

The easiest way how to develop is to git clone and run make

git clone git@github.com:PHPValueObject/Temperature.git temperature
cd temperature
make