https://github.com/adampatterson/numeral

A PHP library for formatting and manipulating numbers.
https://github.com/adampatterson/numeral

composer number numeral packagist php php-library

Last synced: 3 months ago
JSON representation

A PHP library for formatting and manipulating numbers.

• Host: GitHub
• URL: https://github.com/adampatterson/numeral
• Owner: adampatterson
• Created: 2016-02-13T03:27:04.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-01-04T07:09:00.000Z (12 months ago)
• Last Synced: 2024-10-14T04:20:10.714Z (3 months ago)
• Topics: composer, number, numeral, packagist, php, php-library
• Language: PHP
• Size: 41 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Numeral PHP

![PHP Composer](https://github.com/adampatterson/Numeral/workflows/PHP%20Composer/badge.svg?branch=main)

[![Packagist Version](https://img.shields.io/packagist/v/adampatterson/numeral)](https://packagist.org/packages/adampatterson/numeral)

[![Packagist Downloads](https://img.shields.io/packagist/dt/adampatterson/numeral)](https://packagist.org/packages/adampatterson/numeral/stats)

A PHP library for formatting and manipulating numbers. 

This script is still under development and a PHP clone of [Numeral-js](https://github.com/adamwdraper/Numeral-js) by [Adam Draper](https://github.com/adamwdraper).

## Install from [Packagist](https://packagist.org/packages/adampatterson/numeral)

```

composer require adampatterson/numeral

```

## For use in Laravel Views ( Blade files )

Open `config/app.php` and add Numeral to the aliases array.

```

'Numeral'      => Numeral\Numeral::class

```

`{{ \Numeral::number(85193.456)->format('0.00') }}`

## Usage

```

use Numeral\Numeral;

class SomeController extends Controller

{

    public function myMethod(Numeral $numeral){

        $numeral->number('85193.456')->format()

    }

    

    // OR

    public function myOtherMethod(){

        Numeral::number('85193.456')->format()

    }

}

```

### Numbers

```

var_dump(Numeral::number('85193.456')->format()); // 85193

var_dump(Numeral::number('85193.456')->format('0.00')); // 85193.46

var_dump(Numeral::number('85193.456')->format('0,0.00')); // 85,193.46

var_dump(Numeral::number('-85193.00')->format()); // -85193

var_dump(Numeral::number('-85193')->format('0.00')); // -85193.00

```

### Percentages

```

var_dump(Numeral::number('-0.43')->format('0%')); // -43%

var_dump(Numeral::number('0.75')->format('0%')); // 75%

```

### Time

```

var_dump(Numeral::number('25')->format('00:00:00')); // 0:00:25

var_dump(Numeral::number('238')->format('00:00:00')); // 0:03:58

var_dump(Numeral::number('63846')->format('00:00:00')); // 17:44:06

```

### Currency

**Work in progress.**

```

var_dump(Numeral::number('85187993.00')->format('$0,0.00')); // $85,187,993.00

var_dump(Numeral::number('85187993.00')->format('$0,0')); // $85,187,993

var_dump(Numeral::number('$85187993.00')->format('$0.00')); // $85187993.00

var_dump(Numeral::number('85187993.00')->format('$0')); // $85187993

```

### Un-format 

**Work in progress.**

## Tests

```

$ composer global require phpunit/phpunit

$ export PATH=~/.composer/vendor/bin:$PATH

$ which phpunit

~/.composer/vendor/bin/phpunit

```

`composer run-script test`

## Local Dev

`ln -s ~/Sites/personal/_packages/Numeral/ ~/Sites/personal/projectName/vendor/adampatterson/Numeral`