Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyrihaximus/php-tactician-job-command-mapper
https://github.com/wyrihaximus/php-tactician-job-command-mapper
hacktoberfest php php7 tactician
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/wyrihaximus/php-tactician-job-command-mapper
- Owner: WyriHaximus
- License: mit
- Created: 2017-04-11T19:06:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-04T17:47:01.000Z (10 months ago)
- Last Synced: 2024-09-30T18:09:51.531Z (3 days ago)
- Topics: hacktoberfest, php, php7, tactician
- Language: PHP
- Size: 106 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Job to Command mapper intended to be used with [`Tactician`](http://tactician.thephpleague.com/)
[](https://travis-ci.org/WyriHaximus/php-tactician-job-command-mapper)
[](https://packagist.org/packages/WyriHaximus/tactician-job-command-mapper)
[](https://packagist.org/packages/WyriHaximus/tactician-job-command-mapper/stats)
[](https://scrutinizer-ci.com/g/WyriHaximus/php-tactician-job-command-mapper/?branch=master)
[](https://packagist.org/packages/WyriHaximus/tactician-job-command-mapper)
[](https://travis-ci.org/WyriHaximus/php-tactician-job-command-mapper)
# Install
To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.
```
composer require wyrihaximus/tactician-job-command-mapper
```
# Set up
When creating a `Command` add the `@Job` annotation to map it to one or more jobs.
```php
map('src' . DS . 'CommandBus');
```
## Mapper::hasCommand
Check if the map has a command for the job we have.
```php
$job = 'awesomesauce';
// True when it has a command or false when it doesn't
$map->hasCommand($job);
```
## Mapper::getCommand
Check if the map has a command for the job we have.
```php
$job = 'awesomesauce';
// Command class when it has a command, or throws an exception when it doesn't
$command = $map->getCommand($job);
// Call the command bus with the command we found to handle the given job
$commandBus->handle(new $command(...$data));
```
## Full class example
```php
final class CommandBusWrapper
{
/**
* @var CommandBus
*/
private $commandBus;
/**
* @var Mapper
*/
private $map;
/**
* @param CommandBus
*/
public function __construct(CommandBus $commandBus)
{
$this->commandBus = $commandBus;
$this->map = (new Mapper())->map('src' . DS . 'CommandBus', 'App\CommandBus');
}
/**
* @param string $job
* @param array $data
* @return bool
*/
function handle(string $job, array $data = []): bool
{
if (!$this->map->hasCommand($job)) {
return false;
}
$command = $map->getCommand($job);
$this->commandBus->handle(new $command(...$data));
return true;
}
}
```
# License
The MIT License (MIT)
Copyright (c) 2019 Cees-Jan Kiewiet
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.