MessageApp\Parser\Exception\MessageParserException

Complexity

Total Complexity

14

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	1	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	1
A	getCodeName()	0	4	1
A	cannotJoinMultipleUsers()	0	4	1
A	cannotJoinUnregisteredUser()	0	4	1
A	cannotJoinUserWithoutAGame()	0	4	1
A	cannotJoinYourself()	0	4	1
A	cannotJoinIfGameAlreadyRunning()	0	4	1
A	cannotParseMessage()	0	4	1
A	cannotStartGameUserIsNotIn()	0	4	1
A	cannotLeaveGameUserIsNotIn()	0	4	1
A	cannotFindGameForUser()	0	8	1
A	cannotCreateMultipleGames()	0	4	1
A	invalidUser()	0	4	1
A	getUser()	0	4	1

<?php

namespace MessageApp\Parser\Exception;

use MessageApp\Parser\ParsingUser;

class MessageParserException extends \Exception
{
    const JOIN_MULTIPLE_USERS = 'game.parser.exception.join.multiple-users';
    const JOIN_UNREGISTERED_USER = 'game.parser.exception.join.unregistered-users';
    const JOIN_NO_GAME = 'game.parser.exception.join.no-game';
    const JOIN_YOURSELF = 'game.parser.exception.join.yourself';
    const JOIN_GAME_RUNNING = 'game.parser.exception.join.game-running';
    const START_NOT_IN = 'game.parser.exception.start.not-in';
    const LEAVE_NOT_IN = 'game.parser.exception.leave.not-in';
    const CREATE_MULTIPLE = 'game.parser.exception.create.multiple';
    const GAME_NOT_FOUND = 'game.parser.exception.game-not-found';
    const INVALID_USER = 'parser.exception.invalid-user';
    const PARSE_ERROR = 'parser.exception.parse-error';

    /**
     * @var ParsingUser
     */
    private $user;

    /**
     * @var string
     */
    private $codeName;

    /**
     * Constructor
     *
     * @param ParsingUser $user
     * @param string      $codeName
     * @param string      $message
     * @param int         $code
     * @param \Exception  $previous
     */
    public function __construct(
        ParsingUser $user = null,
        $codeName = null,
        $message = '',
        $code = 0,
        \Exception $previous = null
    ) {
        parent::__construct($message, $code, $previous);
        $this->codeName = $codeName;
        $this->user = $user;
    }

    /**
     * Returns the user
     *
     * @return ParsingUser
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * @return string
     */
    public function getCodeName()
    {
        return $this->codeName;
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotJoinMultipleUsers(ParsingUser $user)
    {
        return new self($user, self::JOIN_MULTIPLE_USERS, 'You have to provide one (and only one) user to join!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotJoinUnregisteredUser(ParsingUser $user)
    {
        return new self($user, self::JOIN_UNREGISTERED_USER, 'You cannot join a user who is not registered!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotJoinUserWithoutAGame(ParsingUser $user)
    {
        return new self($user, self::JOIN_NO_GAME, 'You cannot join a player with no game!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotJoinYourself(ParsingUser $user)
    {
        return new self($user, self::JOIN_YOURSELF, 'You cannot join yourself!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotJoinIfGameAlreadyRunning(ParsingUser $user)
    {
        return new self($user, self::JOIN_GAME_RUNNING, 'You already have a game running!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotParseMessage(ParsingUser $user)
    {
        return new self($user, self::PARSE_ERROR, 'Could not parse message!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotStartGameUserIsNotIn(ParsingUser $user)
    {
        return new self($user, self::START_NOT_IN, 'You cannot start a game you are not in!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotLeaveGameUserIsNotIn(ParsingUser $user)
    {
        return new self($user, self::LEAVE_NOT_IN, 'You cannot leave a game you are not in!');
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotFindGameForUser(ParsingUser $user)
    {
        return new self(
            $user,
            self::GAME_NOT_FOUND,
            'The game or associated player was not found. Try starting/joining a game first.'
        );
    }

    /**
     * @param ParsingUser $user
     *
     * @return MessageParserException
     */
    public static function cannotCreateMultipleGames(ParsingUser $user)
    {
        return new self($user, self::CREATE_MULTIPLE, 'You already have a game running!');
    }

    /**
     * @param ParsingUser $user
     * @return MessageParserException
     */
    public static function invalidUser(ParsingUser $user)
    {
        return new self($user, self::INVALID_USER, 'User is not valid!');
    }
}