Usage
Install Plugin
Download a nbm file or create it by yourself. And please, install it.
How to enable
- Use default directory structure (don't delete yiic* files)
- project properties > Framework > Yii, check
enabled (You don't have to check this if you use plugin with default app)
Existing Source
Source directory : Please, specify the webroot directory
Webroot directory : Please, keep default (Source directory)
e.g.
testdrive (webroot directory)
├── assets
├── css
├── images
├── index-test.php
├── index.php
├── nbproject
├── protected
└── themes
Existing Source (Source Directory has other directories)
Please set webroot directory(yii path alias named "webroot" i.e. webroot is testdrive on the below tree) to webroot of project properties.
Right-click project > properties > Source > Webroot
e.g.
my_source (source directory)
├── testdrive (webroot directory)
│ ├── assets
│ ├── css
│ ├── images
│ ├── index-test.php
│ ├── index.php
│ ├── protected
│ └── themes
│
├── ...
├── foo
└── bar
Path settings
You can set the some paths(e.g. path alias) to project properties. If you use defferent path from default, please set relative path there from source directory.
I have added path settings to project properties.
Usage
Please set relative path from source directory.
e.g.
Please set protected/myext to ext: if extensions directory is the following:
myproject
├─protected
│ └─myext (extensions directory)
├─...
If you want to use default directory, please set empty.
e.g.
application: myprotected
controllers: (empty)
views: (empty)
controllers directory means myprotected/controllers. views directory means myprotected/views.
Features
- Badge icon
- Go To Action
- Go To View
- Code Completion on the view file
- Code Completion for the path
- Init Action
- PHPUnit Test Init Action
- New Yii Project Wizard
- Run Action Action
- Navigation for path alias (Hyperlink to file)
- Run Command Action
Go To Action
You can open the controller file and move action method.
e.g. WebRoot/protected/views/site/index.php -> WebRoot/protected/controllers/SiteController.php::actionIndex()
- open a view file
- Right-click on Editor
- Navigate > Go To Action
Go to View
You can open the view file for action method of the controller.(similar to Go To Action)
- open a controller file
- move the caret to action method
- Right-click on Editor
- Navigate > Go To View
If you set the keymap for this action, it's more useful.(Please, search with "php")
If you set the theme on main.php, you will go to there.
// protected/main.php
// e.g. set themes/basic
array(
// something...
'theme' => 'basic',
);
Hyper link to view file
You can open the view file from parameter of render and renderPartial methods. This is available on the Controller or View files.
e.g.
public actionIndex() {
// something ...
$this->render('foo', array('bar' => $bar));
$this->renderPartial('bar');
}
When you use the render method like above, if foo.php exists, you do the following.
fallback to default views
You can fallback to default views if view file for your theme doesn't exist when you use the theme. If you would like to this feature, please, check "Fallback to ..." on project properties for Yii.
- Hold down Ctrl key on the first parameter (foo)
- Wait to be changed string color to blue
- Click (foo)
It will go to theme file if you use theme.
Navigation for path alias (Hyperlink to file)
Usage is the same as hyperlink to view file.
This feature is available for the followings:
- Hold down
Ctrl on target path
- string color is changed to blue if file exists(file path is displeyed as tooltip)
- Click > open file
e.g.
$this->widget('application.components.MyComponent', array());
// Hold down Ctrl on application.components.MyComponent
// support for the path that starts with '/' and '//'
$this->beginContent('//layouts/main');
$this->renderPartial('/users/foo');
// support for the class name
$this->widget('MyWidget');
Furthermore... Class name is also valid at the other places.
e.g.
return array(
'some'=>array(
// Hold-down Ctrl key on 'ClassName'
'class'=>'SomeAction',
),
);
i18n
Yii::t('Xyz.categoryName', 'message to be translated');
// on the first parameter : open the message file for LanguageID
// on the second parameter : open the message file for LanguageID, and caret position is moved to specified message
Notice
- This feature works with default path alias name.
- Automatically file creation is valid with only render and renderPartial methods.
Code Completion on the view file
Provide support for code completion on the View file.
e.g. webapp/protected/controllers/SiteController.php
class SiteController extends Controller {
// something...
public function actionIndex(){
// ...
$this->render('foo', array(
'var1' => $var,
'var2' => 'bar',
));
}
}
e.g. webapp/protected/views/site/index.php
$ // [Ctrl + Space] popup $var1, $var2, $this, ...
$this-> // [Ctrl + Space] popup SiteController methods and fields
Code Completion for the path
This is available the following methods:
- render
- renderPartial
- beginContent
- beginCache
- import
- *widget
e.g.
// type character or [Ctrl + Space]
$this->render('i');
// class or path alias
$this->widget('application.[Ctrl + Space]');
Init Action
Run the followings:
- Set framework directory path to Project Properties.
- Create a file for code completion.
Project right-click > Yii > Init
Testing
To run functional tests and unit tests in Yii, recommended is installing PHPUnit and SeleniumRC.
- Install PHPUnit
- Install SeleniumRC by getting the NetBeans plugin
- Open "Tools > Plugins > Available Plugins"
- Install "Selenium Module for PHP"
- Configure project options
- Open "File > Project properties > Sources" and set "Test Folder" to [PROJECT ROOT]/protected/tests (If the whole project testing doesn't work, try [PROJECT ROOT]/protected/tests/unit)
- Open "File > Project properties > PHPUnit" and set "Use Bootstrap" to [PROJECT ROOT]/protected/tests/bootstrap.php, and "Use XML Configuration" to [PROJECT ROOT]/protected/tests/phpunit.xml
Usage:
- Test whole project: Alt+F6
- Test single file: Shift-F6
- Check code coverage (right click project > Code Coverage)
4. Debugging
- Install Xdebug (usually already available in your installation):
- Include the Xdebug extension for PHP:
Usage:
- Debug project: Ctrl-F5
- Use breakpoints, walk through running code, and watch variables and objects in real-time. :)
- If you want to stop the debugger from pausing on the first line for every request, simply turn that "feature" off by clicking: Tools > Options > PHP > Debugging > Stop at First Line (uncheck)