php-xapi / xapi-client

Api/StatementsApiClient.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\StatementResultSerializerInterface;
use Xabbuh\XApi\Serializer\StatementSerializerInterface;
use Xabbuh\XApi\Model\Actor;
use Xabbuh\XApi\Model\Statement;
use Xabbuh\XApi\Model\StatementResult;
use Xabbuh\XApi\Model\StatementsFilter;

/**
 * Client to access the statements API of an xAPI based learning record store.
 *
 * @author Christian Flothmann <christian.flothmann@xabbuh.de>
 */
class StatementsApiClient extends ApiClient implements StatementsApiClientInterface
{
    /**
     * @var StatementSerializerInterface
     */
    private $statementSerializer;

    /**
     * @var StatementResultSerializerInterface
     */
    private $statementResultSerializer;

    /**
     * @var ActorSerializerInterface
     */
    private $actorSerializer;

    /**
     * @param HandlerInterface                   $requestHandler            The HTTP request handler
     * @param string                             $version                   The xAPI version
     * @param StatementSerializerInterface       $statementSerializer       The statement serializer
     * @param StatementResultSerializerInterface $statementResultSerializer The statement result serializer
     * @param ActorSerializerInterface           $actorSerializer           The actor serializer
     */
    public function __construct(
        HandlerInterface $requestHandler,
        $version,
        StatementSerializerInterface $statementSerializer,
        StatementResultSerializerInterface $statementResultSerializer,
        ActorSerializerInterface $actorSerializer
    ) {
        parent::__construct($requestHandler, $version);
        $this->statementSerializer = $statementSerializer;
        $this->statementResultSerializer = $statementResultSerializer;
        $this->actorSerializer = $actorSerializer;
    }

    /**
     * {@inheritDoc}
     */
    public function storeStatement(Statement $statement)
    {
        if (null !== $statement->getId()) {
            return $this->doStoreStatements(

The expression $this->doStoreStatements($statement, 'put', array('statementId' => $statement->getId()), 204); of type array|Xabbuh\XApi\Model\Statement adds the type array to the return on line 71 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::storeStatement of type Xabbuh\XApi\Model\Statement.

                $statement,
                'put',
                array('statementId' => $statement->getId()),
                204
            );
        } else {
            return $this->doStoreStatements($statement);

The expression $this->doStoreStatements($statement); of type array|Xabbuh\XApi\Model\Statement adds the type array to the return on line 78 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::storeStatement of type Xabbuh\XApi\Model\Statement.

        }
    }

    /**
     * {@inheritDoc}
     */
    public function storeStatements(array $statements)
    {
        // check that only Statements without ids will be sent to the LRS
        foreach ($statements as $statement) {
            /** @var Statement $statement */

            $isStatement = is_object($statement) && $statement instanceof Statement;

            if (!$isStatement || null !== $statement->getId()) {
                throw new \InvalidArgumentException('API can only handle statements without ids');
            }
        }

        return $this->doStoreStatements($statements);

The expression $this->doStoreStatements($statements); of type array|Xabbuh\XApi\Model\Statement adds the type Xabbuh\XApi\Model\Statement to the return on line 98 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::storeStatements of type Xabbuh\XApi\Model\Statement[].

    }

    /**
     * {@inheritDoc}
     */
    public function voidStatement(Statement $statement, Actor $actor)
    {
        return $this->storeStatement($statement->getVoidStatement($actor));
    }

    /**
     * {@inheritDoc}
     */
    public function getStatement($statementId)
    {
        return $this->doGetStatements('statements', array('statementId' => $statementId));

The expression $this->doGetStatements('statements', array('statementId' => $statementId)); of type Xabbuh\XApi\Model\Statement|Xabbuh\XApi\Model\StatementResult adds the type Xabbuh\XApi\Model\StatementResult to the return on line 114 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::getStatement of type Xabbuh\XApi\Model\Statement.

    }

