├── .gitignore
├── codeigniter-phpstorm.png
├── README.md
└── phpstorm.php


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | 


--------------------------------------------------------------------------------
/codeigniter-phpstorm.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/natanfelles/codeigniter-phpstorm/HEAD/codeigniter-phpstorm.png


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # PhpStorm Code Completion to CodeIgniter + HMVC
 2 | 
 3 | Working perfectly with CodeIgniter 3.*
 4 | 
 5 | ### How to use it:
 6 | 
 7 | 1. Drop the **phpstorm.php** file into your CI project root then PhpStorm will index it.
 8 | 2. Go to *system/core/* folder.
 9 | 3. Select *Controller.php* and *Model.php* files, right click and set *Mark as Plain Text*.
10 | 
11 | ### HMVC Support
12 | 
13 | If you are using the Modular HMVC, mark as Plain Text the Controller.php file in the MX folder.
14 | 
15 | You need to add the `@property` tag in the class doc block:
16 | 
17 | ```php
18 | /**
19 |  * Class Cart
20 |  * @property Cart $cart Cart module
21 |  */
22 | class Cart extends MX_Controller {
23 | 
24 | 	/**
25 | 	 * Add product to cart
26 | 	 * @param int $id Product id
27 | 	 */
28 | 	public function add($id = 0)
29 | 	{
30 | 		// Do it...
31 | 	}
32 | }
33 | ```
34 | 
35 | To load modules in other places do like it:
36 | 
37 | ```php
38 | /**
39 |  * @var Cart $cart This will provide Code Completion in the $cart variable
40 |  */
41 | $cart = Modules::load('cart');
42 | ```
43 | 
44 | Use *Ctrl + Q* in `$cart` to load documentation or help with available functions:
45 | 
46 | ```php
47 | $cart->add(5);
48 | ```
49 | 
50 | ### Usage in Views
51 | 
52 | If you want load CI_Controller or MX_Controller in a view, add a doc block as follow:
53 | 
54 | ```php
55 | /**
56 |  * @var CI_Controller $this
57 |  */
58 | echo $this->uri->segment(1);
59 | ````
60 | 
61 | ### Preview:
62 | ![Image of Code Completion](https://raw.githubusercontent.com/natanfelles/codeigniter-phpstorm/master/codeigniter-phpstorm.png)
63 | 
64 | 


--------------------------------------------------------------------------------
/phpstorm.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | die('This file is used for development purposes only.');
 3 | /**
 4 |  * PhpStorm Code Completion to CodeIgniter + HMVC
 5 |  *
 6 |  * @package       CodeIgniter
 7 |  * @subpackage    PhpStorm
 8 |  * @category      Code Completion
 9 |  * @author        Natan Felles
10 |  * @link          http://github.com/natanfelles/codeigniter-phpstorm
11 |  */
12 | 
13 | /*
14 |  * To enable code completion to your own libraries add a line above each class as follows:
15 |  *
16 |  * @property Library_name       $library_name                        Library description
17 |  *
18 |  */
19 | 
20 | /**
21 |  * @property CI_Benchmark        $benchmark                           This class enables you to mark points and calculate the time difference between them. Memory consumption can also be displayed.
22 |  * @property CI_Calendar         $calendar                            This class enables the creation of calendars
23 |  * @property CI_Cache            $cache                               Caching Class
24 |  * @property CI_Cart             $cart                                Shopping Cart Class
25 |  * @property CI_Config           $config                              This class contains functions that enable config files to be managed
26 |  * @property CI_Controller       $controller                          This class object is the super class that every library in CodeIgniter will be assigned to
27 |  * @property CI_DB_forge         $dbforge                             Database Forge Class
28 |  * @property CI_DB_mysql_driver|CI_DB_query_builder $db                                  This is the platform-independent base Query Builder implementation class
29 |  * @property CI_DB_utility       $dbutil                              Database Utility Class
30 |  * @property CI_Driver_Library   $driver                              Driver Library Class
31 |  * @property CI_Email            $email                               Permits email to be sent using Mail, Sendmail, or SMTP
32 |  * @property CI_Encrypt          $encrypt                             Provides two-way keyed encoding using Mcrypt
33 |  * @property CI_Encryption       $encryption                          Provides two-way keyed encryption via PHP's MCrypt and/or OpenSSL extensions
34 |  * @property CI_Exceptions       $exceptions                          Exceptions Class
35 |  * @property CI_Form_validation  $form_validation                     Form Validation Class
36 |  * @property CI_FTP              $ftp                                 FTP Class
37 |  * @property CI_Hooks            $hooks                               Provides a mechanism to extend the base system without hacking
38 |  * @property CI_Image_lib        $image_lib                           Image Manipulation class
39 |  * @property CI_Input            $input                               Pre-processes global input data for security
40 |  * @property CI_Javascript       $javascript                          Javascript Class
41 |  * @property CI_Jquery           $jquery                              Jquery Class
42 |  * @property CI_Lang             $lang                                Language Class
43 |  * @property CI_Loader           $load                                Loads framework components
44 |  * @property CI_Log              $log                                 Logging Class
45 |  * @property CI_Migration        $migration                           All migrations should implement this, forces up() and down() and gives access to the CI super-global
46 |  * @property CI_Model            $model                               CodeIgniter Model Class
47 |  * @property CI_Output           $output                              Responsible for sending final output to the browser
48 |  * @property CI_Pagination       $pagination                          Pagination Class
49 |  * @property CI_Parser           $parser                              Parser Class
50 |  * @property CI_Profiler         $profiler                            This class enables you to display benchmark, query, and other data in order to help with debugging and optimization.
51 |  * @property CI_Router           $router                              Parses URIs and determines routing
52 |  * @property CI_Security         $security                            Security Class
53 |  * @property CI_Session          $session                             Session Class
54 |  * @property CI_Table            $table                               Lets you create tables manually or from database result objects, or arrays
55 |  * @property CI_Trackback        $trackback                           Trackback Sending/Receiving Class
56 |  * @property CI_Typography       $typography                          Typography Class
57 |  * @property CI_Unit_test        $unit                                Simple testing class
58 |  * @property CI_Upload           $upload                              File Uploading Class
59 |  * @property CI_URI              $uri                                 Parses URIs and determines routing
60 |  * @property CI_User_agent       $agent                               Identifies the platform, browser, robot, or mobile device of the browsing agent
61 |  * @property CI_Xmlrpc           $xmlrpc                              XML-RPC request handler class
62 |  * @property CI_Xmlrpcs          $xmlrpcs                             XML-RPC server class
63 |  * @property CI_Zip              $zip                                 Zip Compression Class
64 |  * @property CI_Utf8             $utf8                                Provides support for UTF-8 environments
65 |  */
66 | class CI_Controller
67 | {
68 | 	public function __construct()
69 | 	{
70 | 	}
71 | }
72 | 
73 | class CI_Model extends CI_Controller
74 | {
75 | }
76 | 
77 | class MY_Controller extends CI_Controller
78 | {
79 | }
80 | 
81 | class MX_Controller extends CI_Controller
82 | {
83 | }
84 | 


--------------------------------------------------------------------------------