部分代码完成PHPStorm CodeIgniter 3

Question

(PHPStorm version 8.0.3 with CodeIgniter 3, running on Mac OS X Yosemite 10.10.3)

As the title states, I currently experience partial code completion.

At first I had nothing, I used the following link to add the partial part:

1. https://github.com/topdown/phpStorm-CC-Helpers/blob/master/README.md#using-the-my_modelsphp (It works for me without and with the 'marking as plain text' solution)

I can now for example see the code completion for $this->... , thus giving me options at first I didn't had.

I do get an 'unfound' method warning message from PHPStorm when I use $query->row_array(); after assigning $query = $this->db->get_where('news', array('slug' => $slug)); . So in this case my code completion doesn't work (It can't find it).

The full code of this class is found beneath.

class News_model extends CI_Model
{
    public function __construct()
    {
        $this->load->database();
    }

    public function get_news($slug = FALSE)
    {
        if($slug === FALSE)
        {
            $query = $this->db->get('news');

            return $query->result_array();
        }

        $query = $this->db->get_where('news', array('slug' => $slug));

        return $query->row_array();
    }
}

When I run a search for the method 'row_array' it is found under 'System' > 'database' > 'db_result.php'. So it is defined, but PHPStorm can't give me code completion

How can I fix this?

Answer 1

From my understanding.

As long as you followed one of these options

Option 1 = File > Settings > Directories > Add Content Root > Select the directory in phpStorm-CC-helpers that is relevant > mark Resource Root

Option 2 = In the project window right click External Libraries > Configure PHP Include Paths Then add the path to the phpStorm-CC-helpers that is relevant

Then according to the helper annotations /CI_DB_active_record is what it is returned when you call get_where . Ensure that the file /system/database/DB_active_rec.php is marked as plain text so that the IDE can parse it for autocomplete.

If you are using CodeIgniter 3, /system/database/DB_active_rec.php and the /CI_DB_active_record class was removed from the CodeIgniter source, so there would be no reference found for /CI_DB_active_record that the helper references.

Answer 2

I just tested this and it I can confirm that it does work, its not ideal but it will produce autocomplete for the $query var.

I used this in the route of my project. https://gist.github.com/gentoid/4353692

Then you have to do the code like this:

public function index($slug)
{
    /** @var CI_DB_result $query */
    $query = $this->db->get();

    //this will now produce auto complete in PHPStorm because 
    //it knows that object the $query var contains.
    //$query->
}

also you can do this

/**
 * @return CI_DB_result
 */
public function getData()
{
    return $this->db->get();
}

public function test()
{
    $query = $this->getData();

    //this will now produce auto complete in PHPStorm because 
    //it knows that object the $query var contains.
    //$query->
}