方法返回状态:bool,string,const ...(PHP)

Question

这个问题:从Java中的方法返回状态标志和消息的最佳方法与我的相似,但我会用PHP而不是Java(这可能会略有不同).

问题:

有一种方法可以有一个成功的结果(这可能会变成更成功的结果)或一个"有问题"的结果.后者意味着操作失败,但知道原因也很重要.想象一下Authentication类的方法:

public function login($name, $password)
{
    if (successful_authentication)
    {
        report success
    }
    else
    {
        report failure, explain why (e.g. wrong name/pass, user banned)
    }
}

为成功和失败回报真假都是微不足道的,但如何报告失败的原因呢？

可能的解决方案:

• 返回true或false并编写另一个方法(getStatus())来获取特定问题:这对我来说有点尴尬
• 使用例外:因为禁止用户并不例外(如果用户在键入时会因此网站上的另一位作者而死,例外情况就是例外)在这些情况下使用异常将是完全错误的(但是如果查询失败,方法可能抛出数据库异常)

• 成功时返回true,失败时返回一个字符串,错误代码表示问题:使用PHP可以通过这种方式获得漂亮的干净块,如下所示:

  $loginStatus = $auth->login('name', 'pass');
  if ($loginStatus === true)
  {
      doSomething();
  }
  else
  {
      if ($loginStatus == 'wrong_login_data')
      ...
      elseif ($loginStatus == 'banned')
      ...
      // or with an array full of error messages:
      echo $erroMessages[$loginStatus];
  }
  

• 返回一般状态(状态)对象:非常优雅的解决方案以及面向未来的(如果状态数量不同或以后应该返回其他数据,则没有问题),也许是最好的一个:

  $loginStatus = $auth->login('name', 'pass')
  if ($loginStatus->isSuccess)
  ...
  else
      echo $errorMessages[$loginStatus->errorCode]; // $errorMessages as by the previous example
  

• 以上两种情况中的任何一种,但不是普通字符串而是类常量:

  $loginStatus = $auth->login('name', 'pass')
  if ($loginStatus->isSuccess)
  ...
  elseif ($loginStatus->errorCode == Auth::ERR_USER_BANNED)
  ...
  

  有了这个,就没有必要在文档中解释错误代码,也会觉得更"自然"(至少对我而言).

问题:

你会用什么(上述的或其他任何解决方案)？从长远来看,已经证明是一种好方法？

先感谢您!

Answer 1

从我记事起，PEAR 就一直这样做。所以这是一个经过验证的方法。

class LoginError {
    private $reason;

    public function __construct($reason)
    {
        $this->reason = $reason;
    }

    public function getReason()
    {
        return $this->reason;
    }
}

function isError($response)
{
    return ($response instanceof LoginError);
}

public function login($name, $password)
{
    if (successful_authentication)
    {
        return true;
    }
    else
    {
        return new LoginError('The password is incorrect');
    }
}


$loginStatus = login('name', 'pass');
if (!isError($loginStatus))
{
    doSomething();
}
else
{
    echo $loginStatus->getReason();
}