    /**
     * {@inheritDoc}
     */
    public function getVoidedStatement($statementId)
    {
        return $this->doGetStatements('statements', array('voidedStatementId' => $statementId));

The expression $this->doGetStatements('statements', array('voidedStatementId' => $statementId)); of type Xabbuh\XApi\Model\Statement|Xabbuh\XApi\Model\StatementResult adds the type Xabbuh\XApi\Model\StatementResult to the return on line 122 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::getVoidedStatement of type Xabbuh\XApi\Model\Statement.

    }

    /**
     * {@inheritDoc}
     */
    public function getStatements(StatementsFilter $filter = null)
    {
        $urlParameters = array();

        if (null !== $filter) {
            $urlParameters = $filter->getFilter();
        }

        // the Agent must be JSON encoded
        if (isset($urlParameters['agent'])) {
            $urlParameters['agent'] = $this->actorSerializer->serializeActor($urlParameters['agent']);
        }

        return $this->doGetStatements('statements', $urlParameters);

The expression $this->doGetStatements('statements', $urlParameters); of type Xabbuh\XApi\Model\Statement|Xabbuh\XApi\Model\StatementResult adds the type Xabbuh\XApi\Model\Statement to the return on line 141 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::getStatements of type Xabbuh\XApi\Model\StatementResult.

    }

    /**
     * {@inheritDoc}
     */
    public function getNextStatements(StatementResult $statementResult)
    {
        return $this->doGetStatements($statementResult->getMoreUrlPath());

The expression $this->doGetStatements($statementResult->getMoreUrlPath()); of type Xabbuh\XApi\Model\Statement|Xabbuh\XApi\Model\StatementResult adds the type Xabbuh\XApi\Model\Statement to the return on line 149 which is incompatible with the return type declared by the interface Xabbuh\XApi\Client\Api\StatementsApiClientInterface::getNextStatements of type Xabbuh\XApi\Model\StatementResult.

    }

    /**
     * @param Statement|Statement[] $statements
     * @param string                $method
     * @param string[]              $parameters
     * @param int                   $validStatusCode
     *
     * @return Statement|Statement[] The created statement(s)
     */
    private function doStoreStatements($statements, $method = 'post', $parameters = array(), $validStatusCode = 200)
    {
        if (is_array($statements)) {
            $serializedStatements = $this->statementSerializer->serializeStatements($statements);
        } else {
            $serializedStatements = $this->statementSerializer->serializeStatement($statements);
        }

        $request = $this->requestHandler->createRequest(
            $method,
            'statements',
            $parameters,
            $serializedStatements
        );
        $response = $this->requestHandler->executeRequest($request, array($validStatusCode));
        $statementIds = json_decode($response->getBody(true));

        if (is_array($statements)) {
            /** @var Statement[] $statements */
            $createdStatements = array();

            foreach ($statements as $index => $statement) {
                $createdStatements[] = new Statement(
                    $statementIds[$index],
                    $statement->getActor(),
                    $statement->getVerb(),
                    $statement->getObject(),
                    $statement->getResult()
                );
            }

            return $createdStatements;
        } else {
            /** @var Statement $statements */

            if (200 === $validStatusCode) {
                return new Statement(
                    $statementIds[0],
                    $statements->getActor(),
                    $statements->getVerb(),
                    $statements->getObject(),
                    $statements->getResult()
                );
            } else {
                return new Statement(
                    $statements->getId(),
                    $statements->getActor(),
                    $statements->getVerb(),
                    $statements->getObject(),
                    $statements->getResult()
                );
            }
        }
    }

    /**
     * Fetch one or more Statements.
     *
     * @param string $url           URL to request
     * @param array  $urlParameters URL parameters
     *
     * @return Statement|StatementResult
     */
    private function doGetStatements($url, array $urlParameters = array())
    {
        $request = $this->requestHandler->createRequest('get', $url, $urlParameters);
        $response = $this->requestHandler->executeRequest($request, array(200));

        if (isset($urlParameters['statementId']) || isset($urlParameters['voidedStatementId'])) {
            return $this->statementSerializer->deserializeStatement($response->getBody(true));
        } else {
            return $this->statementResultSerializer->deserializeStatementResult($response->getBody(true));
        }
    }
}