alcidesrc/severe

Even more severe with strict types in PHP

1.0.3 2024-08-25 17:11 UTC

Requires

• php: ^8.3
• swaggest/json-schema: ^0.12.42

Requires (Dev)

• php-parallel-lint/php-console-highlighter: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.3
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^11.0
• slope-it/clock-mock: ^0.4.0
• squizlabs/php_codesniffer: ^3.9
• symfony/var-dumper: ^7.0

MIT

• Alcides Ramos

• php
• best practices
• clean code
• strict types

README

Severe

Avoid data type conflicts in PHP being more severe

[TOC]

Summary

This repository offers a collection of PHP classes that enforce strict data types, ensuring more reliable and maintainable code. By leveraging these classes, developers can reduce bugs, improve code readability, and enhance overall software quality.

Requirements

This library requires PHP^8.3

Installation

Install Severe using Composer:

composer require fonil/severe

Supported Data Types

Severe supports the following data types:

Type	Category	Version
Array	Generic	1.0
Boolean	Generic	1.0
Closure	Generic	1.0
Float	Generic	1.0
Integer	Generic	1.0
Null	Generic	1.0
Object	Generic	1.0
String	Generic	1.0
Money	Finances	1.0
Domain	Internet	TODO
Email	Internet	TODO
Document	File System	TODO
Image	File System	TODO

Generic Data Types

Usage

Setters

Severe provides a static public method set() that validates the input and creates a data type instance when succeed.

In case of invalid argument type a TypeError is thrown

use Severe\TypeString;
use Severe\TypeBoolean;
use Severe\TypeNull;

$string = TypeString::set($var);
$bool = TypeBoolean::set($flag);
$null = TypeNull::set($optional);
...

Getters

All Severe data type instances are _invokable classes so you can get the values as follow:

$value = $string();
$flag = $bool();
$optional = $null();
...

Ennumeration Classes

Currency

To handle valid currencies a backed enumeration class is provided called Currency which allows you to get the name, symbol, code and decimals for allowed currencies.

Usage

Examples

use Severe\Enums\Currency;

$currency = Currency::EUR;				
echo $currency->value;       // EUR
echo $currency->code();      // 978
echo $currency->name();      // Euro
echo $currency->decimals();  // 2

$currency = Currency::UYI;
echo $currency->value;       // UYI
echo $currency->code();      // 940
echo $currency->name();      // Uruguay Peso en Unidades Indexadas (URUIURUI)
echo $currency->decimals();  // 0

// Dynamic instantiation
$currency = Currency::from('TRY');
echo $currency->value;       // TRY
echo $currency->code();      // 949
echo $currency->name();      // Turkish Lira
echo $currency->decimals();  // 2

Additional Data Types

Money

Additionally, Severe provides a custom data type to handle money entities. Those entities has two components:

• Amount: a float number indicating the amount of money
• Currency: a currency entity

Usage

Setters

All of those ways are supported and equivalents:

use Severe\Enums\Currency;
use Severe\TypeFloat;
use Severe\TypeMoney;

$money = TypeMoney::set(123.456, 'eur');
$money = TypeMoney::set(123.456, Currency::EUR);
$money = TypeMoney::set(TypeFloat::set(123.456), 'EUR');
$money = TypeMoney::set(TypeFloat::set(123.456), Currency::EUR);

Getters

[$amount, $currency] = $money();

// $amount is an instance of TypeFloat
// $currency is an instance of Currency

Examples

$money = TypeMoney::set(123.456789, 'EUR');
[$amount, $currency] = $money();
echo $amount();                  // 123.46
echo $currency->value;           // EUR

$money = TypeMoney::set(123.456789, 'CLF');
echo $money()[0]->__invoke();    // 123.4568
echo $money()[1]->decimals();    // 4

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities:

PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY

Supported Versions

Only the latest major version receives security fixes.

Reporting a Vulnerability

If you discover a security vulnerability within this project, please open an issue here. All security vulnerabilities will be promptly addressed.

License

The MIT License (MIT). Please see LICENSE file for more information.