php-xapi / xapi

Serializer/src/Serializer.php

<?php

/*
 * This file is part of the xAPI package.
 *
 * (c) Christian Flothmann <christian.flothmann@xabbuh.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Xabbuh\XApi\Serializer;

use JMS\Serializer\EventDispatcher\EventDispatcher;
use JMS\Serializer\Handler\HandlerRegistryInterface;
use JMS\Serializer\SerializerBuilder;
use JMS\Serializer\SerializerInterface;
use Xabbuh\XApi\Serializer\Event\ActorEventSubscriber;
use Xabbuh\XApi\Serializer\Event\DocumentDataWrapper;
use Xabbuh\XApi\Serializer\Event\ObjectEventSubscriber;
use Xabbuh\XApi\Serializer\Event\SetSerializedTypeEventSubscriber;
use Xabbuh\XApi\Serializer\Handler\DocumentDataUnwrapper;

/**
 * Entry point to setup the {@link \JMS\Serializer\Serializer JMS Serializer}
 * for the Experience API.
 *
 * @author Christian Flothmann <christian.flothmann@xabbuh.de>
 */
class Serializer
{
    /**
     * Returns the directory containing the Serializer metadata.
     *
     * @return string The metadata directory
     */
    public static function getMetadataDirectory()
    {
        return __DIR__.'/../metadata';
    }

    /**
     * Registers serialization metadata for the xAPI models on a SerializerBuilder.
     *
     * @param SerializerBuilder $builder The SerializerBuilder
     */
    public static function registerXApiMetadata(SerializerBuilder $builder)
    {
        $builder->addMetadataDir(static::getMetadataDirectory(), 'Xabbuh\XApi\Model');
    }

    /**
     * Registers event subscribers for the xAPI models on a SerializerBuilder.
     *
     * @param SerializerBuilder $builder The SerializerBuilder
     */
    public static function registerXApiEventSubscriber(SerializerBuilder $builder)

This method seems to be duplicated in your project.

    {
        $builder->configureListeners(function (EventDispatcher $dispatcher) {
            $dispatcher->addSubscriber(new ActorEventSubscriber());
            $dispatcher->addSubscriber(new DocumentDataWrapper());
            $dispatcher->addSubscriber(new ObjectEventSubscriber());
            $dispatcher->addSubscriber(new SetSerializedTypeEventSubscriber());
        });
    }

    /**
     * Registers handlers for the xAPI models on a SerializerBuilder.
     *
     * @param SerializerBuilder $builder The SerializerBuilder
     */
    public static function registerXApiHandler(SerializerBuilder $builder)
    {
        $builder->configureHandlers(function (HandlerRegistryInterface $handlerRegistry) {
            $handlerRegistry->registerSubscribingHandler(new DocumentDataUnwrapper());
        });
    }

    /**
     * Registers serialization metadata and event subscribers for the xAPI
     * models on a SerializerBuilder.
     *
     * @param SerializerBuilder $builder The SerializerBuilder
     */
    public static function registerXApi(SerializerBuilder $builder)
    {
        static::registerXApiMetadata($builder);
        static::registerXApiEventSubscriber($builder);
        static::registerXApiHandler($builder);
    }

    /**
     * Creates a SerializerBuilder with serialization metadata and serialization
     * event subscribers registered for the xAPI models.
     *
     * @return SerializerBuilder The SerializerBuilder
     */
    public static function createSerializerBuilder()
    {
        $builder = SerializerBuilder::create();
        static::registerXApi($builder);

        return $builder;
    }

    /**
     * Creates a new Serializer.
     *
     * @return SerializerInterface The Serializer
     */
    public static function createSerializer()
    {
        return static::createSerializerBuilder()->build();
    }
}