vim-magento

KO | EN

gitlite — search

#javascript #python #react #llm #go #android #rust #nodejs #macos #java #awesome #cli #kubernetes #openai

(★ 15)

Vim plugin that helps you build Magento modules.

vim-magento 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Author : Michael Joseph <http://michael-joseph.me/en/> 
Version : 0.9.0 beta 
License : GPL 3.0
INTRODUCTION
========================================================================
Vim-Magento is a Vim plugin that helps you build Magento modules.

Vim-Magento has been tested successfully on Debian Wheezy and Mac OSX 10.6.8. It does not support Microsoft Windows OS yet.

**Warning: This plugin is dedicated to advanced Magento developers. Before you use it, Magento framework knowledge is necessary. This is a tool to increase productivity.**

INSTALLATION
========================================================================
I recommand to install Vim-Magento with Vundle.

SETUP
========================================================================
/!\ In order to work Vim-Magento needs **XmlStarlet Command Line**.
Please install this before everything.

XmlStarlet installation
--------
- Under Debian distribution you can easily install XmlStarlet with this command line:
```
sudo apt-get install xmlstarlet
```
- Under Mac OSX follow this short tutorial to compile it: http://michael-joseph.me/en/linux-en/how-to-install-xmlstarlet-on-mac-osx/
- Otherwise, go to the following url to install it: http://xmlstar.sourceforge.net/doc/UG/xmlstarlet-ug.html

Global variables
--------
Vim-Magento generate automatically comments, you have to define the global variables below in your .vimrc:
```
let g:vimMagentoAuthor = "Michael Joseph <contact@michael-joseph.me>"
let g:vimMagentoCopyright = "Copyright 2016 Michael Joseph http://michael-joseph.me"
let g:vimMagentoLicense = "No License"
```
If you don't define g:vimMagentoLicense, the default license will be 
```
'GPL 3.0 http://www.gnu.org/licenses/gpl-3.0.txt'
```
To disable Vim-Magento plugin's signature add this line in your .vimrc:
```
let g:vimMagentoSignature=0
```
USAGE
=============
To run Vim-Magento, you must launch your vim instance at the Magento project root. 
All actions begin with *Magento* command.

THE COMMAND
========================================================================
You only have one command to know:
```
:Magento
```
This command opens the **Magento prompt**. 
For each Vim instance, the first time you call *:Magento* command
you have to define the module to be created or updated:
```
Pool name : Type <l> for Local or <c> for Community
```
```
Package name : Type the module package name without special characters
```
```
Extension name : Type the module extension name without special characters
```
 
Once module has been defined, two cases are possible:
 &nbsp;&nbsp;&nbsp;&nbsp;1- The module exists, the prompt invites you to choose actions.
 &nbsp;&nbsp;&nbsp;&nbsp;2- The module does not exist, the basic module is created.
 
 
Basic module's tree example
----
```
app
├── code
│ └── community
│ └── Mypackage
│ └── Myextension
│ ├── etc
│ │ └── config.xml
│ └── Helper
│ └── Data.php
└── etc
 └── modules
 └── Mypackage_Myextension.xml
```
ACTIONS
========================================================================
The Magento prompt invites you to choose between actions below:

Select / Create a module
--------
* Type \<s>
 
 
This action enables you to select or create another module
as if it was the first time you were calling |Magento| command.

Block creation 
--------------
* Type \
 
 
Define **Block name**:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the block name without special characters.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To create subfolders you can use \<_> or \</> in your block name.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; > *Example: 'Mysubfolder_Myblock' or 'Mysubfolder/Myblock'*

Front controller creation
--------------
* Type \<c>
 
 
Define **Controller name**:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the controller name without special characters.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To create 'Mypackage_Myextension_CustomController' class, 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;please type only 'Custom'.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If you leave this field empty 'Mypackage_Myextension_IndexController'
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;class will be created automatically.

Model creation
------------
* Type \<e>
 
 
Define **Entity name**:
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the entity name without special characters.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This name will be the model class name.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For example to create 'Mypackage_Myextension_Model_Mymodel' class,
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;please type 'mymodel' or 'Mymodel'.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To create subfolders you can use <_> or </> in your model name
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; > *Example: 'Mysubfolder_Mymodel' or 'Mysubfolder/Mymodel'*
 
 
Define **Table name** : 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the table name without special characters.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This name will be the database table name.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In the config.xml file this corresponds to the table node:
```
<entities>
 <mymodel>
 <table>my_table_name</table>
 </mymodel>
</entities>
```
Observer creation 
----
* Type \<o>
 
 
Define **Area name**: 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type <g> for global, <f> for frontend or <a> for adminhtml.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This value defines the observer scope.
 
 
Define **Event name**: 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the event name to observe.
 
 
Define **Observer name**: 
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the observer name without special characters.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If you leave this field empty 'Mypackage_Myextension_Model_Observer' class
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;will be created automatically.
 
 
Define **Method name** :
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type the method name without special characters.
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This name will be the observer method name that will be fired on event.

THE ABBREVATIONS
===========
In insert mode, you can type those abbreviations to save time:
```
log$    > Mage::log();
llog$   > Mage::log(__CLASS__.' : '.__LINE__);
flog$   > Mage::log(__CLASS__.' : '.__FUNCTION__);
sconf$  > Mage::getStoreConfig();
dat$    > Mage::app()->getLocale()->date()->toString('HH:mm')
```
You can complete or optimize those by editing ab.vim files.

vim-magento

vim-magento 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

vim-magento

vim-magento 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README