Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bramus/php-datatypes

A (Legacy) Types Implementation for PHP
https://github.com/bramus/php-datatypes

Last synced: 3 days ago
JSON representation

A (Legacy) Types Implementation for PHP

Awesome Lists containing this project

README

        

# `bramus/datatypes`

[![Build Status](https://github.com/bramus/php-datatypes/workflows/CI/badge.svg)](https://github.com/bramus/php-datatypes/actions) [![Source](http://img.shields.io/badge/source-bramus/datatypes-blue.svg?style=flat-square)](https://github.com/bramus/php-datatypes) [![Version](https://img.shields.io/packagist/v/bramus/datatypes.svg?style=flat-square)](https://packagist.org/packages/bramus/datatypes) [![Downloads](https://img.shields.io/packagist/dt/bramus/datatypes.svg?style=flat-square)](https://packagist.org/packages/bramus/datatypes/stats) [![License](https://img.shields.io/packagist/l/bramus/datatypes.svg?style=flat-square)](https://github.com/bramus/php-datatypes/blob/master/LICENSE)

`bramus/datatypes` is a (Legacy) Types Implementation for PHP.

Built by Bram(us) Van Damme _([https://www.bram.us](https://www.bram.us))_ and [Contributors](https://github.com/bramus/php-datatypes/graphs/contributors)

## Prerequisites/Requirements

- PHP 7.2 or greater

## Installation

Installation is possible using Composer

```
$ composer require bramus/datatypes ~1.0
```

## Usage

@TODO

## Utility Classes

`bramus/datatypes` comes with a few utility/helper classes. Whilst you most likely don't need to use these directly, they might be of help:

@TODO

## Testing

`bramus/datatypes` ships with unit tests using [PHPUnit](https://github.com/sebastianbergmann/phpunit/) `~8.0`.

- If PHPUnit is installed globally run `phpunit` to run the tests.
- If PHPUnit is not installed globally, install it locally throuh composer by running `composer install --dev`. Run the tests themselves by calling `./vendor/bin/phpunit` or using the composer script `composer test`

```
$ composer test
```

## License

`bramus/datatypes` is released under the MIT public license. See the enclosed `LICENSE` for details.