如何修复或删除在过渡到 PHP 7 时出现的“...的声明应兼容”错误

如果您不把头埋在沙子里，尽最大努力不去碰仍然有效的旧代码，那么在许多情况下可以轻松或可行地进行修复。在下面的示例中，类B是 的子类A。下面的示例不一定会解决对替换原则(LSP) 的根本违反，但至少 PHP 不会抱怨它们。

1. 一个特殊的简单情况是子类方法有一个没有默认值的新参数。只需添加一个默认值并继续。例子：

   Declaration of B::foo() should be compatible with A::foo($bar = null)
   

   你会去做的：

   - public function foo()
   + public function foo($bar = null)
   

2. 如果限制被添加到子类方法，那么它们应该通过将它们转移到函数体来从方法签名中移除。

   Declaration of B::add(Baz $baz) should be compatible with A::add($n)
   

   您将要使用assert或抛出异常，具体取决于错误的严重程度。

   - public function add(Baz $baz)
   + public function add($baz)
     {
   +     assert($baz instanceof Baz);
   

   如果您看到方法签名中的限制仅用于文档目的，则将它们移至记录方法参数的位置，即注释。

   - protected function setValue(Baz $baz)
   + /**
   +  * @param Baz $baz
   +  */
   + protected function setValue($baz)
     {
   +     /** @var $baz Baz */
   

3. 如果子类方法的参数比超类少，并且您可以在超类中使参数可选，则用存根替换未使用的参数就足够了。

   Declaration of B::foo($param = '') should be compatible with A::foo($x = 40, $y = '')
   

   你会去做的：

   - public function foo($param = '')
   + public function foo($param = '', $_ = null)
   

4. 如果您看到子类中的某些参数已成为强制性要求，请从方法体中的方法签名中删除强制性要求。

   - protected function foo($bar)
   + protected function foo($bar = null)
     {
   +     if (empty($bar['key'])) {
   +         throw new Exception("Invalid argument");
   +     }
   

5. 有时，通过切换到使用 magic 来修改超类方法以删除可选参数可能更容易func_get_args。不要忘记记录这个虚拟参数。

     /**
   +  * @param callable $bar
      */
   - public function getFoo($bar = false)
   + public function getFoo()
     {
   +     if (func_num_args() && $bar = func_get_arg(0)) {
   +         // go on with $bar
   

   很明显，以这种方式删除多个参数可能很困难。

6. 如果您严重违反 Liskova 原则，一切都会变得有趣得多。如果您的参数不需要类型，那很容易。将所有参数设为可选，然后手动检查它们的存在就足够了。出现此错误：

   Declaration of B::save($key, $value) should be compatible with A::save($foo = NULL)
   

   你会去做的：

   - public function save($key, $value)
   + public function save($key = null, $value = null)
     {
   +     if (func_num_args() < 2) {
   +         throw new Exception("Required argument missing");
   +     }
   

   请注意，在这种情况下我们不能使用该函数func_get_args()，因为该函数不考虑具有默认值的参数。它们根本不会出现在返回值中。

7. 如果您有整个系列的类具有非常不同的接口，那么对它们进行更多更改可能是有意义的。让我们重命名违反替换原则的函数。然后添加一个代理方法以在单个子类中为异常类的整个层次结构调用新的、重命名的方法。

   function save($arg = null) // соответствует родителю
   {
       $args = func_get_args();
       return $this->saveExtra(...$args); // отличный интерфейс
   }
   

   这样你就不会消除对替换原则的违反（新类仍然不能像旧类一样被调用），但你将保存对函数签名中数据类型的各种检查。

PHP 5.0中提供的此类错误以及 PHP中类型提示的出现仍然存在。

唯一的问题是，一开始级别E_STRICT没有包含，E_ALL必须明确指定，然后，从 PHP 5.4 开始，它开始进入。之后，在 PHP 7.0 中，来自的错误E_STRICT 被重新分配给其他类型的错误。社区的共识是破坏基类契约是一件坏事，应该引起注意，因此该错误的级别为E_WARNING. 遗憾的是，当然，在 2004 年，他们更改了此检查的原始实现，根本不会产生此类错误E_COMPILE_ERROR。

好吧，谁能怪你和你的项目同事这么多年从来没有听过开发人员最亲密的朋友所说的话——你的编程语言的编译器。

接下来做什么：

• 使固定。重构这些错误需要很长时间，这表明代码的整体质量。他们可能甚至E_NOTICE没有打开它。
• 忽略日志错误
• 把头埋在沙子里，隐藏你的错误

幸运的是，没有设置“显示此类警告，但没有”。

问题中描述的特定错误可以移至运行时。基类有一个参数没有带默认值的类型，子类可以采用额外的可选方法参数，这并不违反类契约。

class ExampleParent 
{
    public function dosome ($c = null) {}
}
class Example extends ExampleParent 
{
    /*
     * переименовываем существующий метод
     * в будущем коде используем его вместо dosome
     */
    public function readablenamemethod(Foo $a, Bar $b, $c = 0) 
    {
    }
    /**
     * на его место ставим заглушку и вручную проверяем аргументы на совместимость 
     * @deprecated
     */
    public function dosome ($a = null, $b = null, $c = null) 
    {
        if ($a instanceof Foo and $b instanceof Bar) {
            // на такой набор параметров мы хотим реагировать
            return $this->readablenamemethod($a, $b, $c ?? 0);
        }
        throw new \InvalidArgumentException('wrong arguments given');
    }
}

如果基类需要一些类作为参数，而这个地方的孩子想要一个标量或一个完全不同的对象，那么将基类的契约从类型提示更改为运行时检查。

修复不是您编写的旧代码并不总是可能的。例如，从 PEAR 中获取一些库并享受。关于不知道测试的代码，我只是保持沉默。因此，您可以这样做：

if (PHP_MAJOR_VERSION >= 7) {
    set_error_handler(function ($errno, $errstr) {
       return strpos($errstr, 'Declaration of') === 0;
    }, E_WARNING);
}

此错误处理程序通过为所有以指定字符串开头的消息返回 true 来将警告标记为已处理。此类处理的警告不会写入日志。该代码仅适用于 PHP 7 及更高版本。

如果问题仅发生在可以通过目录或文件路径识别的代码的某些部分，那么您可以仅针对某些文件抑制这些错误：

set_error_handler(function ($errno, $errstr, $file) {
    return strpos($file, 'path/to/legacy/library') !== false &&
        strpos($errstr, 'Declaration of') === 0;
}, E_WARNING);