PHP：一种方法的类型提示以将一些对象变量声明为返回

Question

我正在使用 PHPStorm IDE。我有一个方法可以从我的 mysql 数据库中获取几列并返回一个包含这些值的对象。是否有可能编写一个 PHPDoc 注释，它是类型提示特定值的类型？所以如果我输入

self::getCommissionFromCacheOrDb($provider_id, $type, $platform)->

IDE 将显示一些变量，我已在方法上方的 PHPDoc 注释中声明了这些变量。

f.e.方法。

public static getValuesFromDb($provider_id){
            $data = self::find()->where(['provider_id' => $provider_id,
                    'revision' => '0000-00-00 00:00:00',
                    'platform' => $platform,
                    'type' => $type])
                ->select(['commission',
                        'direct_commission',
                        'super_commission',
                        'super_commission_maturity',
                        'valid_from',
                        'valid_to'])
                ->one();
            return $data;
}

我可以想象一些 PHPDoc 块，例如

/**
 * @return $direct_commission
 * @return @super_commission
 * @return @super_commission
 * @return @valid_from
 * @return @valid_to
 */

但不幸的是，这不起作用。是否真的必须为每个变量编写一个 getter 和 setter，或者这可以通过任何 PHPDoc 方式完成吗？

任何帮助将不胜感激。

谢谢

Answer 1

基本规则是：

• 只有一个@return声明
• 没有变量名
• 数据类型原样（不使用@前缀）

也就是说，如果您的对象是临时创建的，那么您无能为力。您可能需要创建一个空类来完成代码。例如：

class Comission{
    public $commission;
    public $direct_commission;
    public $super_commission;
    public $super_commission_maturity;
    public $valid_from;
    public $valid_to;
}

...和：

/**
 * @return Comission
 */

PhpStorm 本身大量使用这个技巧来记录内置类和函数：

/**
 * Representation of date and time.
 * @link http://php.net/manual/en/class.datetime.php
 */
class DateTime implements DateTimeInterface {
    const ATOM = 'Y-m-d\TH:i:sP';
    const COOKIE = 'l, d-M-y H:i:s T';
...

Answer 2

我不确定 PHPStorm，但 Netbeans 接受管道符号：

/**
 * 
 * @return A|B
 */