PHP 7 接口，返回类型提示和自我

Question

更新：PHP 7.4 现在does support covariance and contravariance 解决了这个问题中提出的主要问题。

---

我在 PHP 7 中使用返回类型提示时遇到了一些问题。我的理解是提示 : self 意味着您打算让实现类返回自身。因此，我在接口中使用了: self 来表示这一点，但是当我尝试实际实现接口时，出现了兼容性错误。

以下是我遇到的问题的简单演示：

interface iFoo
{
    public function bar (string $baz) : self;
}

class Foo implements iFoo
{

    public function bar (string $baz) : self
    {
        echo $baz . PHP_EOL;
        return $this;
    }
}

(new Foo ()) -> bar ("Fred") 
    -> bar ("Wilma") 
    -> bar ("Barney") 
    -> bar ("Betty");

预期的输出是：

弗雷德 威尔玛 巴尼 贝蒂

我实际得到的是：

PHP 致命错误：声明 Foo::bar(int $baz): Foo must be compatible with iFoo::bar(int $baz): iFoo in test.php on line 7

问题是 Foo 是 iFoo 的一个实现，所以据我所知，该实现应该与给定的接口完全兼容。我大概可以通过更改接口或实现类（或两者）来通过名称返回提示接口而不是使用self来解决这个问题，但我的理解是语义上self意味着“返回类的实例您刚刚调用了该方法”。因此，将其更改为接口在理论上意味着当我的意图是调用实例时，我可以返回实现接口的任何实例。

这是 PHP 中的疏忽还是经过深思熟虑的设计决定？如果是前者，是否有机会看到它在 PHP 7.1 中得到修复？如果不是，那么返回提示您的界面希望您返回刚刚调用该方法以进行链接的实例的正确方法是什么？

Answer 1

编者按：以下答案已过时。作为php PHP7.4.0，以下是完全合法的：

<?php
Interface I{
    public static function init(?string $url): self;
}
class C implements I{
    public static function init(?string $url): self{
        return new self();
    }
}
$o = C::init("foo");
var_dump($o);

• 3v4l：https://3v4l.org/VYbGn

原答案：

self 不引用实例，它引用当前类。接口无法指定必须返回相同的 instance - 以您尝试的方式使用 self 只会强制返回的实例属于同一类。

也就是说，PHP 中的返回类型声明必须是不变的，而您尝试的是协变的。

您对self 的使用相当于：

interface iFoo
{
    public function bar (string $baz) : iFoo;
}

class Foo implements iFoo
{

    public function bar (string $baz) : Foo  {...}
}

这是不允许的。

---

Return Type Declarations RFC 有this to say：

在继承期间声明的返回类型的强制执行是不变的；这意味着当子类型覆盖父方法时，子类型的返回类型必须与父方法完全匹配，并且不能省略。如果父级没有声明返回类型，则允许子级声明一个。

...

此 RFC 最初提出协变返回类型，但由于一些问题被更改为不变。将来可以添加协变返回类型。

---

目前至少你能做的最好是：

interface iFoo
{
    public function bar (string $baz) : iFoo;
}

class Foo implements iFoo
{

    public function bar (string $baz) : iFoo  {...}
}

Answer 2

如果你想从接口强制，那个方法会返回对象，但对象的类型不是接口的类型，而是类本身，那么你可以这样写：

interface iFoo {
    public function bar(string $baz): object;
}

class Foo implements iFoo {
    public function bar(string $baz): self  {...}
}

它从 PHP 7.4 开始工作。

Answer 3

PHP 8 将添加“静态返回类型”来解决您的问题。

查看此 RFC：https://wiki.php.net/rfc/static_return_type

Answer 4

这也可以是一个解决方案，你不在接口中明确定义返回类型，只在 PHPDoc 中，然后你可以在实现中定义特定的返回类型：

interface iFoo
{
    public function bar (string $baz);
}

class Foo implements iFoo
{
    public function bar (string $baz) : Foo  {...}
}

Answer 5

这在我看来是预期的行为。

只需将您的 Foo::bar 方法更改为返回 iFoo 而不是 self 即可。

解释：

接口中使用的self 表示“iFoo 类型的对象。”
实现中使用的self 表示“Foo 类型的对象。”

因此，接口和实现中的返回类型显然不一样。

其中一个 cmets 提到了 Java，以及您是否会遇到这个问题。答案是肯定的，如果 Java 允许你编写这样的代码，你也会遇到同样的问题——但它不允许。因为 Java 要求你使用类型的名称而不是 PHP 的 @ 987654329@ 快捷方式，你永远不会真正看到这个。 （请参阅here，了解 Java 中一个类似问题的讨论。）