File size: 2.47Kb
<?php
/**
* @brief Login Exception Class
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @since 26 Mar 2013
*/
namespace IPS\Login;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* @brief Login Exception Class
* @note If two login handlers produce different exceptions, the one with the higher code is shown. For example: if internal database returns "NO_ACCOUNT", but external returns "BAD_PASSWORD", the message the user needs to see is of course "Password incorrect" (rather than "Account does not exist").
*/
class _Exception extends \DomainException
{
/**
* @brief No account found
*/
const NO_ACCOUNT = 1;
/**
* @brief An internal error occurred
*/
const INTERNAL_ERROR = 2;
/**
* @brief Spam service denied new account creation
*/
const REGISTRATION_DENIED_BY_SPAM_SERVICE = 3;
/**
* @brief Registrations are disabled
*/
const REGISTRATION_DISABLED = 4;
/**
* @brief The password was not correct
*/
const BAD_PASSWORD = 5;
/**
* @brief The account should be merged with a local account
*/
const MERGE_SOCIAL_ACCOUNT = 6;
/**
* @brief The account is locked
*/
const ACCOUNT_LOCKED = 7;
/**
* @brief The local account is already merged with a different account from this handler
*/
const LOCAL_ACCOUNT_ALREADY_MERGED = 8;
/**
* @brief Member
*/
public $member = NULL;
/**
* @brief Handler
*/
public $handler = NULL;
/**
* @brief Details
*/
public $details = NULL;
/**
* Constructor
*
* @param string $message Message
* @param int $code Code
* @param \Exception|NULL $previous Previous Exception
* @param \IPS\Member|null $member Member
* @return void
*/
public function __construct( $message, $code=NULL, $previous=NULL, $member=NULL )
{
parent::__construct( $message, $code, $previous );
$this->member = $member;
}
/**
* Allow the code to be adjusted
*
* @note This is used when a MERGE_SOCIAL_ACCOUNT is thrown and we need to change it to a LOCAL_ACCOUNT_ALREADY_MERGED exception
* @param int $code New code
* @return void
*/
public function setCode( $code )
{
$this->code = $code;
}
}