Skip to content

Commit cbf5251

Browse files
authored
Update README.md
1 parent 5b854d8 commit cbf5251

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Tactician ZF3 Module
22

3-
Donations will encourage me to work harder on this free project.
4-
5-
### Wrapper module for easy use of the [Tactician](http://tactician.thephpleague.com/) Command Bus in your ZF3 applications.
3+
Wrapper module for easy use of the [Tactician](http://tactician.thephpleague.com/) Command Bus in your ZF3 applications.
64

75
[![Build Status](https://travis-ci.org/mikemix/TacticianModule.svg?branch=master)](https://travis-ci.org/mikemix/TacticianModule) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mikemix/TacticianModule/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mikemix/TacticianModule/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/mikemix/TacticianModule/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mikemix/TacticianModule/?branch=master) [![Dependency Status](https://www.versioneye.com/user/projects/556b5a106365320026fa4500/badge.svg?style=flat)](https://www.versioneye.com/user/projects/556b5a106365320026fa4500) [![Latest Stable Version](https://poser.pugx.org/mikemix/tactician-module/v/stable)](https://packagist.org/packages/mikemix/tactician-module) [![Total Downloads](https://poser.pugx.org/mikemix/tactician-module/downloads)](https://packagist.org/packages/mikemix/tactician-module) [![License](https://poser.pugx.org/mikemix/tactician-module/license)](https://packagist.org/packages/mikemix/tactician-module)
86

9-
### Installation
7+
## Installation
108

119
Best install with Composer:
1210

@@ -21,7 +19,7 @@ Best install with Composer:
2119
],
2220
```
2321

24-
### Using
22+
## Using
2523

2624
The module presents a __Controller Plugin__ called `tacticianCommandBus()` for easy use of dispatching commands. If no command object is passed to it, the CommandBus object will be returned. If you pass the command however, it will be passed over to the CommandBus and handled, and the output from the handler will be returned.
2725

@@ -85,7 +83,7 @@ final class UserLoginHandler
8583

8684
You can inject the `CommandBus` into yout service layer through a factory by simply requesting the `League\Tactician\CommandBus::class` from the __Container__.
8785

88-
### Configuring
86+
## Configuring
8987

9088
The module ships with a `ZendLocator` and a `CommandHandlerMiddleware` and a `HandlerInflector` configured as default. If you wish to override the default locator or default command bus implementations, then simply use the `tactician` key in the merged config.
9189

@@ -117,7 +115,7 @@ To add custom middleware to the middleware stack, add it to the `middleware` arr
117115
],
118116
```
119117

120-
### Basic usage
118+
## Basic usage
121119

122120
Basicly, all you probably will want to do, is to define the `handler-map` array in your module's configuration. For example:
123121

@@ -134,9 +132,9 @@ Basicly, all you probably will want to do, is to define the `handler-map` array
134132
];
135133
```
136134

137-
### Plugins
135+
## Plugins
138136

139-
#### LockingMiddleware
137+
### LockingMiddleware
140138

141139
The [LockingMiddleware](http://tactician.thephpleague.com/plugins/locking-middleware/) can now be used out of the box.
142140
Simply add the `League\Tactician\Plugins\LockingMiddleware` FQCN to the TacticianModule's middleware configuration with
@@ -155,7 +153,7 @@ appropriate priority. You probably want to execute it before the `CommandHandler
155153
];
156154
```
157155

158-
#### TransactionMiddleware
156+
### TransactionMiddleware
159157

160158
The [TransactionMiddleware](http://tactician.thephpleague.com/plugins/doctrine/) can now be used out of the box.
161159
Simply add the `League\Tactician\Doctrine\ORM\TransactionMiddleware` FQCN to the TacticianModule's middleware configuration with
@@ -174,9 +172,9 @@ appropriate priority. You probably want to execute it before the `CommandHandler
174172
];
175173
```
176174

177-
### Changing the Handler Locator
175+
## Changing the Handler Locator
178176

179-
#### ClassnameZendLocator
177+
### ClassnameZendLocator
180178

181179
This locator simply appends the word `Handler` to the command's FQCN so you don't have to define any handler map. For example, if you request command `App\Commands\LoginCommand`, locator will try to get `App\Command\LoginCommandHandler` from the Service Manager.
182180

0 commit comments

Comments
 (0)