wandersonwhcr/illuminate-romans

Laravel Illuminate Romans Integration


Keywords
validator, format, converter, laravel, illuminate, roman, roman-number, roman-numeral, composer, php
License
MIT

Documentation

illuminate-romans

Laravel Illuminate Romans Integration

Build Status Latest Stable Version License

Description

This package provides a Laravel integration for Romans library, providing tools to filter string with a Roman number to int and vice-versa.

Installation

This package uses Composer as default repository. You can install it adding the name of package in require attribute of composer.json, pointing to the last stable version.

{
    "require": {
        "wandersonwhcr/illuminate-romans": "^2.0"
    }
}

Usage

This package provides facades and helpers to use with Laravel projects. Also, this package is provided as a Laravel Package to automatically configure services inside application.

Facades

Illuminate Romans provides a couple of facades to convert a string with Roman number to int and an Integer to a string that represents the input as Roman number.

use Illuminate\Romans\Support\Facades\IntToRoman as IntToRomanFacade;
use Illuminate\Romans\Support\Facades\RomanToInt as RomanToIntFacade;

$value = 'MCMXCIX';

$value = RomanToIntFacade::filter($value); // 1999
$value = IntToRomanFacade::filter($value); // MCMXCIX

Helpers

Also, this package includes helpers as a bridge to facades.

$value = 'MCMXCIX';

$value = roman_to_int($value); // 1999
$value = int_to_roman($value); // MCMXCIX

Development

You can use Docker Compose to build an image and run a container to develop and test this package.

docker-compose build
docker-compose run romans composer install
docker-compose run romans composer test

License

This package is opensource and available under license MIT described in LICENSE.