EYiiApi ¶
Extension to use under development providing you with quick reference of yii documentation.
- Version: 0.3.1
- Author: Dimitrios Mengidis
Description ¶
This project began when I had some issues with my ISP. I had already migrate the yii documentation for the YiiBot so i need a local way to view the documentation. The result is this extension. It's main purpose is to provide developers with a quick reference as well as links of the yii documentation.
Install ¶
Download and extract the zip file under the extension folder and should look like. ~~~
./webapp/protected/extension/EYiiApi
or use the github.com and clone the repository under the extension folder.
git clone https://github.com/dmtra/EYiiApi
###Where to init EYiiApi
The use case i imagine is to init the widget in the
./webapp/views/layout/main.php
The position of the widget is fixed to the bottom. I prefer footer div because i mainly do not do a lot of work there.
Initialization is easy as
```php
$this->widget('application.extensions.EYiiApi.EYiiApi');
```
###How to use
For classes type:
- classname
- chtml
- yii
For methods type classname followed by :: and method name, () are optional:
- classname::method
- chtml::image()
- yii:app
For a property type classanem followed by ::$ and property name:
- classname::$property
- cactivedataprovider::$data
###Screenshots
- [Closed](http://dmtrs.devio.us/closed.png)
- [Class](http://dmtrs.devio.us/class.png)
- [Method](http://dmtrs.devio.us/method.png)
###Other uses
This extension can be used in a site as well if you alter the data in the database
./webapp/protected/extension/EYiiApi/data/myiiapi.sqlite
You can found some easy to understand sql tables where you can put your own project documentation for your project site.
###Changelog
- Version: next
* Work with the css and toggle
* mv ./views/default/* ./views ( correct render as well )
* mv ./css/myiiapi.css ./css/eyiiapi.css
* BUG: methods search returns more than proper
- Version: 0.3.1
* FIX: default/index exceptio
- Version: 0.3
* Created EYiiApiActiveRecord that is extended from
the models under the model folder so they will point
to the database under data.
* Added link to target _blank
* created the eyiiapi.js
* model labels corrected
- Version: 0.2
* 1 Generic view
- Version: 0.1
* Added database.
* Working with diff views.
###Links
- [Repository](http://www.github.com/dmtrs/EYiiApi)
- [Yii migration project](http://www.github.com/dmtrs/yiibot)
If you have any questions, please ask in the forum instead.
Signup or Login in order to comment.