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

https://github.com/phpinnacle/domain


https://github.com/phpinnacle/domain

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

# system

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]

**Note:** Replace ```PHPinnacle``` ```phpinnacle``` ```phpinnacle.com``` ```dev@phpinnacle.com``` ```phpinnacle``` ```system``` ```PHPinnacle framework system library``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md) and [composer.json](composer.json) files, then delete this line. You can run `$ php prefill.php` in the command line to make all replacements at once. Delete the file prefill.php as well.

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
PSRs you support to avoid any confusion with users and contributors.

## Structure

If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.

```
bin/
config/
src/
tests/
vendor/
```

## Install

Via Composer

``` bash
$ composer require phpinnacle/domain
```

## Usage

``` php
$user = \Acme\User::register('Eric');

echo "New User AR created with id \"{$user->getID()}\".\n";

$user->changeName('Greg');

$events = $user->pullEvents();

echo "Now our AR in version {$user->getVersion()}.\n";
echo "And those events raised during AR lifetime:\n";

foreach ($events as $event) {
echo ' - ' . \get_class($event) . \PHP_EOL;
}

echo "New user name: {$user->getName()}\n";
```

## Change log

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

## Testing

``` bash
$ composer test
```

## Contributing

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

## Security

If you discover any security related issues, please email dev@phpinnacle.com instead of using the issue tracker.

## Credits

- [PHPinnacle][link-author]
- [All Contributors][link-contributors]

## License

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

[ico-version]: https://img.shields.io/packagist/v/phpinnacle/system.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/phpinnacle/system/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/phpinnacle/system.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/phpinnacle/system.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/phpinnacle/system.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/phpinnacle/system
[link-travis]: https://travis-ci.org/phpinnacle/system
[link-scrutinizer]: https://scrutinizer-ci.com/g/phpinnacle/system/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/phpinnacle/system
[link-downloads]: https://packagist.org/packages/phpinnacle/system
[link-author]: https://github.com/phpinnacle
[link-contributors]: ../../contributors