PhpStorm PDOS声明警告


PhpStorm PDOStatement Warnings

考虑以下类:

class output_Home {
    public $app;
    public $forums;
    function __construct ($app) {
        // main app class containing db, settings, etc
        $this->app = $app;
        // populate class property arrays for use in template
        $this->setForums();
    }
    function setForums () {
        /*
         * select all forum data, dump into $this->forums array
         * fields:
         *      id, name, slug, description, order,
         *      total_threads, total_posts,
         *      last_post_id, last_post_date, last_poster_id, last_poster_username, last_poster_avatar
         */
        $sql = "select f.*,
                p.id as last_post_id, p.date_created as last_post_date,
                u.id as last_poster_id, u.username as last_poster_username, u.avatar as last_poster_avatar,
                (select count(*) from `threads` where `id_forum`=f.id) as total_threads,
                (select count(*) from `posts` where `id_forum`=f.id) as total_posts
                from `forums` as f
                left join `posts` as p on (p.id = (select `id` from `posts` where `id_forum`=f.id order by `date_created` desc limit 1))
                left join `users` as u on (u.id = p.id_user)
                order by f.order asc";
        $stm = $this->app->db->prepare($sql);
        $stm->execute();
        $this->forums = $this->app->sanitizer->action('sanitize', $stm->fetchAll());
    }
}

这是我的object_App类:

class object_App {
    public $db;
    function __construct () {
        // create database "db" connection
        $this->db = new PDO('mysql:host='.DB_HOST.';dbname='.DB_NAME, DB_USER, DB_PASS);
        $this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
        $this->db->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);
    }
}

以下是如何将$this->app传递给output_Home类:

$app = new object_App();
$home = new output_Home($app);

$app属性包含一个名为db的属性,它是一个PDO对象。请特别注意这里的$stm变量。

我的问题是,我收到了来自PhpStorm的警告,声称在类中找不到$stm->execute()之类的方法。当然不是,因为他们是PDOStatements

我只想知道是否有一种方法可以正确地消除警告,而不必在我制作的每一个$stm之上使用PHPDocs,因为我将在几个不同的类方法中制作相当多的方法,并且我不希望PHPDocs在代码中无处不在。

如有任何帮助,我们将不胜感激。

1.$db提供正确的类型提示。在你的特殊情况下,这可能不是100%必要的,但最好有它(这是一次性工作)

class object_App {
    /** @var 'PDO */
    public $db;
    ...

一般来说,IDE可以弄清楚$db是什么,因为你有$this->db = new PDO(...);,它位于__construct()中(两个重要因素)。。但它最好是安全的一方与适当的类型提示。如果这样的线路将被放置在一些普通的方法中(例如createDBConnection()或其他什么),IDE将不会做那种昂贵的额外智能。

2.最重要的是--为$app提供类型提示。传递这个参数的方式并没有为IDE提供任何提示。

可以这样做(IDE应该能解决剩下的问题):

function __construct (object_App $app) {

或者以与#1相同的方式更好:

class output_Home {
    /** @var object_App */
    public $app;

甚至更好——将它们结合在一起:

class output_Home {
    /** @var object_App */
    public $app;
    function __construct (object_App $app) {
    ...

除非PHPStorm知道方法返回的对象类型,否则它无法知道该对象可能使用哪些方法。

你有3个选项:

1) 正如您所说,使用一个快速的phpdoc来告诉phpstorm它是什么(您只需要在一个代码块中这样做一次:

/** @var SomeObject $stm */
$stm = $this->app->db->prepare($sql);

2) 完全抑制的警告

查找:

设置>编辑器>检查

然后在PHP>undefined下取消选中undefined method

3) 如果您可以控制被调用的方法:

确保在该方法的phpdoc中包含返回类型,PHPStorm将使用它来确定它需要什么。

/**
* @return SomeObject
*/
public function someFunction() {
   // some stuff
}