php-xapi / xapi-client

Api/AgentProfileApiClient.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\Client\Api;

use Xabbuh\XApi\Client\Request\HandlerInterface;
use Xabbuh\XApi\Serializer\ActorSerializerInterface;
use Xabbuh\XApi\Serializer\DocumentDataSerializerInterface;
use Xabbuh\XApi\Model\AgentProfile;
use Xabbuh\XApi\Model\AgentProfileDocument;

/**
 * Client to access the agent profile API of an xAPI based learning record
 * store.
 *
 * @author Christian Flothmann <christian.flothmann@xabbuh.de>
 */
class AgentProfileApiClient extends DocumentApiClient implements AgentProfileApiClientInterface
{
    /**
     * @var ActorSerializerInterface
     */
    private $actorSerializer;

    /**
     * @param HandlerInterface                $requestHandler         The HTTP request handler
     * @param string                          $version                The xAPI version
     * @param DocumentDataSerializerInterface $documentDataSerializer The document data serializer
     * @param ActorSerializerInterface        $actorSerializer        The actor serializer
     */
    public function __construct(
        HandlerInterface $requestHandler,
        $version,
        DocumentDataSerializerInterface $documentDataSerializer,
        ActorSerializerInterface $actorSerializer
    ) {
        parent::__construct($requestHandler, $version, $documentDataSerializer);

        $this->actorSerializer = $actorSerializer;
    }

    /**
     * {@inheritDoc}
     */
    public function createOrUpdateDocument(AgentProfileDocument $document)

This method seems to be duplicated in your project.

    {
        $profile = $document->getAgentProfile();
        $this->doStoreDocument('post', 'agents/profile', array(
            'agent' => $this->actorSerializer->serializeActor($profile->getAgent()),
            'profileId' => $profile->getProfileId(),
        ), $document);
    }

    /**
     * {@inheritDoc}
     */
    public function createOrReplaceDocument(AgentProfileDocument $document)

This method seems to be duplicated in your project.

    {
        $profile = $document->getAgentProfile();
        $this->doStoreDocument('put', 'agents/profile', array(
            'agent' => $this->actorSerializer->serializeActor($profile->getAgent()),
            'profileId' => $profile->getProfileId(),
        ), $document);
    }

    /**
     * {@inheritDoc}
     */
    public function deleteDocument(AgentProfile $profile)
    {
        $this->doDeleteDocument('agents/profile', array(
            'agent' => $this->actorSerializer->serializeActor($profile->getAgent()),
            'profileId' => $profile->getProfileId(),
        ));
    }

    /**
     * {@inheritDoc}
     */
    public function getDocument(AgentProfile $profile)

This method seems to be duplicated in your project.

    {
        /** @var \Xabbuh\XApi\Model\DocumentData $documentData */
        $documentData = $this->doGetDocument('agents/profile', array(
            'agent' => $this->actorSerializer->serializeActor($profile->getAgent()),
            'profileId' => $profile->getProfileId(),
        ));

        return new AgentProfileDocument($profile, $documentData);
    }
}