Symfony getUser 类型提示

Question

我发现必须在 getUser 上不断使用 @var 有点烦人。看起来很草率。

所以我正在考虑开始使用它来代替

<?php

// in the controller
$user = Customer::isCustomer($this->getUser());

// in the entity
/**
 * @param Customer $user
 *
 * @return Customer
 */
public static function isCustomer(Customer $user)
{
    return $user;
}

这是个好主意吗？馊主意？可怕的想法？

Answer 1

在这种情况下，类型提示是更好的选择。

为什么要通过手动添加检查而不是向参数添加简单的类型提示来编写更多代码。

代表两个条件的四行代码给出的结果完全相同：

/**
 * @param Customer|null  $user
 *
 * @return Customer|null
 */
public static function isCustomer(Customer $user = null)
{
    // If $user is null, it works
    // If $user is a Customer instance, it works
    // If it's other, an exception is thrown

    return $user;
}

类型提示优化并提高代码的可读性。 这是 symfony2、php 等中的约定。

它通常用作您和您的方法的约束（或合同）。

另外，接口或抽象类对参数添加要求是唯一的选择，因为它们没有主体，因此无法编写条件。

更新

在 SensioLabs Insight 中，对象类型提示使用以下消息表示警告：

参数user，它是一个对象，应该是类型提示的。

由于使用了动词should，我认为这不是强制性要求，只是一个很好的做法，以防它不会造成任何问题。

此外，您可以使用您给出的示例，而不会使您的代码变得糟糕。