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

https://github.com/woohoolabs/worm

Woohoo Labs. Worm ORM
https://github.com/woohoolabs/worm

data-mapper hydrator identity-map orm php unit-of-work

Last synced: 29 days ago
JSON representation

Woohoo Labs. Worm ORM

Awesome Lists containing this project

README

          

# Woohoo Labs. Worm

[![Latest Version on Packagist][ico-version]][link-version]
[![Software License][ico-license]](LICENSE)
[![Build Status][ico-build]][link-build]
[![Coverage Status][ico-coverage]][link-coverage]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![Gitter][ico-support]][link-support]

**Woohoo Labs. Worm is an efficient and minimal ORM enabling data mapping.**

## Table of Contents

* [Introduction](#introduction)
* [Install](#install)
* [Basic Usage](#basic-usage)
* [Advanced Usage](#advanced-usage)
* [Examples](#examples)
* [Versioning](#versioning)
* [Change Log](#change-log)
* [Contributing](#contributing)
* [Support](#support)
* [Credits](#credits)
* [License](#license)

## Introduction

## Install

The steps of this process are quite straightforward. The only thing you need is [Composer](https://getcomposer.org).

#### Add Worm to your composer.json:

To install this library, run the command below and you will get the latest version:

```bash
$ composer require woohoolabs/worm
```

> Note: The tests and examples won't be downloaded by default. You have to use `composer require woohoolabs/worm --prefer-source`
or clone the repository if you need them.

## Basic Usage

## Advanced Usage

## Examples

Have a look at the [examples directory](https://github.com/woohoolabs/worm/blob/master/examples/) for a really basic
example. Don't forget to run `composer install` first in Worm's root directory if you want to try it out!

## Versioning

This library follows [SemVer v2.0.0](https://semver.org/).

## Change Log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

Worm has a PHPUnit test suite. To run the tests, run the following command from the project folder:

``` bash
$ phpunit
```

Additionally, you may run `docker-compose up` or `make test` to execute the tests.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Support

Please see [SUPPORT](SUPPORT.md) for details.

## Credits

- [Máté Kocsis][link-author]
- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see the [License File](LICENSE) for more information.

[ico-version]: https://img.shields.io/packagist/v/woohoolabs/worm.svg
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[ico-build]: https://img.shields.io/github/workflow/status/woohoolabs/worm/Continuous%20Integration
[ico-coverage]: https://img.shields.io/codecov/c/github/woohoolabs/worm
[ico-code-quality]: https://img.shields.io/scrutinizer/g/woohoolabs/worm.svg
[ico-downloads]: https://img.shields.io/packagist/dt/woohoolabs/worm.svg
[ico-support]: https://badges.gitter.im/woohoolabs/worm.svg

[link-version]: https://packagist.org/packages/woohoolabs/worm
[link-build]: https://github.com/woohoolabs/worm/actions
[link-coverage]: https://codecov.io/gh/woohoolabs/worm
[link-code-quality]: https://scrutinizer-ci.com/g/woohoolabs/worm
[link-downloads]: https://packagist.org/packages/woohoolabs/worm
[link-author]: https://github.com/kocsismate
[link-contributors]: ../../contributors
[link-support]: https://gitter.im/woohoolabs/worm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge