InvalidException.php

<?php
namespace Equip\Auth\Exception;

use Exception;

/**
 * Exception that occurs when a user specifies an authentication token that is
 * invalid or credentials that are not recognized to obtain an authentication
 * token.
 */
class InvalidException extends AuthException
{
    const CODE = 403;

    /**
     * @param string $token
     * @param Exception $previous
     */
    public static function tokenExpired($token, Exception $previous = null)
    {
        return new static(
            sprintf('Provided auth token `%s` is expired', $token),
            static::CODE,
            $previous
        );
    }

    /**
     * @param string $token
     * @param Exception $previous
     */
    public static function tokenUnparseable($token, Exception $previous = null)
    {
        return new static(
            sprintf('Provided auth token `%s` could not be parsed', $token),
            static::CODE,
            $previous
        );
    }

    /**
     * @param string $token
     * @param Exception $previous
     */
    public static function invalidSignature($token, Exception $previous = null)
    {
        return new static(
            sprintf('Signature of provided auth token `%s` is not valid', $token),
            static::CODE,
            $previous
        );
    }

    /**
     * @param string $token
     * @param Exception $previous
     */
    public static function invalidToken($token, Exception $previous = null)
    {
        return new static(
            sprintf('Provided auth token `%s` is expired or otherwise invalid', $token),
            static::CODE,
            $previous
        );
    }

    /**
     * @param string $identifier
     * @param Exception $previous
     */
    public static function unknownIdentifier($identifier, Exception $previous = null)
    {
        return new static(
            sprintf('Specified identifier `%s` is not recognized', $identifier),
            static::CODE,
            $previous
        );
    }

    /**
     * @param string $identifier
     * @param Exception $previous
     */
    public static function incorrectPassword($identifier, Exception $previous = null)
    {
        return new static(
            sprintf('Incorrect password specified for identifier `%s`', $identifier),
            static::CODE,
            $previous
        );
    }
}