Xabbuh\XApi\Model\Result

Complexity

Total Complexity

25

Size/Duplication

Total Lines	226
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	1

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	withScore()	0	7	1
A	withSuccess()	0	7	1
A	withCompletion()	0	7	1
A	withResponse()	0	7	1
A	withDuration()	0	7	1
A	withExtensions()	0	7	1
A	getScore()	0	4	1
A	getSuccess()	0	4	1
A	getCompletion()	0	4	1
A	getResponse()	0	4	1
A	getDuration()	0	4	1
A	getExtensions()	0	4	1
C	equals()	0	36	12

<?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\Model;

/**
 * An {@link Actor Actor's} outcome related to the {@link Statement} in which
 * it is included.
 *
 * @author Christian Flothmann <christian.flothmann@xabbuh.de>
 */
final class Result
{
    /**
     * @var Score The score
     */
    private $score;

    /**
     * @var bool Indicates whether or not the attempt was successful
     */
    private $success;

    /**
     * @var bool Indicates whether or not the Activity was completed
     */
    private $completion;

    /**
     * @var string A response for the given Activity
     */
    private $response;

    /**
     * @var string Period of time over which the Activity was performed
     */
    private $duration;

    /**
     * @var Extensions|null Extensions associated with this result
     */
    private $extensions;

    /**
     * @param Score|null      $score
     * @param bool|null       $success
     * @param bool|null       $completion
     * @param string|null     $response
     * @param string|null     $duration
     * @param Extensions|null $extensions
     */
    public function __construct(Score $score = null, $success = null, $completion = null, $response = null, $duration = null, Extensions $extensions = null)
    {
        $this->score = $score;
        $this->success = $success;
        $this->completion = $completion;
        $this->response = $response;
        $this->duration = $duration;
        $this->extensions = $extensions;
    }

    public function withScore(Score $score = null)
    {
        $result = clone $this;
        $result->score = $score;

        return $result;
    }

    /**
     * @param bool|null $success
     *
     * @return Result
     */
    public function withSuccess($success)
    {
        $result = clone $this;
        $result->success = $success;

        return $result;
    }

    /**
     * @param bool|null $completion
     *
     * @return Result
     */
    public function withCompletion($completion)
    {
        $result = clone $this;
        $result->completion = $completion;

        return $result;
    }

    /**
     * @param string|null $response
     *
     * @return Result
     */
    public function withResponse($response)
    {
        $result = clone $this;
        $result->response = $response;

        return $result;
    }

    /**
     * @param string|null $duration
     *
     * @return Result
     */
    public function withDuration($duration)
    {
        $result = clone $this;
        $result->duration = $duration;

        return $result;
    }

    public function withExtensions(Extensions $extensions = null)
    {
        $result = clone $this;
        $result->extensions = $extensions;

        return $result;
    }

    /**
     * Returns the user's score.
     *
     * @return Score The score
     */
    public function getScore()
    {
        return $this->score;
    }

    /**
     * Returns whether or not the user finished a task successfully.
     *
     * @return bool True if the user finished an exercise successfully, false
     *              otherwise
     */
    public function getSuccess()
    {
        return $this->success;
    }

    /**
     * Returns the completion status.
     *
     * @return bool $completion True, if the Activity was completed, false
     *                          otherwise
     */
    public function getCompletion()
    {
        return $this->completion;
    }

    /**
     * Returns the response.
     *
     * @return string The response
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * Returns the period of time over which the Activity was performed.
     *
     * @return string The duration
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * Returns the extensions associated with the result.
     *
     * @return Extensions|null The extensions
     */
    public function getExtensions()
    {
        return $this->extensions;
    }

    /**
     * Checks if another result is equal.
     *
     * Two results are equal if and only if all of their properties are equal.
     *
     * @param Result $result The result to compare with
     *
     * @return bool True if the results are equal, false otherwise
     */
    public function equals(Result $result)
    {
        if (null !== $this->score xor null !== $result->score) {
            return false;
        }

        if (null !== $this->score && !$this->score->equals($result->score)) {
            return false;
        }

        if ($this->success !== $result->success) {
            return false;
        }

        if ($this->completion !== $result->completion) {
            return false;
        }

        if ($this->response !== $result->response) {
            return false;
        }

        if ($this->duration !== $result->duration) {
            return false;
        }

        if (null !== $this->extensions xor null !== $result->extensions) {
            return false;
        }

        if (null !== $this->extensions && null !== $result->extensions && !$this->extensions->equals($result->extensions)) {
            return false;
        }

        return true;
    }
}