- Always develop with
error_reportingon. - Always develop with
isDeveloperModeset totrue. Just addSetEnv MAGE_IS_DEVELOPER_MODE 1to yourhttpd.conffile (or corresponding file for nginx or something else) - If the extension is linked to a core functionality add the dependency in the declaration file
<depends><Mage_Catalog /></depend> - If the module is for community use, use
communityas codepool to give the developers the chance to override some classes without modifying the code directly - Put your frontend design files in
app/design/frontend/base/defaultto make them available for all themes. - Put your admin design files in
app/design/adminhtml/default/defaultand do not change the admin theme. I may want to change it in one of my modules. - Prefix your layout file names and template folder name with the company name to make it easier to isolate them.
easylife_articles.xmlandapp/design/.../easylife_articles - Put your static resources (js, css, images) in a similar folder as the template files
easylife_articles/images/doh.png - Attach a simple text file with how to uninstall the extension: What files need to be removed, what tables need to be dropped, what config settings need to be removed from
core_config_datatable. - Do not write queries directly in models, blocks or helpers, use a resource model for that.
- Do not write queries using the table names directly
Select * from sales_flat_order where .... Use aZend_Selectand transform the table names using->getTable('sales/order'). - Use the base url to include
jsfiles in template. Wrong<script type="text/javascript" src="../js/some.js"></script>. Right<script type="text/javascript" src="<?php echo Mage::getBaseUrl('js').'some.js'?>"></script> - Do not rewrite classes unless is necessary. Use observers and if it's not possible use helper methods that receive as parameter and instance of a class that you wanted to override. Wrong: Override
Mage_Catalog_Model_Productto add the methodgetProductActicles(). Right. In your helper addgetProductArticles(Mage_Catalog_Model_Product $product) - If you override classes put a list of them in a
readme.txtfile - Use the default admin path for the admin section of your module. Wrong admin url
articles/adminhtml_articles/index. Right admin urladmin/articles/index - Add ACL for your admin sections. I may want to restrict access to some of the admins.
- Do not add an other js framework (jquery, mootools, ...) if it's not necessary. Write you code in prototype.
- Make you template html W3C valid (this is for OCD developers like myself).
- Do not put images in the
mediafolder. Useskin. Themediafolder usually is not versioned and this makes it harder to move the website on different environments. - Test you extension with flat catalog on and off. In order not to double the development time useChaos Monkey
- Test your extension with cache
onand cacheoff. - Avoid using uppercase letter in the module and class names. If not properly tested this may cause issues on different OS. This is more a recommendation, not a 'must'.
- Dispatch events in your code to make it easier for developers to alter the functionality.
- Follow the same coding standards that Magento uses and comment your code.
- [Edited] Do not use php short tags (
<? $this->doSomething() ?>). Use full tags (<?php $this->doSomething()?>). Also don't use short echo tags, yet. (<?="D'oh";?>). Use (<?php echo "D'oh";?>) - Translate your texts using
$this->__and add the locale translation file with your texts (app/local/en_US/Easylife_Articles.csv) at least foren_USlanguage. Not all websites are build in English and the identification of texts to translate it's time consuming. - If you sell an extension offer at least basic support. Or at least answer the support e-mails you receive.
- Do not make constant calls to your servers through your extension for licence validation. Once, at installation is more than enough (I don't like this approach either, but it's better than to make calls all the time). (Inspired by this question)
- Develop with the log activated and from time to time take a look at the
var/log/system.logfile. The errors listed here are not shown even with developer mode on. If there is at least one error you end up with a large log file after a few months of running the extension. - If your extension affects the checkout process or the orders in some way, make sure it works with multi-shipping, or if it shouldn't work with multi-shipping, make sure it doesn't affect it.
- Do not replace the default Admin Notification bar (or feed URL). If I'm interested on what you have to offer I will subscribe to your newsletter. Let me see what Magento has to say. It's more important to me.
- If you encrypt your code files with Ioncube (or something else)...well...I just hate you and I hope your business goes bankrupt
Monday, 2 February 2015
How to write a custom extension?
Subscribe to:
Post Comments (Atom)
No comments:
Post a Comment