Skip to content

Commit 2685518

Browse files
committed
readme update
1 parent 3004c7e commit 2685518

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[![Build Status](https://travis-ci.org/mmasiukevich/message-serializer.svg?branch=master)](https://travis-ci.org/mmasiukevich/message-serializer)
2+
[![Code Coverage](https://scrutinizer-ci.com/g/mmasiukevich/message-serializer/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mmasiukevich/message-serializer/?branch=master)
3+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mmasiukevich/message-serializer/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mmasiukevich/message-serializer/?branch=master)
4+
5+
## What is it?
6+
7+
A library that provides a basic implementation of message serialization (object -> JSON -> object) for [service-bus](https://github.com/mmasiukevich/service-bus) framework
8+
9+
Currently implemented:
10+
* [Symfony Serialazer](https://github.com/mmasiukevich/message-serializer/blob/master/src/Symfony/SymfonyMessageSerializer.php): Supports normalization/denormalization of public/private properties; DateTime objects; Empty objects with closed constructor. The description of property types is in the PHPDoc.
11+
12+
Usage example ([@see test case](https://github.com/mmasiukevich/message-serializer/blob/master/tests/Symfony/SymfonyMessageSerializerTest.php#L210):
13+
14+
```php
15+
$serializer = new SymfonyMessageSerializer();
16+
17+
$object = TestMessage::create(
18+
'message-serializer',
19+
null,
20+
'dev-master',
21+
Author::create('Vasiya', 'Pupkin')
22+
);
23+
24+
echo $serializer->encode($object);
25+
```
26+
Will output:
27+
```json
28+
{
29+
"message": {
30+
"componentName": "message-serializer",
31+
"stableVersion": null,
32+
"devVersion": "dev-master",
33+
"author": {
34+
"firstName": "Vasiya",
35+
"lastName": "Pupkin"
36+
}
37+
},
38+
"namespace": "Desperado\\ServiceBus\\MessageSerializer\\Tests\\Stubs\\TestMessage"
39+
}
40+
```

0 commit comments

Comments
 (0)