PhpStorm:如何判断数组成员的var类型?

时间:2016-09-29 22:22:20

标签: php ide phpstorm intellisense phpdoc

我使用PhpStorm 2016.2.1 IDE。我有一个类型化的数组(所有成员都是相同的,已知类),我希望IDE知道类型,所以我可以帮助我解决自动完成/智能感知。

class MyClass{    
     /**
     * @var array
     */
    public $userArray;

    public addUser($uid){ $this->$userArray[$uid] = new User($uid); }

    public processUser($uid){

        $oUser = $this->$userArray[$uid];
            //since the PHP array can contain anything, the IDE makes 
            //no assumption about what data type $oUser is. How to let it 
            //know that it's of type User?
    }
}

我试过......

 /**
 * @var User
 */
public $oUser = ...;

 /**
 * @type User
 */
public $oUser = ...;

到目前为止,我唯一能做的就是使用getter函数:

/**
* @return User
*/
function getUser($uid){ return $this->$userArray[$uid]; }

function processUser($uid){
    //now the IDE knows the type of $oUser
    $oUser = $this->getUser($uid);
}

但是使用不需要的函数调用来减慢脚本只是为了获得更好的IDE支持似乎是一个坏主意。

知道如何让PhpStorm知道变量的类型吗?甚至更好:如何告诉它该数组的PHPDoc元数据中将包含哪种类型的数据?

1 个答案:

答案 0 :(得分:4)

对于类变量,如您所知,您可以简单地执行

@var User

对于局部变量,它不是正式支持的格式,但您还必须指定变量名称:

@var User $oUser

特定于PHPStorm,你需要使用双星号(我认为它是唯一需要它的IDE,请考虑一下):

/** @var User $oUser */

有关详细信息,请参阅PHPDoc manual