Actions

Portal

Difference between revisions of "Developers"

From Joomla! Documentation

m (Adjusted link after page move)
m (line break removed)
(47 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{RightTOC}}
+
<div style="width:auto; margin:0; padding:0px 8px 8px 8px; border:1px solid #4F91CD; background-color:#DCEBFF;">
{{Developer profile}}
+
<!-- This portal was created using subst:box portal skeleton  -->
 +
{{browsebar|profiles}}
 +
<div style="clear:both; width:100%">
  
A complete contents list of all pages of interest to developers can be found in the [[:Category:Development|development category]].
+
{{:{{FULLPAGENAME}}/box-header-sq|<big>Joomla! {{PAGENAME}}</big>|{{FULLPAGENAME}}/Intro|}}
 +
{{:{{FULLPAGENAME}}/Intro}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
</div>
 +
<div style="clear:both; width:100%">
 +
{{:{{FULLPAGENAME}}/box-header-sq|Resources|Joomla! Development for Beginners/Reading_list|}}{{:{{FULLPAGENAME}}/Resources}}
 +
<div class="portal-column-left"> <!-- Switch to one column on narrow screens -->
 +
{{:{{FULLPAGENAME}}/box-header-sq|Components|Component_Development/Reading_list|}}{{:{{FULLPAGENAME}}/Components}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Templates|Template_Development/Reading_list|}}{{:{{FULLPAGENAME}}/Templates}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Database|{{FULLPAGENAME}}/Database|}}
 +
{{:{{FULLPAGENAME}}/Database}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Localisation|{{FULLPAGENAME}}/Localisation|}}
 +
{{:{{FULLPAGENAME}}/Localisation}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
</div>
 +
<div class="portal-column-right"> <!-- Switch to one column on narrow screens -->
 +
{{:{{FULLPAGENAME}}/box-header-sq|Migration|{{FULLPAGENAME}}/Migration|}}
 +
{{:{{FULLPAGENAME}}/Migration}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Modules|Module_Development/Reading_list|}}{{:{{FULLPAGENAME}}/Modules}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Plugins|Plugin_Development/Reading_list|}}{{:{{FULLPAGENAME}}/Plugins}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Parameters & Forms|{{FULLPAGENAME}}/Parameters|}}
 +
{{:{{FULLPAGENAME}}/Parameters}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Security|{{FULLPAGENAME}}/Security|}}
 +
{{:{{FULLPAGENAME}}/Security}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Access Control|{{FULLPAGENAME}}/Access Control|}}
 +
{{:{{FULLPAGENAME}}/Access Control}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Miscellaneous|{{FULLPAGENAME}}/Miscellaneous|}}
 +
{{:{{FULLPAGENAME}}/Miscellaneous}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
</div>
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
</div>
  
== Reference Material ==
+
<div style="clear:both; width:100%"></div>
  
* [[Framework|Joomla Framework]].
+
<div class="portal-column-right"> <!-- Switch to one column on narrow screens -->
* [http://api.joomla.org API documentation] automatically generated using phpDocumentor.
+
{{:{{FULLPAGENAME}}/box-header-sq|Contributing to Joomla Development|{{FULLPAGENAME}}/Joomla Development contribution|}}
 +
{{:{{FULLPAGENAME}}/Joomla Development contribution}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Contributing to Joomla Developer Documentation|{{FULLPAGENAME}}/Developer Documentation|}}
 +
{{:{{FULLPAGENAME}}/Developer Documentation }}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
</div>
  
== Articles and Tutorials ==
+
<div class="portal-column-left"> <!-- Switch to one column on narrow screens -->
 +
{{:{{FULLPAGENAME}}/box-header-sq|Projects|{{FULLPAGENAME}}/Projects|}}
 +
{{:{{FULLPAGENAME}}/Projects}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
{{:{{FULLPAGENAME}}/box-header-sq|Joomla! Security Guide|{{FULLPAGENAME}}/Joomla! Security Guide|}}
 +
{{:{{FULLPAGENAME}}/Joomla! Security Guide}}
 +
{{:{{FULLPAGENAME}}/box-footer|}}
 +
</div>
  
=== General ===
+
<div style="clear:both; width:100%">
* [[Setting up your workstation for Joomla! development]].  A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
+
</div>
* [[Setting up your workstation for extension development]] A guide to Joomla Extension development
+
* [http://community.joomla.org/blogs/community/828-webinar-using-eclipse-for-joomla-development.html Using Eclipse for Joomla! Development] Video webinar demonstrating overview of Eclipse features for Joomla! development
+
* [[Running Automated Tests for Version 1.6]] {{JVer|1.6}}
+
* [[Do not use die to debug]]
+
* [[How to debug your code]]
+
* [[Adapting Joomla 1.0 extensions to Joomla 1.5]]
+
* [[Version 1.6 Developer Notes]] {{JVer|1.6}}
+
* [[Joomla Beginning Developer Course]]
+
* [[Secure coding guidelines]]
+
  
=== Components ===
+
</div><!-- top div close -->
{{RecReading|Component|dev|topic}}
+
__NOTOC__ __NOEDITSECTION__
=== Modules ===
+
{{RecReading|Module|dev|topic}}
+
=== Plugins ===
+
{{RecReading|Plugin|dev|topic}}
+
=== Templates ===
+
{{RecReading|Template|dev|topic}}
+
===Parameters===
+
* [[Standard parameter types]]
+
* [[Custom parameter types]]
+
* [[Component parameters]]
+
* [[Creating custom template parameter types]]
+
See also: [[:Category:Parameters]]
+
  
=== Core extensions summary ===
 
* [[Banner component]] {{JVer|1.6}}
 
 
=== Security ===
 
* [[How to add CSRF anti-spoofing to forms]]
 
* [http://developer.joomla.org/tutorials/181-preventing-sql-injections.html Preventing SQL Injections]
 
* [[Securing Joomla extensions]]
 
 
=== Database ===
 
* [[How to use the database classes in your script]]
 
* [[How to use the JTable class]]
 
* [[How to connect to an external database]]
 
 
=== Localisation ===
 
* [http://community.joomla.org/magazine/article/508-developer-localization-advancements-in-joomla-15.html Localization Advancements in Joomla! 1.5]
 
* [[Adding multi-language support]]
 
* [[Language Guidelines for 3rd Party Extensions]]
 
* [[Adding Joomfish functionality to custom components]]
 
* [[Specification of language files]] {{JVer|1.6}}
 
* [[Language Metadata]] {{JVer|1.6}}
 
 
=== Access Control ===
 
* [[Access Control System In Joomla 1.6]] {{JVer|1.6}}
 
 
=== Miscellaneous ===
 
* [[How to use the filesystem package]]
 
* [[How to use the editor in a component]]
 
* [[Adding AJAX to your component]].
 
* [[How to send email from components]]
 
* [[How to use the JToolBar class in the frontend]]
 
* [[Routing]]
 
* [[Joomla Routes and SEF]]
 
* [[API Execution Order]]
 
* [[Accessing the current user object]]
 
* [[Adding JavaScript and CSS to the page]]
 
* [[Constants]] used in the Joomla [[Framework]].
 
* [[Form validation]]
 
* [[How to create a custom button]]
 
* [[How to create a stand-alone application using the Joomla! Framework]]
 
* [[How to use user state variables]]
 
* [[Adding template overridable images in your extension]]
 
* [[Retrieving data from GET and POST requests]]
 
* [[Cache]] and [[Using caching to speed up your code]]
 
* [[Using a custom image in the menu bar title]]
 
* [[Using the installer API to support package installation]]
 
* [[How to add tooltips to your Joomla! website]]
 
* [[Xml-rpc changes in Joomla! 1.6]]
 
* [[How to add breadcrumbs]]
 
* [[Creating a file uploader in your component]].
 
* [[Display error messages and notices]].
 
* [[Errors]]
 
* [[Creating a custom form field type]] {{JVer|1.6}}
 
 
== Contributing to Joomla Development ==
 
The development of Joomla itself is carried out by the [[Development Working Group]] and third party developers.
 
 
* [[Participating in the community]]: a brief description of how people can get involved.
 
* [[Developer Email lists]]: a list of email lists for developers, including third party developers.
 
* [[Coding style and standards]] (To be reviewed).
 
* [[Setting up your workstation for Joomla! development]].  A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
 
* [http://docs.joomla.org/Setting_up_your_workstation_for_Joomla!_development_--_Part_2#Check_Out_Joomla.21_Source_Code How to check out SVN Code]
 
* [[Patch submission guidelines]].
 
* [[Filing bugs and issues]].
 
* [[How to release a distribution tarball]].
 
* [[How to create a continuous integration]].
 
 
== Contributing to Joomla Developer Documentation ==
 
The development of Joomla developer documentation is carried out primarily by the [[Documentation Working Group]].  There are currently two sub-projects of interest to developers:
 
* [[Joomla! 1.5 Template Tutorials Project]]
 
* [[API Reference Project]]
 
 
When creating a new page, ensure you place the following marker at the bottom of the page so it is included in the category list:
 
 
<pre><nowiki>[[Category:Development]]
 
</nowiki></pre>
 
 
If you locate other articles you think are relevant to developers, please add this marker to those pages.
 
 
=== Suggested topics ===
 
This is a short list of articles that might be written to support developers.  Please feel free to add further topic ideas.
 
 
* [[Adding configuration objects to modules and plugins]].
 
* [[Storing data in the session between page loads]].
 
* [[Suppressing output of extra HTML]].
 
* [[How to use the filter package]].
 
*: Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
 
* [[How to use the registry package]]
 
* [[How to use JSimpleXML]].
 
*: How to load and store XML files and how to work with them
 
* [[How to create component feeds]] (RSS/ATOM)
 
* [[How to create PDF views]]
 
* [[How to generate paths for client side and server side]]
 
* [[How to access information from the request]]
 
*: This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
 
* [[How to create an editor plugin]]
 
* [[What can be done with a user plugin]]
 
* [[How to work with parameters]]
 
* [[How to cloak email addresses]]
 
* [[Using the caching system in your component]]. This might be enough (for now?) -> [[Cache]]
 
* [[Extending Joomla's MVC Architecture]]
 
 
==Joomla Security Guide==
 
Developers should also be aware of security issues.
 
{{Security Guide}}
 
  
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:JED]]
 
[[Category:JED]]
 
[[Category:Joomla! user profiles]]
 
[[Category:Joomla! user profiles]]

Revision as of 22:05, 14 October 2012

Beginners · Developers · Web designers · Administrators · Evaluators

Joomla! Developers

The development of Joomla! itself is carried out by the Development Working Group and third party developers. This page is a starting point for developers interested in the development of components, modules, plugins and templates.

Tip-icon.png
Have an Interest in Core Contributions?

The development of Joomla itself is carried out by Production Working Groups and third party developers. For more information about Joomla! core development, how to contribute to code to core, or becoming more involved with the core code, you should go to Joomla! Code Contributors.

Resources

There are several ways of setting up your workstation in for Joomla! development. Some suggestions can be found at Setting up your workstation for Joomla development.

Next, you should familiarise yourself with Joomla! Secure coding guidelines and the short article on Development Best Practices.

Documentation on the Joomla! API can assist with becoming familiar with the foundations of the Joomla! code base.

Finally, Joomla! has many resources for developers. Our Joomla! Resources page get you pointed in the right direction if you need help and solutions.

Components

Components

There are many articles, tutorials, references and FAQs which focus on component development. If this is your first time developing a component for Joomla, you should start with the Absolute Basics of How a Component Functions. If needed, you can visualise the control flow of a component with these diagrams.

Next, you will want to read our  Joomla 2.5 Joomla 3.x MVC tutorial    Developing a Model-View-Controller Component

Once you have read the tutorial and/or tried the example component, you can focus more on the specifics of your component with additional articles. These are listed on the Component Development Portal or any of the supporting Portals for Development(Plugins, Modules or Templates).


For more articles and information, see the Component Development Portal page.

Templates

Templates

Recommended Reading

Our template development documentation contains many articles, FAQs and tutorials. A first step to developing a template is understanding how templates are executed.

Beginners

Intermediate

Historical

For more articles and information, see the Template Development Portal page.

Database

Localisation

Migration

Modules

Plugins

Plugins

Recommended Reading

The following articles will help familiarise you with Joomla! plugins. They are a good starting point to understanding and then developing plugins.

Beginner

To understand how to install and use a plugin in Joomla it is recommended to read Administration of a Plugin in Joomla

Intermediate

To understand plugins better it is advised that you create a basic plugin for Joomla!.

It is also advised to read on how to run a basic content plugin in a custom module or component you may have already developed it is recommended to read Triggering content plugins in your extension.

Advanced

To understand the principles on which the Plugin system works Plugin Developer Overview. To then implement this in a component you have designed it is recommended to read Supporting plugins in your component.

For more articles and information, see the Plugin Development Portal page.

Parameters & Forms

Security

Access Control

Miscellaneous

Contributing to Joomla Development

Contributing to Joomla Developer Documentation

The development of Joomla developer documentation is carried out primarily by the Documentation Working Group. There is currently one sub-projects of interest to developers:

When creating a new page, ensure you place the following marker at the bottom of the page so it is included in the category list:

[[Category:Development]]

If you locate other articles you think are relevant to developers, please add this marker to those pages.

Projects

Suggested topics

This is a short list of articles that might be written to support developers. Please feel free to add further topic ideas.


Joomla! Security Guide