|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* This file is part of the xAPI package. |
|
5
|
|
|
* |
|
6
|
|
|
* (c) Christian Flothmann <[email protected]> |
|
7
|
|
|
* |
|
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
9
|
|
|
* file that was distributed with this source code. |
|
10
|
|
|
*/ |
|
11
|
|
|
|
|
12
|
|
|
namespace Xabbuh\XApi\Serializer; |
|
13
|
|
|
|
|
14
|
|
|
use JMS\Serializer\EventDispatcher\EventDispatcher; |
|
15
|
|
|
use JMS\Serializer\Handler\HandlerRegistryInterface; |
|
16
|
|
|
use JMS\Serializer\SerializerBuilder; |
|
17
|
|
|
use JMS\Serializer\SerializerInterface; |
|
18
|
|
|
use Xabbuh\XApi\Serializer\Event\ActorEventSubscriber; |
|
19
|
|
|
use Xabbuh\XApi\Serializer\Event\DocumentDataWrapper; |
|
20
|
|
|
use Xabbuh\XApi\Serializer\Event\ObjectEventSubscriber; |
|
21
|
|
|
use Xabbuh\XApi\Serializer\Event\SetSerializedTypeEventSubscriber; |
|
22
|
|
|
use Xabbuh\XApi\Serializer\Handler\DocumentDataUnwrapper; |
|
23
|
|
|
|
|
24
|
|
|
/** |
|
25
|
|
|
* Entry point to setup the {@link \JMS\Serializer\Serializer JMS Serializer} |
|
26
|
|
|
* for the Experience API. |
|
27
|
|
|
* |
|
28
|
|
|
* @author Christian Flothmann <[email protected]> |
|
29
|
|
|
*/ |
|
30
|
|
|
class Serializer |
|
31
|
|
|
{ |
|
32
|
|
|
/** |
|
33
|
|
|
* Returns the directory containing the Serializer metadata. |
|
34
|
|
|
* |
|
35
|
|
|
* @return string The metadata directory |
|
36
|
|
|
*/ |
|
37
|
|
|
public static function getMetadataDirectory() |
|
38
|
|
|
{ |
|
39
|
|
|
return __DIR__.'/../metadata'; |
|
40
|
|
|
} |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* Registers serialization metadata for the xAPI models on a SerializerBuilder. |
|
44
|
|
|
* |
|
45
|
|
|
* @param SerializerBuilder $builder The SerializerBuilder |
|
46
|
|
|
*/ |
|
47
|
|
|
public static function registerXApiMetadata(SerializerBuilder $builder) |
|
48
|
|
|
{ |
|
49
|
|
|
$builder->addMetadataDir(static::getMetadataDirectory(), 'Xabbuh\XApi\Model'); |
|
50
|
|
|
} |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Registers event subscribers for the xAPI models on a SerializerBuilder. |
|
54
|
|
|
* |
|
55
|
|
|
* @param SerializerBuilder $builder The SerializerBuilder |
|
56
|
|
|
*/ |
|
57
|
|
|
public static function registerXApiEventSubscriber(SerializerBuilder $builder) |
|
58
|
|
|
{ |
|
59
|
|
|
$builder->configureListeners(function (EventDispatcher $dispatcher) { |
|
60
|
|
|
$dispatcher->addSubscriber(new ActorEventSubscriber()); |
|
61
|
|
|
$dispatcher->addSubscriber(new DocumentDataWrapper()); |
|
62
|
|
|
$dispatcher->addSubscriber(new ObjectEventSubscriber()); |
|
63
|
|
|
$dispatcher->addSubscriber(new SetSerializedTypeEventSubscriber()); |
|
64
|
|
|
}); |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* Registers handlers for the xAPI models on a SerializerBuilder. |
|
69
|
|
|
* |
|
70
|
|
|
* @param SerializerBuilder $builder The SerializerBuilder |
|
71
|
|
|
*/ |
|
72
|
|
|
public static function registerXApiHandler(SerializerBuilder $builder) |
|
73
|
|
|
{ |
|
74
|
|
|
$builder->configureHandlers(function (HandlerRegistryInterface $handlerRegistry) { |
|
75
|
|
|
$handlerRegistry->registerSubscribingHandler(new DocumentDataUnwrapper()); |
|
76
|
|
|
}); |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* Registers serialization metadata and event subscribers for the xAPI |
|
81
|
|
|
* models on a SerializerBuilder. |
|
82
|
|
|
* |
|
83
|
|
|
* @param SerializerBuilder $builder The SerializerBuilder |
|
84
|
|
|
*/ |
|
85
|
|
|
public static function registerXApi(SerializerBuilder $builder) |
|
86
|
|
|
{ |
|
87
|
|
|
static::registerXApiMetadata($builder); |
|
88
|
|
|
static::registerXApiEventSubscriber($builder); |
|
89
|
|
|
static::registerXApiHandler($builder); |
|
90
|
|
|
} |
|
91
|
|
|
|
|
92
|
|
|
/** |
|
93
|
|
|
* Creates a SerializerBuilder with serialization metadata and serialization |
|
94
|
|
|
* event subscribers registered for the xAPI models. |
|
95
|
|
|
* |
|
96
|
|
|
* @return SerializerBuilder The SerializerBuilder |
|
97
|
|
|
*/ |
|
98
|
|
|
public static function createSerializerBuilder() |
|
99
|
|
|
{ |
|
100
|
|
|
$builder = SerializerBuilder::create(); |
|
101
|
|
|
static::registerXApi($builder); |
|
102
|
|
|
|
|
103
|
|
|
return $builder; |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* Creates a new Serializer. |
|
108
|
|
|
* |
|
109
|
|
|
* @return SerializerInterface The Serializer |
|
110
|
|
|
*/ |
|
111
|
|
|
public static function createSerializer() |
|
112
|
|
|
{ |
|
113
|
|
|
return static::createSerializerBuilder()->build(); |
|
114
|
|
|
} |
|
115
|
|
|
} |
|
116
|
|
|
|
php-xapi /
xapi-serializer
