Joomla! Documentation - User contributions [en]

File:Gherkin-steps-en.jpg

2016-07-10T07:30:46Z

Gunjanpatel: File contians gherkin steps

== Summary ==
File contians gherkin steps
== Licensing ==
{{JEDL}}

GSOC 2016 Joomla GIT Workflow

2016-05-16T06:19:26Z

Gunjanpatel: /* Useful session from Joomla World Conference 2015 about The development workflow of Git/Github for Beginners */

== Joomla GSoC Github Flow ==

This document contains guidelines for GSoC students and mentors on how to manage and work with Github Repo's for GSoC projects. All the Repository's for GSoC projects are available on [https://github.com/joomla-projects/ Joomla! Project Github]

=== Joomla! GSoC Student Workflow ===
First step is forking your joomla-projects/gsoc16_** repository to your personal GitHub account. Never make changes to the joomla-projects repository directly. Any contributor should work on his/her own fork of it, and move code to central repository using pull requests. Also, nobody should ever merge her/his own PR.
Students should always work on branches, they should never make changes to their staging branch!

==== Preparation ====

On Github, navigate to the joomla-projects/my-gsoc-project repository and click on the ‘Fork’ button in the upper right corner. This creates a fork (a linked copy) in your account (let’s call it ‘my-user’), resulting in a new repo my-user/my-gsoc-project.

[[Image:Github_flow_1.jpg|1012px|center|link=Github Flow 2016]]

Next step is cloning the forked repository to your local computer. If you set up ssh-keys in GitHub (recommended), use the link with ssh. If not use the https link.

[[Image:Github_flow_2.jpg|900px|center|link=Github Flow 2 2016]]

<source lang="javascript">
git clone -b staging git@github.com:my-user/my-gsoc-project.git
</source>

To keep your fork updated with the changes from joomla-projects, you need to add the joomla-projects repo as additional remote repository (mostly called upstream):

<source lang="javascript">
git remote add upstream https://github.com/joomla-projects/gsoc16**
</source>
You can now update staging by applying the following command:

<source lang="javascript">
git fetch upstream staging
</source>

Next merge the changes:

<source lang="javascript">
git merge upstream/staging
</source>

And push them to your remote fork

<source lang="javascript">
git push
</source>

Your mentors are going to keep the joomla-projects repository in sync with joomla/joomla-cms staging. You need to do the same for your fork!

==== Making a pull request with your changes ====

Now you can start working on your local computer. The project folder is under version control, so you can follow any changes you make. Always make a custom branch for your changes and do not work on staging directly.

<source lang="javascript">
git checkout -b patch-name
</source>

When your patch is ready you send a so called Pull Request (PR) from your repository to the joomla-projects one.

For that you have to push your changes to your forked repository. First make sure there are no unnecessary files and comments left. And that your code is probably formatted according to the Joomla! Code styles.

<source lang="javascript">
git status
</source>

and

<source lang="javascript">
git diff path/to/file
</source>

are going to help you with that. Next add all files you want to include in your PR with:

<source lang="javascript">
git add path/to/folder/or/file
</source>

After that you need to commit your changes and push them to your fork:

<source lang="javascript">
git commit -m “Describe your changes as best and short as possible here”
</source>

Push the changes to the repository

<source lang="javascript">
git push
</source>

For pushing a branch to GitHub you would use the first time:

<source lang="javascript">
git push origin BRANCHNAME
</source>

Go the GitHub website and open your forks site. You are going to notice that there is a notice about your recent push at the top:

[[Image:Github_flow_3.jpg|1012px|center|link=Github Flow 3 2016]]

Click on ‘Compare & Pull request‘. Add a meaningful description, including summary of changes and important (!) testing instructions and click on ‘Create pull request‘.

Now wait to for your Mentors comments, if everything is working they are going to merge your PR into the joomla-project repository. If not you can just fix it locally and push again. The PR is going to be updated automatically with these changes.

=== Keeping the GSoC fork updated with Joomla staging (For Mentors)===

==== Preparation ====

In your dev environment clone your own (forked) repository. my-user/my-gsoc-project is automatically added as 'origin'.

<source lang="javascript">
git clone -b staging git@github.com:my-user/my-gsoc-project.git
</source>

Next we add the joomla-projects/gsoc16** repository as upstream and the joomla/joomla-cms repository as joomla remote.

<source lang="javascript">
git remote add upstream https://github.com/joomla-projects/gsoc*.git
</source>
<source lang="javascript">
git remote add joomla https://github.com/joomla/joomla-cms.git
</source>

Never change the staging branch! It is a verbatim copy from the joomla/joomla-cms repo, and must be kept in sync by you. You can set the branch to protected so that only mentors are allowed to push to it.

==== Update staging ====

Whenever something changes in the CMS repo, the staging branch needs to be synchronised.

Checkout (activate) current staging branch

<source lang="javascript">
git checkout staging
</source>

Next get the changes from the joomla/joomla-cms staging branch

<source lang="javascript">
git fetch joomla staging
</source>

Merge the changes

<source lang="javascript">
git merge joomla/staging
</source>

Push the changes to your own repository and to the joomla-projects/gsoc one.

<source lang="javascript">
git push origin staging
</source>

<source lang="javascript">
git push upstream staging
</source>

==== Update feature branches ====

With all of your feature branches, the changes have to be merged as well.

Checkout the branch first:

<source lang="javascript">
git checkout branch-name
</source>

Merge changes from staging

<source lang="javascript">
git merge staging
</source>

There might be conflicts, when the CMS changed code, that was changed in your feature branch; in that case, consult `git merge --help`.

=== Tips and tricks ===

Before making any changes create a new branch, so you can easily update your forks staging (or master) later and make multiple pull requests for one Repo.

<source lang="javascript">
git checkout -b NAME
</source>

Keep your pull requests as small as possible. This makes testing and getting them merged far easier. Be descriptive in your pull request. Explain step by step how to test the changes. Where possible add screenshots for clarification.

Code style:

Please make sure you don’t leave any unnecessary files, comments (don’t comment code!) in your PR. Also make sure it matches the Joomla! Coding style guidelines.

[https://github.com/joomla/joomla-cms/blob/staging/.github/CONTRIBUTING.md Contributing to the Joomla! CMS™]

[http://joomla.github.io/coding-standards/ Joomla! Coding Standards Manual]

===== Useful session from Joomla World Conference 2015 about The development workflow of Git/Github for Beginners =====

{{#widget:YouTube|id=lEnYz0b7omE}}

GSOC 2016 Joomla GIT Workflow

2016-05-16T06:18:14Z

Gunjanpatel: /* Useful session from Joomla World Conference 2015 about The development workflow of Git/Github for Beginners */

GSOC 2016 Joomla GIT Workflow

2016-05-16T06:14:53Z

Gunjanpatel: /* Useful session from Joomla World Conference 2015 about The development workflow of Git/Github for Beginners */

GSOC 2016 Joomla GIT Workflow

2016-05-16T06:08:58Z

Gunjanpatel: /* Tips and tricks */ Added JWC15 video

J3.x:Developing an MVC Component/Developing a Basic Component

2015-09-25T11:31:37Z

Gunjanpatel: /* Notes */

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate>
en</translate>}}

<translate>
== Notes ==
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

* If you have used Joomla! before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

* You can follow the steps below to create the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-1-basic-component.zip archive]

* Here are some slides based on this documents to explain how to create basic to advance joomla components.
<br />
[http://bit.ly/joomlaWorkshopBasic Joomla! Basic Component Help]
<br />
[http://bit.ly/joomlaWorkshopAdvance Joomla! Advance Component Help]

== How to add a component to Joomla! ==
In this article we will cover how to create and install a basic Joomla! component. For this example we will be working with the Hello World! component.

To begin, you must first use your preferred file manager to create a directory for the Hello World! component. This directory can be anywhere on your file system, as long as it outside of your Joomla! installation directory. For this example we will name the directory <tt>com_helloworld</tt>, but this directory can be named anything.

Next, inside this directory we need to create some files. Using your preferred file manager, create the following files; as you create the files, add the source code for each file which is found in ''[[#File Details| File Details]]''.

{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| this is an XML (manifest) file that tells Joomla! how to install our component.
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| this is the site entry point to the Hello World! component
|-
| 3
| ''[[#index.html|site/index.html]]''
| prevents web server from listing directory content
|-
| 4
| ''[[#index.html|admin/index.html]]''
| prevents web server from listing directory content
|-
| 5
| ''[[#admin/helloworld.php|admin/helloworld.php]]''
| this is the administrator entry point to the Hello World! component
|-
| 6
| ''[[#index.html|admin/sql/index.html]]''
| prevents web server from listing directory content
|-
| 7
| ''[[#index.html|admin/sql/updates/index.html]]''
| prevents web server from listing directory content
|-
| 8
| ''[[#index.html|admin/sql/updates/mysql/index.html]]''
| prevents web server from listing directory content
|-
| 9
| ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| file allowing to initialise schema version of the com_helloworld component.
|}

=== Installing the Hello World! Component ===
Using your preferred file manager, create a .zip file of this directory. For this example we will name the file <tt>com_helloworld.zip</tt>, again this file could have been named anything.

Now we need to install the Hello World! component. There are two ways to do this, both are covered in [[Installing an extension| Installing an Extension]]. Here we will cover the method using the Extension Manager of Joomla!.

*Using your preferred web browser, navigate to the Administrator panel of your Joomla! site. The address would be <tt><yoursite>/joomla/administrator/index.php</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php</tt>.
*Click Extensions {{rarr}} Manage {{rarr}} Install {{rarr}} Upload Package File {{rarr}} Choose File
*Navigate and Select File
*Click Upload & Install

Note - You should see a message letting you know if the installation succeeded or failed.

You can test this basic function of the component by entering the Hello World! page for the site and administrator portions of your Joomla! website.
* Using your preferred web browser, navigate to the Hello World! component page located on the site portion of your website. The address would be <tt><yoursite>/joomla/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/index.php?option=com_helloworld</tt>.
* Using your preferred web browser, navigate to the Hello World! component page located on the administrator portion of your website. The address would be <tt><yoursite>/joomla/administrator/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php?option=com_helloworld</tt>.

You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

==File Details== 
</translate>
{{vanchor|admin/sql/updates/mysql/0.0.1.sql}}
<translate>
is an empty file allowing to initialise schema version of the com_helloworld component.</translate>

<source lang="sql">
</source>

{{vanchor|helloworld.xml}}

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>December 2013</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>

{{vanchor|site/helloworld.php}}

<source lang="php">
Hello World
</source>

{{vanchor|admin/helloworld.php}}

<source lang="php">
Hello World administration
</source>

{{vanchor|index.html}}

<translate>
common to all folders</translate>

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

==Component Contents==
At this point in the tutorial, your component should contain the following files:
{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| this is an XML (manifest) file that tells Joomla! how to install our component.
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| this is the site entry point to the Hello World! component
|-
| 3
| ''[[#index.html|site/index.html]]''
| prevents web server from listing directory content
|-
| 4
| ''[[#index.html|admin/index.html]]''
| prevents web server from listing directory content
|-
| 5
| ''[[#admin/helloworld.php|admin/helloworld.php]]''
| this is the administrator entry point to the Hello World! component
|-
| 6
| ''[[#index.html|admin/sql/index.html]]''
| prevents web server from listing directory content
|-
| 7
| ''[[#index.html|admin/sql/updates/index.html]]''
| prevents web server from listing directory content
|-
| 8
| ''[[#index.html|admin/sql/updates/mysql/index.html]]''
| prevents web server from listing directory content
|-
| 9
| ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| file allowing to initialise schema version of the com_helloworld component.
|}

== Contributors ==
* [[User:Ribafs|Ribafs]]
* [[User:Cdemko|Christophe Demko]]
* [[User:Kevinkabatra|Kevin Kabatra]]

{{notice|<translate>
Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.</translate>}}

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Developing an MVC Component/Developing a Basic Component

2015-09-25T11:31:20Z

Gunjanpatel: /* Notes */

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate>
en</translate>}}

<translate>
== Notes ==
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

* If you have used Joomla! before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

* You can follow the steps below to create the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-1-basic-component.zip archive]

* Here are some slides based on this documents to explain how to create basic to advance joomla components. <br />
<br />
[http://bit.ly/joomlaWorkshopBasic Joomla! Basic Component Help]
<br />
[http://bit.ly/joomlaWorkshopAdvance Joomla! Advance Component Help]

== How to add a component to Joomla! ==
In this article we will cover how to create and install a basic Joomla! component. For this example we will be working with the Hello World! component.

To begin, you must first use your preferred file manager to create a directory for the Hello World! component. This directory can be anywhere on your file system, as long as it outside of your Joomla! installation directory. For this example we will name the directory <tt>com_helloworld</tt>, but this directory can be named anything.

Next, inside this directory we need to create some files. Using your preferred file manager, create the following files; as you create the files, add the source code for each file which is found in ''[[#File Details| File Details]]''.

{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| this is an XML (manifest) file that tells Joomla! how to install our component.
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| this is the site entry point to the Hello World! component
|-
| 3
| ''[[#index.html|site/index.html]]''
| prevents web server from listing directory content
|-
| 4
| ''[[#index.html|admin/index.html]]''
| prevents web server from listing directory content
|-
| 5
| ''[[#admin/helloworld.php|admin/helloworld.php]]''
| this is the administrator entry point to the Hello World! component
|-
| 6
| ''[[#index.html|admin/sql/index.html]]''
| prevents web server from listing directory content
|-
| 7
| ''[[#index.html|admin/sql/updates/index.html]]''
| prevents web server from listing directory content
|-
| 8
| ''[[#index.html|admin/sql/updates/mysql/index.html]]''
| prevents web server from listing directory content
|-
| 9
| ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| file allowing to initialise schema version of the com_helloworld component.
|}

=== Installing the Hello World! Component ===
Using your preferred file manager, create a .zip file of this directory. For this example we will name the file <tt>com_helloworld.zip</tt>, again this file could have been named anything.

Now we need to install the Hello World! component. There are two ways to do this, both are covered in [[Installing an extension| Installing an Extension]]. Here we will cover the method using the Extension Manager of Joomla!.

*Using your preferred web browser, navigate to the Administrator panel of your Joomla! site. The address would be <tt><yoursite>/joomla/administrator/index.php</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php</tt>.
*Click Extensions {{rarr}} Manage {{rarr}} Install {{rarr}} Upload Package File {{rarr}} Choose File
*Navigate and Select File
*Click Upload & Install

Note - You should see a message letting you know if the installation succeeded or failed.

You can test this basic function of the component by entering the Hello World! page for the site and administrator portions of your Joomla! website.
* Using your preferred web browser, navigate to the Hello World! component page located on the site portion of your website. The address would be <tt><yoursite>/joomla/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/index.php?option=com_helloworld</tt>.
* Using your preferred web browser, navigate to the Hello World! component page located on the administrator portion of your website. The address would be <tt><yoursite>/joomla/administrator/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php?option=com_helloworld</tt>.

You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

==File Details== 
</translate>
{{vanchor|admin/sql/updates/mysql/0.0.1.sql}}
<translate>
is an empty file allowing to initialise schema version of the com_helloworld component.</translate>

<source lang="sql">
</source>

{{vanchor|helloworld.xml}}

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>December 2013</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>

{{vanchor|site/helloworld.php}}

<source lang="php">
Hello World
</source>

{{vanchor|admin/helloworld.php}}

<source lang="php">
Hello World administration
</source>

{{vanchor|index.html}}

<translate>
common to all folders</translate>

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

==Component Contents==
At this point in the tutorial, your component should contain the following files:
{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| this is an XML (manifest) file that tells Joomla! how to install our component.
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| this is the site entry point to the Hello World! component
|-
| 3
| ''[[#index.html|site/index.html]]''
| prevents web server from listing directory content
|-
| 4
| ''[[#index.html|admin/index.html]]''
| prevents web server from listing directory content
|-
| 5
| ''[[#admin/helloworld.php|admin/helloworld.php]]''
| this is the administrator entry point to the Hello World! component
|-
| 6
| ''[[#index.html|admin/sql/index.html]]''
| prevents web server from listing directory content
|-
| 7
| ''[[#index.html|admin/sql/updates/index.html]]''
| prevents web server from listing directory content
|-
| 8
| ''[[#index.html|admin/sql/updates/mysql/index.html]]''
| prevents web server from listing directory content
|-
| 9
| ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| file allowing to initialise schema version of the com_helloworld component.
|}

== Contributors ==
* [[User:Ribafs|Ribafs]]
* [[User:Cdemko|Christophe Demko]]
* [[User:Kevinkabatra|Kevin Kabatra]]

{{notice|<translate>
Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.</translate>}}

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Developing an MVC Component/Developing a Basic Component

2015-09-25T11:30:43Z

Gunjanpatel: /* Notes */

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate>
en</translate>}}

<translate>
== Notes ==
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

* If you have used Joomla! before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

* You can follow the steps below to create the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-1-basic-component.zip archive]

* Here are some slides based on this documents to explain how to create basic to advance joomla components. [http://bit.ly/joomlaWorkshopBasic Joomla! Basic Component Help]
[http://bit.ly/joomlaWorkshopAdvance Joomla! Advance Component Help]

== How to add a component to Joomla! ==
In this article we will cover how to create and install a basic Joomla! component. For this example we will be working with the Hello World! component.

To begin, you must first use your preferred file manager to create a directory for the Hello World! component. This directory can be anywhere on your file system, as long as it outside of your Joomla! installation directory. For this example we will name the directory <tt>com_helloworld</tt>, but this directory can be named anything.

Next, inside this directory we need to create some files. Using your preferred file manager, create the following files; as you create the files, add the source code for each file which is found in ''[[#File Details| File Details]]''.

{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| this is an XML (manifest) file that tells Joomla! how to install our component.
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| this is the site entry point to the Hello World! component
|-
| 3
| ''[[#index.html|site/index.html]]''
| prevents web server from listing directory content
|-
| 4
| ''[[#index.html|admin/index.html]]''
| prevents web server from listing directory content
|-
| 5
| ''[[#admin/helloworld.php|admin/helloworld.php]]''
| this is the administrator entry point to the Hello World! component
|-
| 6
| ''[[#index.html|admin/sql/index.html]]''
| prevents web server from listing directory content
|-
| 7
| ''[[#index.html|admin/sql/updates/index.html]]''
| prevents web server from listing directory content
|-
| 8
| ''[[#index.html|admin/sql/updates/mysql/index.html]]''
| prevents web server from listing directory content
|-
| 9
| ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| file allowing to initialise schema version of the com_helloworld component.
|}

=== Installing the Hello World! Component ===
Using your preferred file manager, create a .zip file of this directory. For this example we will name the file <tt>com_helloworld.zip</tt>, again this file could have been named anything.

Now we need to install the Hello World! component. There are two ways to do this, both are covered in [[Installing an extension| Installing an Extension]]. Here we will cover the method using the Extension Manager of Joomla!.

*Using your preferred web browser, navigate to the Administrator panel of your Joomla! site. The address would be <tt><yoursite>/joomla/administrator/index.php</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php</tt>.
*Click Extensions {{rarr}} Manage {{rarr}} Install {{rarr}} Upload Package File {{rarr}} Choose File
*Navigate and Select File
*Click Upload & Install

Note - You should see a message letting you know if the installation succeeded or failed.

You can test this basic function of the component by entering the Hello World! page for the site and administrator portions of your Joomla! website.
* Using your preferred web browser, navigate to the Hello World! component page located on the site portion of your website. The address would be <tt><yoursite>/joomla/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/index.php?option=com_helloworld</tt>.
* Using your preferred web browser, navigate to the Hello World! component page located on the administrator portion of your website. The address would be <tt><yoursite>/joomla/administrator/index.php?option=com_helloworld</tt>. For this example we will navigate to <tt>localhost/joomla/administrator/index.php?option=com_helloworld</tt>.

You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

==File Details== 
</translate>
{{vanchor|admin/sql/updates/mysql/0.0.1.sql}}
<translate>
is an empty file allowing to initialise schema version of the com_helloworld component.</translate>

<source lang="sql">
</source>

{{vanchor|helloworld.xml}}

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>December 2013</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>

{{vanchor|site/helloworld.php}}

<source lang="php">
Hello World
</source>

{{vanchor|admin/helloworld.php}}

<source lang="php">
Hello World administration
</source>

{{vanchor|index.html}}

<translate>
common to all folders</translate>

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

==Component Contents==
At this point in the tutorial, your component should contain the following files:
{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| this is an XML (manifest) file that tells Joomla! how to install our component.
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| this is the site entry point to the Hello World! component
|-
| 3
| ''[[#index.html|site/index.html]]''
| prevents web server from listing directory content
|-
| 4
| ''[[#index.html|admin/index.html]]''
| prevents web server from listing directory content
|-
| 5
| ''[[#admin/helloworld.php|admin/helloworld.php]]''
| this is the administrator entry point to the Hello World! component
|-
| 6
| ''[[#index.html|admin/sql/index.html]]''
| prevents web server from listing directory content
|-
| 7
| ''[[#index.html|admin/sql/updates/index.html]]''
| prevents web server from listing directory content
|-
| 8
| ''[[#index.html|admin/sql/updates/mysql/index.html]]''
| prevents web server from listing directory content
|-
| 9
| ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| file allowing to initialise schema version of the com_helloworld component.
|}

== Contributors ==
* [[User:Ribafs|Ribafs]]
* [[User:Cdemko|Christophe Demko]]
* [[User:Kevinkabatra|Kevin Kabatra]]

{{notice|<translate>
Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.</translate>}}

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_view_to_the_site_part|Next: Adding a view to the site part</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Creating a simple module/Developing a Basic Module

2015-03-17T11:25:01Z

Gunjanpatel: Apply Coding standard

{{Chunk30:Creating a Simple Module for Joomla!3.x - Contents}}
A module is a lightweight and flexible extension. They are used for small bits of the page that are generally less complex and are able to be seen across different components.

You can see many examples of modules in the standard Joomla! install: - menus - Latest News - Login form - and many more.

This tutorial will explain how to go about creating a simple Hello World module. Through this tutorial you will learn the basic file structure of a module. This basic structure can then be expanded to produce more elaborate modules.

== File Structure ==

There are four basic files that are used in the standard pattern of module development:
* <code>mod_helloworld.php</code> - This file is the main entry point for the module. It will perform any necessary initialization routines, call helper routines to collect any necessary data, and include the template which will display the module output.

* <code>mod_helloworld.xml</code> - This file contains information about the module. It defines the files that need to be installed by the Joomla! installer and specifies configuration parameters for the module.

* <code>helper.php</code> - This file contains the helper class which is used to do the actual work in retrieving the information to be displayed in the module (usually from the database or some other source).

* <code>tmpl/default.php</code> - This is the module template. This file will take the data collected by mod_helloworld.php and generate the HTML to be displayed on the page.

== Creating mod_helloworld.php ==

The mod_helloworld.php file will perform three tasks:
* include the helper.php file which contains the class to be used to collect the necessary data
* invoke the appropriate helper class method to retrieve the data
* include the template to display the output.

The helper class is defined in our helper.php file. This file is included with a require_once statement:

<source lang="php">require_once( dirname(__FILE__) . '/helper.php' );</source>

<code>require_once</code> is used because our helper functions are defined within a class, and we only want the class defined once.

Our helper class has not been defined yet, but when it is, it will contain one method: getHello(). For our basic example, it is not really necessary to do this - the “Hello, World” message that this method returns could simply be included in the template. We use a helper class here to demonstrate this basic technique.

Our module currently does not use any parameters, but we will pass them to the helper method anyway so that it can be used later if we decide to expand the functionality of our module.

The helper class method is invoked in the following way:

<source lang="php">$hello = modHelloWorldHelper::getHello($params);</source>

=== Completed mod_helloworld.php file ===

The complete mod_helloworld.php file is as follows:

<source lang="php"><?php
/**
* Hello World! Module Entry Point
*
* @package Joomla.Tutorials
* @subpackage Modules
* @link http://docs.joomla.org/J3.x:Creating_a_simple_module/Developing_a_Basic_Module
* @license GNU/GPL, see LICENSE.php
* mod_helloworld is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*/

// no direct access
defined('_JEXEC') or die;
// Include the syndicate functions only once
require_once( dirname(__FILE__) . '/helper.php' );

$hello = modHelloWorldHelper::getHello($params);
require( JModuleHelper::getLayoutPath('mod_helloworld'));
?>
</source>

The one line that we haven’t explained so far is the first line. This line checks to make sure that this file is being included from the Joomla! application. This is necessary to prevent variable injection and other potential security concerns.

== Creating helper.php ==

The helper.php file contains that helper class that is used to retrieve the data to be displayed in the module output. As stated earlier, our helper class will have one method: getHello(). This method will return the ‘Hello, World’ message.

Here is the code for the helper.php file:

<source lang="php"><?php
/**
* Helper class for Hello World! module
*
* @package Joomla.Tutorials
* @subpackage Modules
* @link http://docs.joomla.org/J3.x:Creating_a_simple_module/Developing_a_Basic_Module
* @license GNU/GPL, see LICENSE.php
* mod_helloworld is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
*/
class ModHelloWorldHelper
{
/**
* Retrieves the hello message
*
* @param array $params An object containing the module parameters
*
* @access public
*/
public static function getHello($params)
{
return 'Hello, World!';
}
}

</source>

There is no rule stating that we must name our helper class as we have, but it is helpful to do this so that it is easily identifiable and locatable. Note that it is required to be in this format if you plan to use the com_ajax plugin.

More advanced modules might include database requests or other functionality in the helper class method.

== Creating tmpl/default.php ==

The default.php file is the template which displays the module output.

The code for the default.php file is as follows:

<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die; ?>
<?php echo $hello; ?>
</source>

An important point to note is that the template file has the same scope as the mod_helloworld.php file. What this means is that the variable $hello can be defined in the mod_helloworld.php file and then used in the template file without any extra declarations or function calls.

== Creating mod_helloworld.xml ==

The mod_helloworld.xml is used to specify which files the installer needs to copy and is used by the Module Manager to determine which parameters are used to configure the module. Other information about the module is also specified in this file.

The code for mod_helloworld.xml is as follows:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="module" version="3.1.0" client="site" method="upgrade">
<name>Hello, World!</name>
<author>John Doe</author>
<version>1.0.0</version>
<description>A simple Hello, World! module.</description>
<files>
<filename>mod_helloworld.xml</filename>
<filename module="mod_helloworld">mod_helloworld.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>
<config>
</config>
</extension>
</source>

[[Manifest files]] explains the technical details of the elements used in the XML file.

You will notice that there are two additional files that we have not yet mentioned: index.html and tmpl/index.html. These files are included so that these directories cannot be browsed. If a user attempts to point their browser to these folders, the index.html file will be displayed. These files can be left empty or can contain the simple line:

<source lang="html4strict"><html><body bgcolor="#FFFFFF"></body></html></source>

which will display an empty page.

Since our module does not use any [[Form_field|form fields]], the config section is empty.

== Conclusion ==

Module development for Joomla! is a fairly simple, straightforward process. Using the techniques described in this tutorial, an endless variety of modules can be developed with little hassle.

<noinclude>
[[Category:Module Development]]
</noinclude>

SQL Optimisation Working Group

2014-11-13T05:22:16Z

Gunjanpatel: /* Joomla! 4 SQL Optimization Plan */

== Team Members ==

* Nadeeshaan Gunasinghe
* [[User:Gunjanpatel|Gunjan Patel]] (Working Group Coordinator)
* Thomas Hunziker (PLT Contact: thomas.hunziker at joomla.org)
* Nicola Galgano
* Eli Aschkenasy
* Mrunal Pittalia
* Steven Pignataro

== Goal of the Project ==

''Joomla!, being one of the top content management systems in the world, is constantly faced with stiff competition. Often times what is considered important about any CMS are the enhancements and the feature sets a specific CMS has. There is another (sometimes overlooked) important fact which we need to pay attention to as we consider the end-user’s needs, which is the speed of the software. This depends on a multitude of factors but the top-most bottleneck is often the database management system and the way we use it to store and retrieve data.''

In the SQL optimization working group we are mainly focused on the above mentioned fact. Our vision is to provide the community a faster way in which the CMS interacts with the DB by reducing the database management system based overheads.

You can see the foundation of our work group idea here, [[GSOC_2014_Project_Ideas#Project:_SQL_Optimization|GSOC 2014 Project: SQL Optimization]]

== Current Status ==

* We have started this project as a Google Summer of Code SQL Optimisation Project https://www.google-melange.com/gsoc/project/details/google/gsoc2014/nadeeshaan/5657382461898752
* Sent Pull Request on Joomla-CMS which can be found here https://github.com/joomla/joomla-cms/pulls/nadeeshaan

== The immediate areas we focused on were: ==

* Categories related query optimization
* Articles related query optimization
* Tags, menus, languages related optimization
* Nested set optimization as a research project

:Based on the above criteria we have submitted optimization work to the community and the current work can be seen at https://github.com/nadeeshaan/JGSoC-SQL-Optimisation . In the future we are planning to move this project to https://github.com/joomla-projects/GSoC-SQL-Optimization to ensure continuation of this work.

== Roadmap & Future Plans ==

:We are focused to improve the Joomla database performance as well as the database access performance by efforts such as query refactoring and re-engineering. As our main target we are hoping to give a major priority for the schema redesign and also the nested sets optimization. At the moment we have laid the groundwork for the nested-set optimization but there is a lot more refactoring to be done.
:In addition we are planning to improve the Joomla! Debug Plugin to measure previous query time and time difference between old and new queries.

'''Following are the main areas that still need extensive work:'''

* Nested sets database schema redesign
* Debug Plugin improvement to measure query performance
* Find the rest of the huge queries and bottleneck of the software regarding performance
* Optimise queries of different views

== Joomla! 4 SQL Optimization Plan ==
While we currently focus mainly on optimizing existing queries it is important to understand that we’re extremely limited due to backwards compatibility requirements. It is our hope that for Joomla! 4 the DB schema can be revisited and perhaps totally re-written. F0F has internally implemented various DB functions (specifically in the nested-sets area) that should be part of how core joomla tables are accessed.

== Read More ==
You may read more about us on [http://volunteers.joomla.org/working-groups/sql-optimization-working-group#reports Joomla! Volunteers Portal - SQL Optimization Working Group]

[[Category:Working Groups]]
[[Category:PLT]]

SQL Optimisation Working Group

2014-11-13T05:21:52Z

Gunjanpatel: /* Joomla! 4 SQL Optimization Plan */

Component Patchtester for Testers

2014-11-10T11:51:44Z

Gunjanpatel: ~~~~Added note to use http://issues.joomla.org/

<noinclude><languages /></noinclude>
<translate>
Patch Tester is a Joomla extension that allows you to easily apply changes from pull requests. This extension helps Joomla community members test Joomla CMS bug fixes.</translate>

[[File:com_patchtester.jpg|center|750px|com_patchtester]]

<translate>
== Download com_patchtester == 
Download the component at:</translate> https://github.com/joomla-extensions/patchtester/releases/tag/2.0.beta

<translate>
== Tutorial == 
You can see a video tutorial here:</translate> http://www.youtube.com/watch?v=4OWgusZgIfk&feature=youtube_gdata

''Note: This video is showing example using old tracker. Please user http://issues.joomla.org/ for testing and reporting issues.''

{{#ev:youtube|4OWgusZgIfk}}

<translate>

== Authors == 
Patch tester component was originally created by Ian Maclennan, and has been improved by Nikolai Plath and Michael Babker.</translate>

<translate>
You can find most updated source code at:</translate> https://github.com/joomla-extensions/patchtester
<translate>
== Additional Information == 


* [[S:MyLanguage/Testing_Joomla!_patches|Testing Joomla! patches]] using Patchtester
* [[S:MyLanguage/Filing bugs and issues|Filing bugs and issues]]
* [[S:MyLanguage/Bug_and_Issue_Tracker_Priority|Bug and Issue Tracker Priority]]
</translate>
<translate>
[[Category:Bug Tracker]]
[[Category:Video]]
[[Category:Testing]]</translate>

SQL Optimisation Working Group

2014-10-23T11:59:32Z

Gunjanpatel: ~~~~ Adding SQL Optimisation Working group page

== Team Members ==

* Nadeeshaan Gunasinghe
* [[User:Gunjanpatel|Gunjan Patel]] (Working Group Coordinator)
* Thomas Hunziker (PLT Contact: thomas.hunziker at joomla.org)
* Nicola Galgano
* Eli Aschkenasy
* Mrunal Pittalia

== Goal of the Project ==

:Joomla!, being one of the top content management systems in the world, is constantly faced with stiff competition. Often times what is considered important about any CMS are the enhancements and the feature sets a specific CMS has. There is another (sometimes overlooked) important fact which we need to pay attention to as we consider the end-user’s needs, which is the speed of the software. This depends on a multitude of factors but the top-most bottleneck is often the database management system and the way we use it to store and retrieve data.
:In the SQL optimization working group we are mainly focused on the above mentioned fact. Our vision is to provide the community a faster way in which the CMS interacts with the DB by reducing the database management system based overheads.
:You can see the foundation of our work group idea here, http://docs.joomla.org/GSOC_2014_Project_Ideas#Project:_SQL_Optimization

== Current Status ==

* We have started this project as a Google Summer of Code SQL Optimisation Project https://www.google-melange.com/gsoc/project/details/google/gsoc2014/nadeeshaan/5657382461898752
* Sent Pull Request on Joomla-CMS which can be found here https://github.com/joomla/joomla-cms/pulls/nadeeshaan

== The immediate areas we focused on were: ==

* Categories related query optimization
* Articles related query optimization
* Tags, menus, languages related optimization
* Nested set optimization as a research project

:Based on the above criteria we have submitted optimization work to the community and the current work can be seen at https://github.com/nadeeshaan/JGSoC-SQL-Optimisation . In the future we are planning to move this project to https://github.com/joomla-projects/GSoC-SQL-Optimization to ensure continuation of this work.

== Roadmap & Future Plans ==

:We are focused to improve the Joomla database performance as well as the database access performance by efforts such as query refactoring and re-engineering. As our main target we are hoping to give a major priority for the schema redesign and also the nested sets optimization. At the moment we have laid the groundwork for the nested-set optimization but there is a lot more refactoring to be done.
:In addition we are planning to improve the Joomla! Debug Plugin to measure previous query time and time difference between old and new queries.

'''Following are the main areas that still need extensive work:'''

* Nested sets database schema redesign
* Debug Plugin improvement to measure query performance
* Find the rest of the huge queries and bottleneck of the software regarding performance
* Optimise queries of different views

== Joomla! 4 SQL Optimization Plan ==
While we currently focus mainly on optimizing existing queries it is important to understand that we’re extremely limited due to backwards compatibility requirements. It is our hope that for Joomla! 4 the DB schema can be revisited and perhaps totally re-written. F0F has internally implemented various DB functions (specifically in the nested-sets area) that should be part of how core joomla tables are accessed.

Pizza Bugs and Fun October 17, 2014

2014-10-16T12:09:26Z

Gunjanpatel: /* India */

[[Image:pbf.png|225px|left]]

A Joomla! Pizza, Bugs and Fun event is scheduled for Friday, October 17, 2014. The event is global for virtual participants (both businesses and individuals), with local venues wherever they are organized. The key goal is to fix as many Joomla 3 and Joomla 2.5 bugs as possible.

'''See the section [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#General_Instructions General Instructions] below for instructions.'''

This wiki will be used as the central resource for coordinating efforts and accumulating results from this event.

Follow [https://twitter.com/joomlabugsquad @JoomlaBugSquad] on Twitter for updates during PBF and some social fun. The ''Twitter''' hash tag is #JoomlaPBF.
<div style="clear:left;" />
== Goals ==
* '''Bugs''' : We will be working through the [http://issues.joomla.org/ CMS Issue Tracker] where there are bug reports needing patches and/or testing.
* '''Documentation''' : If you want to help out writing documentation, you're also more than welcome. See the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#If_you_want_to_work_on_Documentation Documentation Details] below for suggestions.

== Organization, logistics and communications ==

=== Communication ===
See the [[Pizza_Bugs_and_Fun_October_17,_2014#Chat|Chat section]].

=== Training Sessions ===
There will be an optional webinar training session on 16 October, 2014 at 15:00 UTC. We'll post the link here an hour before.

Also, on 16 October, 2014, [[Pizza_Bugs_and_Fun_October_17,_2014#Chat|the chat]] will be open for a Q&A and for help getting started.

=== Recognition ===
We've dubbed the event as a Business PBF, since it's the second PBF on a weekday (Friday) and we'd like to get more business involved. We've created badges that you can use on your sites to spread awareness of the event and get recognition for your participation: http://developer.joomla.org/pbf

Furthermore, we'd like to give you more recognition and highlight your pledge of participation by placing your logo and a link to your site on the landing page: http://developer.joomla.org/pbf

There are four participations levels: Epic, Platinum, Gold, and Silver. Platinum is for 10 hours or more pledged to the event. Gold is four hours or more pledged. Silver is pledged to participate in the event. And Epic for 100+ hours pledged!

So, for example, if Company ABC had five of their developers for two hours, then they could use the Platinum badge and have their logo (and link) in the platinum area on the landing page.

The hours you choose to pledge towards the event is totally up to you as an individual or business. As a bonus, if you write a blog post about the event, you can count it as 30 minutes towards your pledge. So if you pledged 5 hours and write a blog post, you'd be helping at the event for 4.5 hours.

Finally, on the day of the event, come and go as you'd like and fulfill your pledged hours. You can help with testing bug fixes, reporting bugs, coding bug fixes, etc. Most of all, enjoy every minute! Have fun, enjoy the fellowship, learn, and make Joomla better for you, your business, your clients, and your friends.

=== General Instructions ===

These instructions may change as we get closer to the event.

==== Task List ====
We have a list of [http://issues.joomla.org/?label=38 suggested items] available to work on. They range from very easy to intermediate difficulty. However, you're not just limited to this list and using the below process you can test/code for any items:

==== If you want to test bug fixes (i.e. patches) ====
* Look for issues with a status of Pending. We want at least 2 testers and more on complex issues, so you can test what others have tested already.
* Use the [http://issues.joomla.org/ CMS Issue Tracker] as usual, which means you can use the [[Component Patchtester for Testers|Joomla Patch Tester]].
* Most of the issues should have test instructions with them.
* Once you have tested, add comments to the tracker on your results. Start your comment with @test so you will get counted in the stats as a tester. If the test is successful check of a successful text box.
* Note: You don't have to delete the installation folder when you are using the development version of Joomla. This allows you to reinstall just by deleting the configuration.php file.
* Note: See the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#FAQ FAQ] on how to apply a Git pull request.

:<h5>Helpful Documentation</h5>
:* [[Component Patchtester for Testers]] - We'd recommend beginners to use the [[Component Patchtester for Testers|Joomla Patch Tester]]

==== If you want to code bug fixes ====
* Use the [http://issues.joomla.org/ CMS Issue Tracker] as usual, looking for the issues with a status of Confirmed.
* Send in a [[Git for Coders|pull request (PR)]]. Add testing instructions if they don't already exist.{{-}}<h5>Helpful documentation</h5>
:* [[Component Patchtester for Testers]]
:* [[Git for Testers and Trackers]]
:* [[Using the Github UI to Make Pull Requests]] - this is the easiest way to submit simple pull requests
:* [[Git for Coders]]
:* [[Working with git and github/My first pull request]]
:* [[Secure coding guidelines]]
:* [[Development Best Practices]]
:* [http://www.slideshare.net/patelgunjan/joomla-pizza-bugs-and-fun-2014-preevent-seminar Joomla! Pizza Bugs and Fun 2014 pre-event Seminar]

==== If you want to work on Documentation ====
* To edit this Documentation Wiki, you will need a user account on the wiki. If you don't already have one, you may register on [[Special:UserLogin]]. You only need a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets.
* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] and our use of [[User:Abuse filter|Abuse filters]] for new users.
* Get your user account a few days before and make sure that you are able to sign in since the automatic authorization system can lock some people out.
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
* During the PBF, several experienced Wiki editors will be available in the chat to help you.

{{:{{PAGENAME}}/Documentation needs}}

=== Pizza ===
We are offering pizza (or any comparable locally popular main course) and soda for pre-registered groups. We are not setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Nick Savov (nick.savov[at]community.joomla[dot]org , replace [at] with @ and [dot] with .) before the event to register and get details.

== Locations ==

If you want to get people together and have a venue to share, please add it below. Share as much as possible details like exact location, url for more information about the venue, ways to register, date and time the venue is available etc.

If you set up a location please send contact information to Nick Savov (nick.savov[at]community.joomla[dot]org , replace [at] with @ and [dot] with .). Feel free to contact him with any questions.

===Virtual===

The event is global and across all timezones on October 17th, 2014 (48 hours total). You can come and go as you'd like and fulfill your pledged hours. You can help with testing bug fixes, reporting bugs, coding bug fixes, etc. Most of all, enjoy every minute! Have fun, enjoy the community, learn, and make Joomla better for you, your business, your clients, and your friends.

There are also some physical venues... see below.

====Twitter====
Follow [https://twitter.com/joomlabugsquad @JoomlaBugSquad] on Twitter for updates during PBF and some social fun. The ''Twitter''' hash tag is #JoomlaPBF.

====Chat====
We have a dedicated chat for the PBF event at https://joomla.slack.com/messages/pbf/

All registrants manually get emailed an invite link soon after they complete the [https://docs.google.com/a/community.joomla.org/forms/d/1yQRmN9U3ob0iIsGWiemuwqU3Sp5twCS95P6vvI7BN8M/viewform pledge form]. If you have a team, please email nick.savov[.at.]community.joomla.org with a list of your team members emails, so that invites can be sent to them.

=== Europe ===

==== Netherlands ====
[http://www.joomlacommunity.eu/nieuws/joomla-in-nederland/976-joomla-pizza-bugs-en-fun-nederland.html Joomla Pizza, Bugs & Fun in Enschede, The Netherlands]
Date: Friday, October 17, from 10:30 - 18:00
Location: de Bibliotheek, Pijpenstraat 15, 7511 GM Enschede
To attend, please add yourself to: http://www.joomlacommunity.eu/joomla-gebruikersgroepen/details/483.html

==== France ====
[http://joomla.fr/actualites-de-joomlaorg/joomla-pizza-bugs-and-fun-professionnel-automne-2014 Joomla Pizza, Bugs & Fun à Lyon, France]
Date: Friday, October 17
Time: We're open all day long so people can come and go
Location: Acyba - Hikari Software, 110 Avenue Barthélémy Buyer, 69009 Lyon
To attend or for more information, please email nicolas[.at.]hikashop.com

[http://joomla.fr/actualites-de-joomlaorg/joomla-pizza-bugs-and-fun-professionnel-automne-2014 Joomla Pizza, Bugs & Fun à Toulouse, France]
Date: Friday, October 17
Time: We're open all day long so people can come and go
Location: Agence Com'3elles, Immeuble Anadyr, 108 route d'Espagne, 31100 Toulouse
To attend or for more information, please email celine.robert[.at.]@com3elles.com

==== Denmark ====
Joomla Pizza, Bugs & Fun in Denmark
Date: Friday, October 17
Time: 10:00am-6:00pm
Location: redWEB HQ, Blangstedgårdsvej 1, 5220 Odense SØ
To attend, please write to: pbf[.at.]redweb.dk

==== Bulgaria ====
Joomla Pizza, Bugs & Fun in Bulgaria
Date: Friday, October 17
Time: 9:00-15:00
Location: SiteGround at Racho Petkov Kazandjiata 8, Sofia
To attend, please email: events[.at.]siteground.com

=== North America ===

=== South America ===

=== Asia/Pacific ===

==== India ====
[http://tasolglobal.com/ '''Tailored Solutions Pvt. Ltd.''']
Date: Friday, October 17, from 9:00 am to 6:30 pm.
Location: 406, Arth Complex,
Anand nagar Road,
Satellite,
Ahmedabad - 380015,
Gujarat, India.

[http://www.meetup.com/Joomla-User-Group-Pune/events/211495652/ Joomla Pizza, Bugs & Fun in Pune, India]
Date: Saturday, October 18, from 15:00 to 22:00
Location: Techjoomla/ Tekdi Technologies Offices, Office No.6, Silver Fern Building. Karve Road. Opposite Kothrud Bus Stand & Above Canara Bank., Pune

==== Thailand ====
CMSPlugin.com's Team and Marvelic Engine' Team
Date: Friday, October 17, from 10:00 to 20:00
Localtion : Marvelic Engine Co.,Ltd., 719 KPN Tower, 10/F, Rama 9 Road. Huaykwang, Bangkok 10310.
[http://www.marvelic.co.th/th/contact-us.html http://www.marvelic.co.th/th/contact-us.html]

=== Africa ===

=== Middle East ===

== Registration ==
=== For write access to this wiki ===
To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. This is the same login for updating Joomla documentation.

=== At a physical location ===
If you wish to be present at one of the physical locations listed above then you must register in advance because space most likely is limited. Registrations are the responsibility of the individual location organizers and you should click on the appropriate link above for more information.

=== Taking bugs, tasks and pizza ===

Please check the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#Organization.2C_logistics_and_communications Organization, logistics and communications section] for details on how to get involved in working on tasks.

==Requirements==
* All code must be made available under the [http://www.gnu.org/licenses/gpl-2.0.html General Public Licence version 2].
* All documentation contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]
* No advertising or self-promotion will be allowed. This includes back links to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Pizza Bugs and Fun October 17, 2014/Contributors List|Contributors List]]
* All contributions must be in English. Note that the official language of the Joomla! project is British English.

== FAQ ==
Q: Where is the code for Joomla?

A: The current Joomla code can be found on GitHub.

*GitHub - https://github.com/joomla/joomla-cms

Q: Which one is 3.3?

A: On GitHub, it is the staging branch: [https://github.com/joomla/joomla-cms https://github.com/joomla/joomla-cms]

Q: Which one is 2.5?

A: On GitHub, it is the 2.5.x branch: [https://github.com/joomla/joomla-cms/tree/2.5.x https://github.com/joomla/joomla-cms/tree/2.5.x]

Q: How do I apply a Git pull request?

A: Use the [[Component Patchtester for Testers|Joomla Patch Tester]]

==Contributors==
{{:Pizza Bugs and Fun October 17, 2014/Contributors List}}

<noinclude>[[Category:Bug Squad]]
[[Category:Development]][[Category:Events]]</noinclude>

Git for Coders

2014-10-14T04:57:09Z

Gunjanpatel: adding github work flow for joomla

=Overview=
This article shows you how to use Git and Github to code and submit changes to the Joomla CMS. If you are not familiar with Git, you may wish to read the tutorial [[Git_for_Testers_and_Trackers | Git for Testers and Trackers]] first.

''IMPORTANT NOTE: Git is a very powerful system and there is usually more than one way to accomplish the same thing in Git. This tutorial does not try to cover all of the different ways you could do these tasks. Instead, it covers one (hopefully simple) way to do it. As you become more familiar with Git, you may find other ways that work better for you.''

The first step is to set up the remote and local Git repositories. You do this once. Once it is set up, the normal workflow is:
# Update your local and remote repositories with changes others have committed to the main Joomla CMS repository.
# Create a branch for each issue or feature you are working on and commit your changes to the branch in your local repository.
# Update your remote repository on Github with your branches.
# Create a pull request from your Github branch. Alternatively, you can create a patch or diff file from your local branch and post that to the tracker.
# Update the Joomla Issue tracker or Joomla Feature tracker so that others can test your code.

Each of these steps is explained below. Note that you can use Git from the command line, from an IDE such as Eclipse (with the eGit plugin), or from a stand-alone tool, such as TortoiseGit. Here we will use the command line and, where applicable, show the equivalent command in Eclipse eGit.

NOTE: If you want to propose a simple code change, you can do it directly from Github.com, without setting up anything on your local PC. See [[Using_the_Github_UI_to_Make_Pull_Requests|Using the Github UI to Make Pull Requests]].

=Setup=
== Github Work flow for Joomla! ==

[[File:Github work flow joomla.png]]

== Create Your Forked Repository on Github==
Github allows you to create your own copy of any public repository, including the Joomla CMS. This is your personal copy of the repository and is called a "fork". To create a fork of the Joomla CMS:
# If you haven't already, register on Github.com and log in.
# Navigate to [https://github.com/joomla/joomla-cms https://github.com/joomla/joomla-cms]
# Click on the Fork button in the upper right part of the screen.

Note that you can only create one fork of any given repository. However, as we will see, you can create as many branches (versions) of your repository as you like.

== Clone Your Github Repository To Your PC ==
At this point, you have your own repository on Github.com. Now you need to create a local repository that is a copy (called a "clone") of the Github repository. To do this:
===CLI (command line) Commands===
# Change directory to the directory where you want the Joomla files to be stored (for example, <code>C:\xampp\htdocs\joomla\my-project</code> or <code>/opt/lampp/htdocs/joomla/my-project</code>).
# Enter the command: <code>git clone <nowiki>https://github.com/<your Github user name>/joomla-cms.git</nowiki> .</code> For example, if your Github user name is "joomla-coder", the command would be: <code>git clone <nowiki>https://github.com/joomla-coder/joomla-cms.git</nowiki> .</code>

You can get the URL for the command above from your repository at Github.com as shown below. [[File:git-coders-tutorial-20121009-03.png|frame|none]]

Note that the "." dot just tells Git to put the new repository in the current directory. The system will work for a few minutes while it downloads all of the files. When it is finished, you will have a complete set of Joomla files under version control in the current directory.

=== Eclipse Commands ===
# If you like, you can get the URL from Github as shown below. [[File:git-coders-tutorial-20121009-03.png|frame|none]] You will use this later on.
# In Eclipse, open the Git Repositories view and click the button called "Clone a Git Repository and add the clone to this view" as shown below. [[File:git-coders-tutorial-20121009-01.png|frame|none]].
# The window below will show. [[File:git-coders-tutorial-20121009-02.png|frame|none]] Select URI and click Next.
# The window below will show. [[File:git-coders-tutorial-20121009-04.png|frame|none]] Enter the Github URL for your repository (from step (1) above). Enter your Github user name and password and check the box called "Store in Secure Store".
# Click Next and the window below will show. [[File:git-coders-tutorial-20121009-05.png|frame|none]]
# Click Next to select all branches. The window below will show. [[File:git-coders-tutorial-20121009-06.png|frame|none]]
# In Directory, enter the folder where you want the Joomla files to be copied. Keep the default values for Initial branch ("master") and Remote name ("origin") as shown.
# Click Finish. The system will work for a few minutes. When it finishes you will have a clone of the remote repository.

== Create an Upstream Remote==
Now we have our local repository. This has a remote called "origin" that points to our personal fork of Joomla on Github.

In a project like Joomla, many users are submitting bug fixes and features. These changes are committed to the main Joomla CMS repository frequently. It is up to each coder to keep their personal repositories up to date with these changes. Fortunately, as we will see, this is easy to do.

The last step in the setup is to create a second remote called "upstream" that points to the main Joomla CMS repository. We will use this remote to pull changes that others make to the main Joomla repository so we can keep our personal repositories up to date.

===CLI Command ===
To create a remote called "upstream" that points to the main CMS repository, enter this command:

<code>git remote add upstream <nowiki>https://github.com/joomla/joomla-cms.git</nowiki></code>

Note, if you get a error like "fatal: Not a git repository (or any of the parent directories): .git", then make sure you've changed directory to the new repository that's been created within the current directory (so one level lower).

===Eclipse Command===
''Unknown at this time.''

At this point, you have your personal remote repository (created by "forking" the Joomla CMS project) and your personal local repository (created with CLI or Eclipse). Now you are ready to code patches and features.

=Normal Workflow=
Now that we have done our one-time setup, we are ready to start our normal workflow. This is outlined below.

== Create a New Feature or Bug Fix Change==
Let's say you are ready to start working on a new bug fix or a new feature. Here are the steps you would normally follow.
# Update your master branches. Update the master branch of your local and Github repositories with the latest CMS changes.
# Create a branch for writing the new code
# In the new branch, code the changes and commit them. Depending on the length of time, you can make multiple commits to the branch.
# When you are ready to propose your code for testing (or when you want others to be able to see it), push the branch to your Github repository.
# When you are ready to submit the code, either:
## Create a pull request on Github, or
## Create a patch or diff file and post to the Joomlacode tracker.

Each of these steps is explained in more detail below.

=== Update Your Master Branches ===
You need to keep your repositories up to date with changes made by others in the main CMS repository. It's easy to do, and here are the steps. These are done more easily with the CLI than with Eclipse.

IMPORTANT NOTE: Make sure you never commit your own code changes to the master branch. If you do, you won't be able to keep it synchronized with the master branch on the main CMS repository.

====CLI Commands====
* Make sure you are in your master branch of your local repository (<code>git checkout master</code>). If you aren't sure, you can use the command <code>git status</code> to see what branch you are on.
* Enter the command: <code>git pull upstream master</code>. You should get a message showing the changes, similar to this:
$ git pull upstream master
From <nowiki>https://github.com/joomla/joomla-cms</nowiki>
* branch master -> FETCH_HEAD
Updating 76feee8..294c62c
Fast-forward
installation/CHANGELOG | 3 +++
installation/language/fr-FR/fr-FR.ini | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
Mark@MARK2009 /c/xampp/htdocs/joomla-coder/joomla-cms (master)
:If your local repository was already up to date, you will get a message like this:
$ git pull upstream master
From <nowiki>https://github.com/joomla/joomla-cms</nowiki>
* branch master -> FETCH_HEAD
Already up-to-date.

* At this point, your local master branch is up to date with the main CMS repository. Now you need to update the master branch of your Github repository. Enter the command: <code>git push origin master</code>. You should see a message like this:
$ git push origin master
To <nowiki>https://github.com/joomla-coder/joomla-cms.git</nowiki>
76feee8..294c62c master -> master

NOTE: If you haven't stored your user name and password, you will be prompted for them after you enter the push command. See below for how to store your credentials so you don't have to type them each time.

At this point, your master branches on your local and Github repositories are up to date with the main CMS repository. Now, when you create a new branch, it will start at this point and be based on the latest code.

===Create a Branch for the Code===
In Git, the best practice is to use a branch for each bug fix or feature. (In fact, experienced Git users will often create more than one branch for an individual project, perhaps trying different approaches to the problem.) It is super easy to create, delete, and even combine branches. Use a naming convention that allows you to keep track. For example, you could incorporate the tracker issue number into the branch name (for example, "php-notice-12345").

When you create a new branch, it starts from the branch you are currently on. For this reason, you will normally want to make sure you are in your master branch when creating a new one.

====CLI Commands====
<code>git branch xxx</code> where "xxx" is the new branch name. Note: If you already have a branch you are working on, use the command: <code>git checkout xxx</code>.

====Eclipse Commands====
#Left-click on the PHP project and select Team→Switch To→New Branch as shown below. [[File:Git-coders-tutorial-20121009-07.png|frame|none]]. The screen below will show. [[File:Git-coders-tutorial-20121009-08.png|frame|none]]
#Fill in the name of the new branch and click finish.

===Code and Commit to the Branch===
Finally, we are to the fun part! Here we are actually coding and testing our feature or bug fix. The normal workflow is as follows:
# Do some coding.
# Commit your work to your branch.
# Repeat until you are done.

Here are the commands to commit your work to your branch. Make sure you are in the right branch before committing! (Use <code>git status</code> to check.)

====CLI Commands====
* To commit all of the changes since the last commit: <code>git commit -m "My commit message" -a</code>
* To undo any file changes since the last commit: <code>git reset --hard</code>
* To remove any added files and folder since the last commit: <code>git clean -d -f</code>
* To change the last commit: <code>git commit --amend</code>

====Eclipse Commands====
* To commit all changes, right-click on project, select Team→Commit to show this window. [[File:Git-coders-tutorial-20121009-09.png|frame|none]]
* To undo any file changes since the last commit, select Team→Reset and check the Hard Reset Type as shown below. [[File:Git-coders-tutorial-20121009-10.png|frame|none]]
* To change the last commit, select Team→Commit and check the Amend Previous Commit button (as shown in the Commit Changes screenshot above).

===Push Branch to Github===
In the previous workflow, we created the branch and committed changes to our local repository. If we want others to be able to see the branch or to create a pull request, we need to push the branch to our personal repository on Github.

====CLI Command====
To push a branch to your personal Github repository: <code>git push origin xxx</code> (where "xxx" is the name of your branch).

===Submit Pull Request or Patch File===
There are two ways you can submit a proposed code change to the Joomla CMS project. One is to submit a pull request via Github, the other is to create a patch or diff file. In general, pull requests are preferred for very large changes, whereas both work fine for smaller changes.

====Create a Pull Request====
# Navigate to your personal Github repository.
# Select the branch that has the changes for the pull request as shown below. [[File:Git-coders-tutorial-20121009-11.png|frame|none]]
# Click the Pull Request button on the top of the screen. The screen will show as below. [[File:Git-coders-tutorial-20121009-12.png|frame|none]]
# The left side shows the base repository and base branch. This will normally be the master branch of the "joomla/joomla-cms" repository. The right side shows the head repository and branch. This will normally be your repository and the branch that has the desired code changes. If you like you can change the commit message and enter in a comment describing this pull request.
# You can review the pull request using the tabs across the top. Clicking the Commits tab shows the commit history for the branch, as shown below.[[File:Git-coders-tutorial-20121009-13.png|frame|none]]
# Clicking the Files Changed tab shows all of the changes made in this branch, as shown here. [[File:Git-coders-tutorial-20121009-14.png|frame|none]]
# When you are ready to submit the pull request, click the Send Pull Request button at the bottom right of the screen. Github will process the request and then display it as shown below. [[File:Git-coders-tutorial-20121009-15.png|frame|none]]
# At this point, you should update the Joomlacode tracker. For example, if this code is a fix for a Confirmed issue, you should change the issue status to Pending and add a comment with a link to the pull request (for example, <nowiki>https://github.com/joomla/joomla-cms/pull/494</nowiki>). Also, make sure there are good test instructions so people can test the proposed code.

====Create a Patch File====
It is not necessary to create a pull request to submit code changes to Joomla. Another alternative is to create a patch file. This can be done on your local system from the command line as follows:
# In your local system, change to the desired branch.
# Enter the command: <code>git diff master > my-new-patch.patch</code>
This will create a patch file in that same folder. (Note that you may want to have Git automatically ignore all patch files. See the section called Git Tips below.) Upload that file to the Joomlacode tracker and add a comment and change the issue status as needed.
To include changes to binary files in the diff add the <code>--binary</code> option to the command line as follows:
# Enter the command: <code>git diff --binary master > my-new-patch.patch</code>

Note that this method does not require you to push your local branches to Github.

== Keep Your Repositories Up to Date==
As discussed earlier, the main CMS repository on Github is being changed frequently. It is possible that one or more of these changes could conflict with (or otherwise affect) our work. For this reason, it is very important that we keep our repositories up to date. Otherwise, our patch files and pull requests may not work. As discussed earlier, the way we will do this is by keeping our master branch synchronized with the main CMS repository and then using that to update our working branches.

In this tutorial we are using the git merge command. The merge command merges the changes from a different branch into the current branch. Here we use the merge to merge changes from the master branch into our working branch. For example, say we created a branch (my-branch) on day 1. On day 2, someone does 5 commits to the master branch in the main CMS repository. Now, on day 3 we want to update our branch to be current with these 5 commits. The merge command tries to do this automatically. It looks to see what was changed in the master branch since our last merge and applies those same changes to our current branch ("my-branch"). This will work automatically unless we have made changes that conflict with changes made in the same files in the main repository. In that case, we need to resolve these conflicts before we can finish updating our branch.

To update a working branch with changes to the main CMS repository, follow these steps.
# Update your local master branch.
#* Make sure you are on the master branch in your local repository: <code>git checkout master</code>
#* Pull changes from the main CMS repository: <code>git pull upstream master</code>
#* Push those changes to your Github repository: <code>git push origin master</code>
# Now your local master branch is up to date. Next, change to your working branch: <code>git checkout my-branch</code>
# Make sure your remote repository "my-branch" is up to date with your local repository. Use the command: <code>git push origin my-branch</code>. If the remote repository was already up to date, no harm is done. You will just get a message saying it was already up to date.
# Finally, merge the new changes to the master branch with your working branch. The command is as follows: <code>git merge master</code>
# The system will work for a short time and then indicate whether or not the merge was successful. If you don't have any changes that conflict with changes from the main CMS repository, the merge will be successful. If one or more of your changes conflicts with the changes that were made in the main repository, any affected files will be flagged as being in conflict. See the Fixing Conflicts section below for more information about this.

You can also use Eclipse for the merge by changing to the working branch and selecting Team→Merge→. This will show the following screen. [[File:Git-coders-tutorial-20121027-01.png|frame|none]] Select Local->master as shown above and click Merge.

== Fixing Conflicts ==
A conflict occurs during a merge (or rebase) if the same file has been changed in the local branch and in the master branch in a way that conflicts. If this happens, the file is flagged as being in conflict and the merge process is suspended. To complete the process, you need to:
# Manually edit each of the flagged. You will see the changes from your branch and the changes from the main repository highlighted in the file. You need to figure out what should be in the file.
# Once you have edited each flagged file, enter the command <code>git add xxx</code> where "xxx" is the name of the flagged file.

Let's look at a simple example. Here we have added a line of code to a file in our branch and someone has added a different line to the same file in the master branch. When we do the merge command, we get the following message.

$ git merge master
Removing administrator/templates/hathor/html/mod_submenu/default.php
Auto-merging administrator/components/com_admin/script.php
CONFLICT (content): Merge conflict in administrator/components/com_admin/script
php
Automatic merge failed; fix conflicts and then commit the result.

So this tells us we have a conflict in the file <code>administrator/components/com_admin/script.php</code>. If we look at this file in our text editor, we see the following: [[File:Git-coders-tutorial-20121009-17.png|frame|none]] The line under "<<<<<<< HEAD" is from the master branch of the main repository. The line after the "=======" is from our working branch.

At this point, we need to correct the file and remove the "marker" lines. Then we do the command <code>git add administrator/components/com_admin/script.php</code> to tell Git that the conflict is resolved.

Finally, we do the command

<code>git commit -a</code>

to finish the merge. This commits all of the changes that were applied automatically by the merge as well as the changes we have done manually in fixing the conflicts.

If we want to abandon the merge instead of fixing the conflicts, we can use the following commands to reset our branch back to its state before the merge:

<code>git reset --hard</code>

<code>git clean -f -d</code>

===Using Eclipse For Conflicts===
Eclipse is very handy for resolving commits. When you do the command Team→Merge and there is a conflict, you get the following window. [[File:Git-coders-tutorial-20121027-02.png|frame|none]] You will also see a red square annotation in the PHP Explorer window next to each file with a conflict.

To see all of the files in conflict you can use the Merge Tool. Right click on the PHP project and select Team→Merge Tool. You will see the following option. [[File:Git-coders-tutorial-20121009-20.png|frame|none]]

This gives you the option of having Git put in the changes from both sources in the file or letting you compare the changes side by side. If you select Use HEAD version you get a file compare similar to the following. [[File:Git-coders-tutorial-20121009-21.png|frame|none]]

The left shows the change from the master branch, and the right shows the change from your working branch. At this point, you can either edit the file in the left side (for example, by pulling in the change from the right side) or you can just manually edit the file in conflict.

Once the file has been fixed, select the file (either by right-clicking in the PHP Explorer view or in the editor) and select Team→Add to Index as shown below. [[File:Git-coders-tutorial-20121009-22.png|frame|none]]When you do this, the red square annotation will disappear.

Once all the conflicts are resolved, you can finish the merge by right-clicking on the project and selecting Team→Commit. The normal commit screen will show as follows. [[File:Git-coders-tutorial-20121027-03.png|frame|none]] Notice that the files that were in conflict are automatically added to the commit message. Edit the commit message as desired and click the Commit button. At this point, the merge is complete.

== Saving Your User Name and Password ==
When you push changes to Github, it must authenticate you based on your Github user name and password. Normally, the system will simply prompt you for your user name and password each time you do a push.

There are a number of ways you can save your credentials so you don't have to enter them each time. One very simple method is to use the git "store" feature.

''IMPORTANT NOTE: This feature stores your password in plain text on your local computer. If this is not acceptable, do not use this method.''

If it is OK to store your credentials on your PC, at the command line enter the command: <code>git config --global credential.helper store</code> This tells Git to store your credentials in a file called .git-credentials in your home folder ("for example, C:\users\user-name").

The next time you do a push and enter your credentials, they will be stored in that file. After that, you will not need to enter them. Git will use them automatically.

If you want to change your password, simple delete the file and then change your password on Github. The next time you enter your credentials, the new password will be saved.

== Git Tips ==

=== Ignoring Files ===
Sometimes you don't want to track all the files in a folder, specially some system files that the operating system generates. One way to have Git ignore files is to use the ".gitignore" file.

If you create a file in your repository named .gitignore, Git uses it to determine which files and directories to ignore, before you make a commit.

A .gitignore file should be committed into your repository, in order to share the ignore rules with any other users that clone the repository.

Read more about .gitignore at:
* http://git-scm.com/docs/gitignore
* https://help.github.com/articles/ignoring-files

Here is an example of a file.

# OSX
.DS_Store
._*
.Spotlight-V100
.Trashes

# Windows
Thumbs.db
Desktop.ini

# PHPStorm
.idea/

# Sublime Text
*.sublime*
sftp-config.json

# Eclipse
.buildpath
.project
.settings

# Netbeans (custom)
.netbeans/*
/nbproject/*

# Temp files
*.tmp
*.bak
*.swp
*~.nib
*~

# Phing build script
build.properties

# Packages #
*.zip
*.tar.*

# Composer
composer.lock
/vendor

# Test related files
/tests/system/servers/configdef.php
/tests/system/webdriver/tests/logs/
/tests/acceptance.suite.yml
codecept.phar

# Never ignore
!.gitignore
!index.html
!index.php

As you can see from the example, we can exclude specific folders and file names.

Once you have this file created, Git will ignore any of these files.

[[Category:Bug Squad]]
[[Category:Development]]
[[Category:GitHub]]

My first pull request to Joomla! on Github

2014-10-14T04:52:59Z

Gunjanpatel: adding github work flow for joomla

== A Pull Request ?? ==
So what the heck could be a "Pull Request" ? No, I bet it's not what you're thinking right now...

A Pull Request is the Git Jargon meaning "I will send a '''request''' to a project, to '''pull''' in some code changes / additions I have made to their code base"

Got it ? This is how we (including you) are going to contribute source code to the Joomla! code base.

It might look a bit scary at first (at least to me) but in the end it's pretty easy - "similar" to SVN, but a lot better.

Here is how it works:

== Installation ==
The installation depends on the operating system you are using. If you use Linux, you may find the git software in your repository.

For '''example''' [http://opensuse.org OpenSuSE] offers a "pattern" named <code>git</code> that provides the git core (required) as well as a set of tools like [http://gitk.sourceforge.net/ gitk], an e-mail interface, scripts to import source code from other version control systems like svn and others.

[[File:git-opensuse-install.png]]

For more information about installing git on other operating systems see the GitHub site for [https://help.github.com/articles/set-up-git#platform-linux Linux], [https://help.github.com/articles/set-up-git#platform-mac Mac] and even [https://help.github.com/articles/set-up-git#platform-windows Windows].

For this tutorial you will also need [http://eclipse.org/pdt/ Eclipse PDT] with the [http://eclipse.org/egit/ eGit plugin] installed.

== GitHub Work flow for Joomla! ==

[[File:Github work flow joomla.png]]

== GitHub ==
For this tutorial we have created a GitHub user named '''<code>jlover</code>''' - a dude who loves J :)

He has already [http://help.github.com/fork-a-repo/ forked] the main repository so his repository is at: https://github.com/jlover/joomla-platform

[[File:github-repo.png]]

== Import your clone ==
Mr. JLover uses Linux and his Eclipse workspace is at <code>/home/jlover/workspace</code>

Before eGit 1.0 it was not possible to create or clone repositories right into your workspace. To make things easier we set the default repository folder to our workspace.

[[File:git-eclipse-preferences-1.png]]

Let's start. Go to your workspace, right click inside the PHP explorer and select '''Import...'''.

[[File:git-eclipse-import.png]]

Select '''Git''' ⇒ '''Projects from Git'''

[[File:git-eclipse-import-2.png]]

Click on '''Clone...'''

[[File:git-eclipse-import-3.png]]

=== Source repository ===

In the window that opens up, copy and paste the HTTP URL from your GitHub repository. The remaining fields will be auto filled.

Your may also want to supply your password but this is not required if you limit the write operations to the command line.

[[File:git-eclipse-import-4.png]]

Select the branches you want to clone. The '''master''' branch is the ''point of truth''.

[[File:git-eclipse-import-5.png]]

=== Local destination ===
Now choose where you want to save the files. We will save them in our workspace and modify the default name joomla-platform to '''my-joomla-platform'''.

Please remember this name, as we will use it later when we create our project in the same folder.

[[File:git-eclipse-import-6.png]]

=== Receiving objects... ===
The files are being checked out. Sit back and watch patiently, or go for a cup of coffee ;)

[[File:git-eclipse-import-6-checkout.png]]

Finished. Click '''Next >'''

[[File:git-eclipse-import-7.png]]

== New Project wizard ==

Select '''Use the New Project wizard''' and click '''Finish''' to start it (windows like..)

[[File:git-eclipse-create-project-1.png]]

Select '''PHP''' ⇒ '''PHP Project'''

[[File:git-eclipse-create-project-2.png]]

For the Project name enter the name of the repository you previously cloned. '''my-joola-platform''' in our example.

Observe the message beside the yellow triangle that appears when you finished inserting the Project name, telling you that the specified location already exists.<br />
This is OK and expected.

[[File:git-eclipse-import-8.png]]

Click '''Next >''' and include other libraries if required.

[[File:git-eclipse-import-9.png]]

== Finished ==

After you click Finish, the new project will be created in your workspace.

'''Welcome to the Joomla! platform.'''

[[File:git-eclipse-import-10.png]]

== The upstream repository ==

OK. So far you have a local "clone" of your GitHub repository which is a fork of the main Joomla! repository.

But what if the information in the main Joomla! repository changes ? Remember your fork (and your clone) are completely independent from the main repository. Fortunately git allows you to add multiple repositories to your "working copy" to track changes and merge them with your work.

We are going to add the main repository and call it '''upstream'''. To do this I use the console because I have not figured out yet how to do this in eclipse (@todo?)

<pre>
cd /home/jlover/workspace/my-joomla-platform
git remote add upstream git://github.com/joomla/joomla-platform.git
</pre>

To „update“ your clone with the latest changes from the main repository use

<pre>
git fetch upstream
git merge upstream/master
</pre>

This will '''fetch''' the changes from the upstream repository and '''merge''' the upstream/master branch into your current branch.

== Code away... ==
So what are you waiting for ? Go and fix this bug or implement this cool feature and give it back to the Joomla! project. It's as easy as clicking a button ;)

An example:

Let's create a simple patch file using Eclipse. We're going to add a comment line to a file that is really important to Joomla! and then create a pull request in GitHub to the Joomla! project.

So if the developers decide that your changes are worth being included into the code base, all they have to do is pushing a button and your name gets graved in stone (aka changelog) and the respective ''blame'' will show your name as the author for the lines of code you changed - Is this cute or what ?

== Create a feature branch ==
Git provides a handy feature called [http://book.git-scm.com/3_basic_branching_and_merging.html Branches]. The concept is somewhat similar to SVN but the handling is completely different. This feature is also known as ''cheap branching''.

So if you plan to make more submissions or just to keep your master branch clean, you should create a new branch.

Unfortunately Eclipses branching concept seems to differ a bit from the original. So I use the command line also for branching operations. @todo?

The shortcut for creating and switching to a new branch is <code>checkout -b</code> so we will create a new branch called '''<code>first-test</code>'''

<pre>
cd /home/jlover/workspace/my-joomla-platform
git checkout -b first-test
</pre>

Note that the tree has also changed in eclipse (maybe you need to refresh)

[[File:git-eclipse-tree-details.png]]

OK we can now change whatever we want without "polluting" our master branch. The disk space required to do this is minimal. That's what is meant by ''cheap''...

== Change the code ==
Let's open the file <code>libraries/joomla/application/application.php</code>. and make a test change.

You really should feel a bit important right now doing changes to such an important Joomla! core file - do you ? ;).

Note that after you save the file, a ''dirty'' marker <code>></code> appears. You can change this in the configuration if you prefer the svn icon overlays.

[[File:git-pull-test-change.png]]

That looks good. Now here comes another new concept if you are new to git: To get your changes to you repository on GitHub '''<big>two steps</big>''' are required:

== Step 1 - Commit ==
This step will commit your changes to your '''local''' repository. You can do this from within eclipse selecting the file(s) or folders you want to include in the commit.

Right click you project and select Team ⇒ Commit...

[[File:git-eclipse-commit-1.png]]

In the window that opens enter a meaningfull commit message

[[File:git-eclipse-commit-2.png]]

After you press <code>Commit</code> note that the ''dirty'' marker <code>></code> has disappeared.

You may add as many commits as you like locally before submitting it to the server.

Commit often.

== Step 2 - Push ==
This step will submit your code to the GitHub server(s).

We do this from the command line @todo?

<pre>git push origin first-test</pre>
This will push your changes to '''<code>origin</code>''' (your (jlovers) repository on GitHub) and create a new branch named '''<code>first-test</code>'''

Done. Your changes are on the internet. Let's check out the GitHub site

[[File:git-pull-feed-1.png]]

Looks good.

A nice feature in eclipse is the history view

[[File:git-eclipse-history-view.png]]

== The Pull Request ==
At this point we are finally ready to do our pull request. Let's go to our repository, be sure that you are on the correct branch (you may change this later), and find the '''Pull Request''' button.

Push it softly, nothing will really happen yet ;)

[[File:github-pull-request-1.png]]

On the next screen you should enter a meaningful message to the developers.

Pay attention to the text white on black that shows '''from''' and '''to''' which repository:branch you are going to send your pull request. By pushing the button '''Change Commits''' you may modify those values.

[[File:github-pull-request-2.png]]

Here you can preview the changes you are proposing.

[[File:github-pull-request-3.png]]

== Push the Button ==
Ok, we are ready to '''Push the Button''' [[File:Button_send_pull_request.png]]

Thank you for your attention and in advance for your contribution(s) to the Joomla! project.

[[Category:Bug Squad]]
[[Category:Development]]
[[Category:GitHub]]

File:Github work flow joomla.png

2014-10-14T04:41:50Z

Gunjanpatel:

== Licensing ==
{{GFDL}}

Pizza Bugs and Fun October 17, 2014

2014-10-14T04:34:57Z

Gunjanpatel: Adding pre event seminar slides

[[Image:pbf.png|225px|left]]

A Joomla! Pizza, Bugs and Fun event is scheduled for Friday, October 17, 2014. The event is global for virtual participants (both businesses and individuals), with local venues wherever they are organized. The key goal is to fix as many Joomla 3 and Joomla 2.5 bugs as possible.

'''See the section [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#General_Instructions General Instructions] below for instructions.'''

This wiki will be used as the central resource for coordinating efforts and accumulating results from this event.

Follow [https://twitter.com/joomlabugsquad @JoomlaBugSquad] on Twitter for updates during PBF and some social fun. The ''Twitter''' hash tag is #JoomlaPBF.
<div style="clear:left;" />
== Goals ==
* '''Bugs''' : We will be working through the [http://issues.joomla.org/ CMS Issue Tracker] where there are bug reports needing patches and/or testing.
* '''Documentation''' : If you want to help out writing documentation, you're also more than welcome. See the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#If_you_want_to_work_on_Documentation Documentation Details] below for suggestions.

== Organization, logistics and communications ==

=== Communication ===
We will set up a chat for all attendees of the PBF. More details coming soon.

=== Training Sessions ===
There will be an optional webinar training session on 16 October, 2014 at 15:00 UTC. We'll post the link here on Wednesday the 15th.

Also, on 16 October, 2014, the chat will be open for a Q&A and for help getting started. We'll post the link here on Wednesday the 15th.

=== Recognition ===
We've dubbed the event as a Business PBF, since it's the second PBF on a weekday (Friday) and we'd like to get more business involved. We've created badges that you can use on your sites to spread awareness of the event and get recognition for your participation: http://developer.joomla.org/pbf

Furthermore, we'd like to give you more recognition and highlight your pledge of participation by placing your logo and a link to your site on the landing page: http://developer.joomla.org/pbf

There are four participations levels: Epic, Platinum, Gold, and Silver. Platinum is for 10 hours or more pledged to the event. Gold is four hours or more pledged. Silver is pledged to participate in the event. And Epic for 100+ hours pledged!

So, for example, if Company ABC had five of their developers for two hours, then they could use the Platinum badge and have their logo (and link) in the platinum area on the landing page.

The hours you choose to pledge towards the event is totally up to you as an individual or business. As a bonus, if you write a blog post about the event, you can count it as 30 minutes towards your pledge. So if you pledged 5 hours and write a blog post, you'd be helping at the event for 4.5 hours.

Finally, on the day of the event, come and go as you'd like and fulfill your pledged hours. You can help with testing bug fixes, reporting bugs, coding bug fixes, etc. Most of all, enjoy every minute! Have fun, enjoy the fellowship, learn, and make Joomla better for you, your business, your clients, and your friends.

=== General Instructions ===

These instructions may change as we get closer to the event.

==== Task List ====
On the day of the event, we'll have a task list available with suggestions of what you can do to help.

==== If you want to test bug fixes (i.e. patches) ====
* Look for issues with a status of Pending. We want at least 2 testers and more on complex issues, so you can test what others have tested already.
* Use the [http://issues.joomla.org/ CMS Issue Tracker] as usual, which means you can use the [[Component Patchtester for Testers|Joomla Patch Tester]].
* Most of the issues should have test instructions with them.
* Once you have tested, add comments to the tracker on your results. Start your comment with @test so you will get counted in the stats as a tester. If the test is successful check of a successful text box.
* Note: You don't have to delete the installation folder when you are using the development version of Joomla. This allows you to reinstall just by deleting the configuration.php file.
* Note: See the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#FAQ FAQ] on how to apply a Git pull request.

:<h5>Helpful Documentation</h5>
:* [[Component Patchtester for Testers]] - We'd recommend beginners to use the [[Component Patchtester for Testers|Joomla Patch Tester]]

==== If you want to code bug fixes ====
* Use the [http://issues.joomla.org/ CMS Issue Tracker] as usual, looking for the issues with a status of Confirmed.
* Send in a [[Git for Coders|pull request]]. Add testing instructions if they don't already exist.{{-}}<h5>Helpful documentation</h5>
:* [[Component Patchtester for Testers]]
:* [[Git for Testers and Trackers]]
:* [[Git for Coders]]
:* [[Working with git and github/My first pull request]]
:* [[Secure coding guidelines]]
:* [[Development Best Practices]]
:* [http://www.slideshare.net/patelgunjan/joomla-pizza-bugs-and-fun-2014-preevent-seminar Joomla! Pizza Bugs and Fun 2014 pre-event Seminar]

==== If you want to work on Documentation ====
* To edit this Documentation Wiki, you will need a user account on the wiki. If you don't already have one, you may register on [[Special:UserLogin]]. You only need a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets.
* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] and our use of [[User:Abuse filter|Abuse filters]] for new users.
* Get your user account a few days before and make sure that you are able to sign in since the automatic authorization system can lock some people out.
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
* During the PBF, several experienced Wiki editors will be available in the chat to help you.

{{:{{PAGENAME}}/Documentation needs}}

=== Pizza ===
We are offering pizza (or any comparable locally popular main course) and soda for pre-registered groups. We are not setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Nick Savov (nick.savov[at]community.joomla[dot]org , replace [at] with @ and [dot] with .) before the event to register and get details.

== Locations ==

If you want to get people together and have a venue to share, please add it below. Share as much as possible details like exact location, url for more information about the venue, ways to register, date and time the venue is available etc.

If you set up a location please send contact information to Nick Savov (nick.savov[at]community.joomla[dot]org , replace [at] with @ and [dot] with .). Feel free to contact him with any questions.

===Virtual===

The event is global and across all timezones on October 17th, 2014 (48 hours total). You can come and go as you'd like and fulfill your pledged hours. You can help with testing bug fixes, reporting bugs, coding bug fixes, etc. Most of all, enjoy every minute! Have fun, enjoy the community, learn, and make Joomla better for you, your business, your clients, and your friends.

There are also some physical venues... see below.

====Twitter====
Follow [https://twitter.com/joomlabugsquad @JoomlaBugSquad] on Twitter for updates during PBF and some social fun. The ''Twitter''' hash tag is #JoomlaPBF.

====Chat====
We will set up a chat for all attendees of the PBF. We'll post the link here on Wednesday the 15th.

=== Europe ===

==== Netherlands ====
[http://www.joomlacommunity.eu/nieuws/joomla-in-nederland/976-joomla-pizza-bugs-en-fun-nederland.html Joomla Pizza, Bugs & Fun in Enschede, The Netherlands]
Date: Friday, October 17, from 10:30 - 18:00
Location: de Bibliotheek, Pijpenstraat 15, 7511 GM Enschede
To attend, please add yourself to: http://www.joomlacommunity.eu/joomla-gebruikersgroepen/details/483.html

=== North America ===

=== South America ===

=== Asia/Pacific ===

=== Africa ===

=== Middle East ===

== Registration ==
=== For write access to this wiki ===
To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. This is the same login for updating Joomla documentation.

=== At a physical location ===
If you wish to be present at one of the physical locations listed above then you must register in advance because space most likely is limited. Registrations are the responsibility of the individual location organizers and you should click on the appropriate link above for more information.

=== Taking bugs, tasks and pizza ===

Please check the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#Organization.2C_logistics_and_communications Organization, logistics and communications section] for details on how to get involved in working on tasks.

==Requirements==
* All code must be made available under the [http://www.gnu.org/licenses/gpl-2.0.html General Public Licence version 2].
* All documentation contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]
* No advertising or self-promotion will be allowed. This includes back links to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Pizza Bugs and Fun October 17, 2014/Contributors List|Contributors List]]
* All contributions must be in English. Note that the official language of the Joomla! project is British English.

== FAQ ==
Q: Where is the code for Joomla?

A: The current Joomla code can be found on GitHub.

*GitHub - https://github.com/joomla/joomla-cms

Q: Which one is 3.3?

A: On GitHub, it is the staging branch: [https://github.com/joomla/joomla-cms https://github.com/joomla/joomla-cms]

Q: Which one is 2.5?

A: On GitHub, it is the 2.5.x branch: [https://github.com/joomla/joomla-cms/tree/2.5.x https://github.com/joomla/joomla-cms/tree/2.5.x]

Q: How do I apply a Git pull request?

A: Use the [[Component Patchtester for Testers|Joomla Patch Tester]]

==Contributors==
{{:Pizza Bugs and Fun October 17, 2014/Contributors List}}

<noinclude>[[Category:Bug Squad]]
[[Category:Development]][[Category:Events]]</noinclude>

Bug Tracking Process

2014-10-10T17:37:37Z

Gunjanpatel: Updating SVN to GIT

{{page|needs updating|Information on JoomlaCode.org is no longer valid, use [http://issues.joomla.org Issue Tracker].}}
This article documents the current Joomla! bug tracking process from the time a new bug is reported to the time it is closed.

Joomla! bugs are tracked in the follower tracker:
;*[http://issues.joomla.org/ Joomla! Issue Tracker] - Active.
:This is for issues with supported Joomla Versions. As of November 2013, this is version 2.5 and 3.x.

==Helping out==

You do ''not'' need to be a member of the JBS to help fix bugs in Joomla. [[Filing bugs and issues|Anyone can report bugs]], test patches, or submit patches. If you want to help with resolving bugs, go to the [http://issues.joomla.org/ Tracker]. You can help resolve Open issues as outlined below. You can create and submit patches for Confirmed issues. Or you can help test Pending issues. To report about what you have done, login with a Github account and add a comment. You'll be amazed at how much impact you can have and how good it feels to contribute to the Joomla! project.

If you have any questions, or are interested in joining the [[Portal:Bug_Squad|JBS]], please contact [mailto:nick.savov@community.joomla.org Nick Savov].

===Testing Pre releases===

Before a stable release of Joomla is released the update needs testing. This is a simple process:
# Install the current stable release of Joomla in a subfolder or on localhost (you can use a copy of a production site but '''never test on a live production site''').
# Navigate to the Options of the Joomla! Update component and set the 'Update server' to 'Test'. [[Help32:Components Joomla Update|Components Joomla Update]]
# When a Joomla pre release is ready for testing, log into your test site and install the Update. Then test the site works as expected. Please report any errors/bugs on the [http://issues.joomla.org/ Joomla! Issue Tracker]

==Reporting Issues==

[[Image:ReportingIssues.png|ReportingIssues.png]]

The process is normally started in one of two ways: the bug is added to the respective tracker, or a user reports the bug in the [http://forum.joomla.org/viewforum.php?f=728 Joomla! Bug Forum] for the given maintenance release.

=== Issues reported on the forum ===

JBS members scan the forums to determine when issues need to be put into the tracker. If the issue can be reproduced, is clearly a bug, and there are step-by-step instructions for how to reproduce it, it can be entered into the tracker with a status of Confirmed. If it is not as clear-cut, it can be entered with a status of Open, so that other JBS members will know it needs further investigation.

=== Issues directly reported to the tracker ===

When an issue is added to the tracker, the status could be depending on the situation;
# Open
# Confirmed
# Pending
If the issue needs more investigation, then it should be set to Open. If the issue (1) is a bug and (2) can be reproduced and (3) has good test instructions, it should be set to Confirmed. If it meets the three Confirmed criteria and also has a good patch attached, it should be set to Pending. See below for more information about the status codes.

=== Issue Priorities ===

[[Bug and Issue Tracker Priority|Why most issues are priority 3]], or Normal. The artifacts are prioritized according to the following characteristics:

'''Critical (1):'''
The trunk is not working at all. Significant parts of the source are broken preventing key operations. Examples would be login, installation, extension installers, javascript errors that prevent you from moving a save or similar action, etc. Also includes the generation of Fatal PHP errors and major security issues in a prerelease (Security issues for a stable release should NOT be reported in the tracker but instead reported to the security team security@joomla.org).

'''Urgent (2):'''
Parts of the source are obstructing operation in a serious way or causing a major loss in advertised function. Examples would includes PHP notices and warnings and reported javascript errors. Major issues will also typically prevent the release cycle from moving from Beta to Release Candidate (RC), or Release Candidate to General Availability (GA).

'''Medium (3):'''
Issues that are hindering advertised behavior but the application is still workable. Examples would include parameters not working as advertised, language files not loading as expected, etc.

'''Low (4):'''
Minor loss of function and generally annoying behavior. May include less common platform or browser specific problems that while they may be technically major in those environments, they represent a minority. Also include missing translation strings.

'''Very low (5):'''
Cosmetic problems, misspelled words, graphically misaligned object, less common issues with parameters, etc.

== Resolving Issues ==

The bug squad takes care of the Joomla releases. For example, that means getting the 3.4, 3.5, 3.6, 3.7 etc releases ready by fixing problems that come up. The idea is to make the release increasingly stable and take care of issues that come up. At the same time, it is vitally important not to break anything that is working. That's called software regression and it's not something you want at this stage.

In the trackers there are several common statuses, mainly: open, confirmed, pending, ready to commit.

* '''Open/New''' means it's reported, but it hasn't been determined for sure whether it is a real bug or not. Many Open issues are not actually bugs. If the issue fits into one of the categories below, then the status is changed as indicated and the bug is closed:
** Cannot be reproduced. We have tried the same thing the reported did but the software appears to work correctly. (In many cases, more information is needed to be able to reproduce a bug. See "Information Required" below.) Change status to '''Unable to confirm'''.
** Has already been reported in a different issue number. Change status to '''Duplicate report''' and add the number on the duplicates tab.
** Is a known limitation of the software. Change status to '''Known issue'''.
** Is a feature request, a mistake made by a user, or is the way the software is intended to work. Change status to '''Not a bug'''.
** Is a bug with an extension or some other external program or a server issue that will not be addressed. Change status to '''Not Joomla! core'''.
* '''Information Required''' is used if we need more information ''from the person who reported the issue'' to decide about the issue. For example, there are questions about how to reproduce the problem or other questions about the issue. If we get the information we need, then we can continue processing the issue. If we don't get the information within two weeks, then we can change the status to Unable to confirm (or another of the closed status codes if that is more applicable).
* '''Needs Review''' is used if we need a JBS Coordinator, Development Coordinator, or other experienced developer to review the issue. This is different from Information Required, which means that we need more information from the person who reported the issue.
* '''Started''' means that JBS has checked the issue, but is not quite sure if the issue is an actual bug (i.e. confirmed), and that there is discussion going on about the issue, which doesn't require additional information ''from the person who reported the issue''. It is a state that's between '''Opened''' and '''Confirmed'''.
* '''Confirmed''' means that JBS has confirmed that this issue is a bug in Joomla! that should be fixed. That's when the JBS tries to solve it or consults with the development team about a solution. ''At this point there should be clear step-by-step test instructions that indicate how to reproduce the problem. For version 1.6, use the Test Instructions field for this information.''
* '''Pending''' means that a patch has been submitted that a JBS member or development coordinator or appropriate leadership team member believes fixes the bug. If needed, additional test instructions are entered for the issue. Every Pending issue should have instructions that tell the tester how to reproduce the problem and make sure the patch fixes the problem.
* '''In Progress''' means that an issue is being worked on. This will most likely be a situation where the issue was set to Pending but there were problems with the patch that require additional work. It also may be a case where the issue is complex and will take some time to solve. JBS members can participate in In Progress issues but generally should not start coding before discussing with others working on the issue already.
* '''Ready to commit''' means that (in general) two separate people have successfully tested the same patch file, and it works correctly with the patch. Note that, for some issues that are more complex or higher impact, we may need more than two people to test or may need to test on multiple platforms. For simple issues, such as fixing typos in language strings or comments, one tester is enough.
* '''Fixed in Git''' means that, after reviewing the code, the JBS commit coordinators have determined that the patch is good and the change has been committed to the Joomla! code-base. At this point, it will be part of the next Joomla! maintenance release.

The flowchart below provides a visual guide to how the process for resolving bugs works.

[[Image:ResolvingIssues.png|ResolvingIssues.png]]

<noinclude> [[Category:Bug Squad]]</noinclude>
[[Category:Bug Tracker]]

J3.x:Developing an MVC Component/Basic backend

2014-09-11T10:32:10Z

Gunjanpatel: /* Create the general controller */

{{:J3.1:Developing a MVC Component}}

{{review}}

This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Basic backend ==
Designing the backend interface leads us to create at least a Model-View-Controller triptych. We have to modify the administrator entry point of our component, the ''admin/helloworld.php'' file

<span id="admin/helloworld.php">
''admin/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task and Execute request task
$controller->execute(JFactory::getApplication()->input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();

</source>
</span>

== Create the general controller ==
The entry point now gets an instance of a ''HelloWorld'' prefixed controller. Let's create a basic controller for the administrator part:

<span id="admin/controller.php">
''admin/controller.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die;

/**
* General Controller of HelloWorld component
*/
class HelloWorldController extends JControllerLegacy
{
/**
* display task
*
* @return void
*/
function display($cachable = false, $urlparams = false)
{
// set default view if not set
$input = JFactory::getApplication()->input;
$input->set('view', $input->getCmd('view', 'HelloWorlds'));

// call parent behavior
parent::display($cachable);
}
}

</source>
</span>

This controller will display the 'HelloWorlds' view by default.

== Create the view ==

With your favorite file manager and editor, create a file ''admin/views/helloworlds/view.html.php'' containing:

<span id="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Display the template
parent::display($tpl);
}
}
</source>
</span>

In Joomla, views display data using layout. With your favorite file manager and editor, put a file ''admin/views/helloworlds/tmpl/default.php'' containing

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');

// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
</form>
</source>
</span>

This layout calls several sub-layout (''head'', ''foot'' and ''body''). Each sub-layout corresponds to a file prefixed by the name of the main layout (''default''), and an underscore.

Put a file ''admin/views/helloworlds/tmpl/default_head.php'' containing

<span id="admin/views/helloworlds/tmpl/default_head.php">
''admin/views/helloworlds/tmpl/default_head.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<th width="20">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th>
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'); ?>
</th>
<th width="5">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_ID'); ?>
</th>
</tr>
</source>
</span>

''COM_HELLOWORLD_HELLOWORLD_HEADING_ID'' and ''COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'' are placeholders which will later be replaced with language-specific text. The [http://api.joomla.org/cms-3/classes/JText.html JText::_] method translates a string into the current language.

''checkAll'' is a javascript function defined in the Joomla core able to check all items.

Put a file ''admin/views/helloworlds/tmpl/default_body.php'' containing

<span id="admin/views/helloworlds/tmpl/default_body.php">
''admin/views/helloworlds/tmpl/default_body.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<?php foreach($this->items as $i => $item): ?>
<tr class="row<?php echo $i % 2; ?>">
<td>
<?php echo JHtml::_('grid.id', $i, $item->id); ?>
</td>
<td>
<?php echo $item->greeting; ?>
</td>
<td>
<?php echo $item->id; ?>
</td>
</tr>
<?php endforeach; ?>
</source>
</span>

''JHtml::_'' is a helper function able to display several HTML output. In this case, it will display a checkbox for the item.

Put a file ''admin/views/helloworlds/tmpl/default_foot.php'' containing

<span id="admin/views/helloworlds/tmpl/default_foot.php">
''admin/views/helloworlds/tmpl/default_foot.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<td colspan="3"><?php echo $this->pagination->getListFooter(); ?></td>
</tr>
</source>
</span>

''JPagination'' is a Joomla class able to manage and display pagination object.

== Create the model ==
The ''HelloWorlds'' view asks the model for data. In Joomla, there is a class able to manage a list of data: ''JModelList''. Class ''JModelList'' and inherited classes need only one method:
* ''getListQuery'' which constructs an SQL query

and two states:
* ''list.start'' for determining the list offset
* ''list.limit'' for determining the list length

The ''getItems'' and ''getPagination'' methods are defined in JModelList class. They don't need to be defined in the ''HelloWorldModelHelloWorlds'' class.

<span id="admin/models/helloworlds.php">
''admin/models/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import the Joomla modellist library
jimport('joomla.application.component.modellist');
/**
* HelloWorldList Model
*/
class HelloWorldModelHelloWorlds extends JModelList
{
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Create a new query object.
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields from the hello table
$query
->select('id,greeting')
->from('#__helloworld');

return $query;
}
}
</source>
</span>

The ''_populateState'' method is, by default, automatically called when a state is read by the ''getState'' method.

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-7-basic-backend.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">
<name>Hello World!</name>
<creationDate>January 2014</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<version>0.0.7</version>
<description>Description of the Hello World component ...</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>

<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
</files>

<administration>
<menu>Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>

<folder>views</folder>
</files>
</administration>
</extension>
</source>
</span>

Now you can see in your component '''hello-world''' an array with two colums, two rows and checkboxes. You can click the checkboxes in order to select the different options you want.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Using the database 
|next=Adding language management }}

== Contributors ==
*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:presto|Preston Smith]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Basic backend

2014-09-11T10:31:07Z

Gunjanpatel: /* Basic backend */

{{:J3.1:Developing a MVC Component}}

{{review}}

This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Basic backend ==
Designing the backend interface leads us to create at least a Model-View-Controller triptych. We have to modify the administrator entry point of our component, the ''admin/helloworld.php'' file

<span id="admin/helloworld.php">
''admin/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task and Execute request task
$controller->execute(JFactory::getApplication()->input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();

</source>
</span>

== Create the general controller ==
The entry point now gets an instance of a ''HelloWorld'' prefixed controller. Let's create a basic controller for the administrator part:

<span id="admin/controller.php">
''admin/controller.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* General Controller of HelloWorld component
*/
class HelloWorldController extends JControllerLegacy
{
/**
* display task
*
* @return void
*/
function display($cachable = false, $urlparams = false)
{
// set default view if not set
$input = JFactory::getApplication()->input;
$input->set('view', $input->getCmd('view', 'HelloWorlds'));

// call parent behavior
parent::display($cachable);
}
}

</source>
</span>

This controller will display the 'HelloWorlds' view by default.

== Create the view ==

With your favorite file manager and editor, create a file ''admin/views/helloworlds/view.html.php'' containing:

<span id="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Display the template
parent::display($tpl);
}
}
</source>
</span>

In Joomla, views display data using layout. With your favorite file manager and editor, put a file ''admin/views/helloworlds/tmpl/default.php'' containing

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');

// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
</form>
</source>
</span>

This layout calls several sub-layout (''head'', ''foot'' and ''body''). Each sub-layout corresponds to a file prefixed by the name of the main layout (''default''), and an underscore.

Put a file ''admin/views/helloworlds/tmpl/default_head.php'' containing

<span id="admin/views/helloworlds/tmpl/default_head.php">
''admin/views/helloworlds/tmpl/default_head.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<th width="20">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th>
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'); ?>
</th>
<th width="5">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_ID'); ?>
</th>
</tr>
</source>
</span>

''COM_HELLOWORLD_HELLOWORLD_HEADING_ID'' and ''COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'' are placeholders which will later be replaced with language-specific text. The [http://api.joomla.org/cms-3/classes/JText.html JText::_] method translates a string into the current language.

''checkAll'' is a javascript function defined in the Joomla core able to check all items.

Put a file ''admin/views/helloworlds/tmpl/default_body.php'' containing

<span id="admin/views/helloworlds/tmpl/default_body.php">
''admin/views/helloworlds/tmpl/default_body.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<?php foreach($this->items as $i => $item): ?>
<tr class="row<?php echo $i % 2; ?>">
<td>
<?php echo JHtml::_('grid.id', $i, $item->id); ?>
</td>
<td>
<?php echo $item->greeting; ?>
</td>
<td>
<?php echo $item->id; ?>
</td>
</tr>
<?php endforeach; ?>
</source>
</span>

''JHtml::_'' is a helper function able to display several HTML output. In this case, it will display a checkbox for the item.

Put a file ''admin/views/helloworlds/tmpl/default_foot.php'' containing

<span id="admin/views/helloworlds/tmpl/default_foot.php">
''admin/views/helloworlds/tmpl/default_foot.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<td colspan="3"><?php echo $this->pagination->getListFooter(); ?></td>
</tr>
</source>
</span>

''JPagination'' is a Joomla class able to manage and display pagination object.

== Create the model ==
The ''HelloWorlds'' view asks the model for data. In Joomla, there is a class able to manage a list of data: ''JModelList''. Class ''JModelList'' and inherited classes need only one method:
* ''getListQuery'' which constructs an SQL query

and two states:
* ''list.start'' for determining the list offset
* ''list.limit'' for determining the list length

The ''getItems'' and ''getPagination'' methods are defined in JModelList class. They don't need to be defined in the ''HelloWorldModelHelloWorlds'' class.

<span id="admin/models/helloworlds.php">
''admin/models/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import the Joomla modellist library
jimport('joomla.application.component.modellist');
/**
* HelloWorldList Model
*/
class HelloWorldModelHelloWorlds extends JModelList
{
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Create a new query object.
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields from the hello table
$query
->select('id,greeting')
->from('#__helloworld');

return $query;
}
}
</source>
</span>

The ''_populateState'' method is, by default, automatically called when a state is read by the ''getState'' method.

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-7-basic-backend.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">
<name>Hello World!</name>
<creationDate>January 2014</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<version>0.0.7</version>
<description>Description of the Hello World component ...</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>

<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
</files>

<administration>
<menu>Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>

<folder>views</folder>
</files>
</administration>
</extension>
</source>
</span>

Now you can see in your component '''hello-world''' an array with two colums, two rows and checkboxes. You can click the checkboxes in order to select the different options you want.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Using the database 
|next=Adding language management }}

== Contributors ==
*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:presto|Preston Smith]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding backend actions

2014-08-14T11:35:47Z

Gunjanpatel: /* Packaging the component */

{{:J3.1:Developing a MVC Component}}

{{review}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding a toolbar ==
In Joomla, the administrator interacts generally with components through the use of a toolbar. In the file ''admin/views/helloworlds/view.html.php'' put this content. It will create a basic toolbar and a title for the component.

The arguments used in, for example, JToolBarHelper::addNew is used to set a controller instance which will be used after button is clicked. Further details below in the [[#Adding_specific_controllers | adding specific controllers]] section.

<span id ="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise a JError object.
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS'));
JToolBarHelper::deleteList('', 'helloworlds.delete');
JToolBarHelper::editList('helloworld.edit');
JToolBarHelper::addNew('helloworld.add');
}
}
</source>
</span>

You can find other classic backend actions in the ''administrator/includes/toolbar.php'' file of your Joomla installation.

Since the view can perform some actions, we have to add some input data. With your favorite file manager and editor, put in the file ''admin/views/helloworlds/tmpl/default.php''

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
<div>
<input type="hidden" name="task" value="" />
<input type="hidden" name="boxchecked" value="0" />
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

== Adding specific controllers ==
Three actions have been added:
* ''helloworlds.delete''
* ''helloworld.edit''
* ''helloworld.add''
read more about [[JController_and_its_subclass_usage_overview|subcontrollers...]]

These are compound tasks (''controller''.''task''). So two new controllers ''HelloWorldControllerHelloWorlds'' and ''HelloWorldControllerHelloWorld'' have to be coded.

<span id="admin/controllers/helloworlds.php">
''admin/controllers/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controlleradmin library
jimport('joomla.application.component.controlleradmin');

/**
* HelloWorlds Controller
*/
class HelloWorldControllerHelloWorlds extends JControllerAdmin
{
/**
* Proxy for getModel.
* @since 2.5
*/
public function getModel($name = 'HelloWorld', $prefix = 'HelloWorldModel')
{
$model = parent::getModel($name, $prefix, array('ignore_request' => true));
return $model;
}
}
</source>
</span>

<span id="admin/controllers/helloworld.php">
''admin/controllers/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controllerform library
jimport('joomla.application.component.controllerform');

/**
* HelloWorld Controller
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
}
</source>
</span>

== Adding an editing view ==
With your favorite file manager and editor, put a file ''admin/views/helloworld/view.html.php'' containing:

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorld View
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* display method of Hello view
* @return void
*/
public function display($tpl = null)
{
// get the Data
$form = $this->get('Form');
$item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign the Data
$this->form = $form;
$this->item = $item;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
$input = JFactory::getApplication()->input;
$input->set('hidemainmenu', true);
$isNew = ($this->item->id == 0);
JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'));
JToolBarHelper::save('helloworld.save');
JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL'
: 'JTOOLBAR_CLOSE');
}
}
</source>
</span>

This view will display data using a layout.

Put a file ''admin/views/helloworld/tmpl/edit.php'' containing

<span id="admin/views/helloworld/tmpl/edit.php">
''admin/views/helloworld/tmpl/edit.php''
<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die('Restricted access');
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld&layout=edit&id=' . (int) $this->item->id); ?>"
method="post" name="adminForm" id="adminForm">
<div class="form-horizontal">
<fieldset class="adminform">
<legend><?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_DETAILS'); ?></legend>
<div class="row-fluid">
<div class="span6">
<?php foreach ($this->form->getFieldset() as $field): ?>
<div class="control-group">
<div class="control-label"><?php echo $field->label; ?></div>
<div class="controls"><?php echo $field->input; ?></div>
</div>
<?php endforeach; ?>
</div>
</div>
</fieldset>
</div>
<input type="hidden" name="task" value="helloworld.edit" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>
</span>

== Adding a model and modifying the existing one ==

The ''HelloWorldViewHelloWorld'' view asks form and data from a model. This model has to provide a ''getTable'', a ''getForm'' method and a ''loadData'' method (called from the ''JModelAdmin'' controller)

<span id="admin/models/helloworld.php">
''admin/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla modelform library
jimport('joomla.application.component.modeladmin');

/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Returns a reference to the a Table object, always creating it.
*
* @param type The table type to instantiate
* @param string A prefix for the table class name. Optional.
* @param array Configuration array for model. Optional.
* @return JTable A database object
* @since 2.5
*/
public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
/**
* Method to get the record form.
*
* @param array $data Data for the form.
* @param boolean $loadData True if the form is to load its own data (default case), false if not.
* @return mixed A JForm object on success, false on failure
* @since 2.5
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm('com_helloworld.helloworld', 'helloworld',
array('control' => 'jform', 'load_data' => $loadData));
if (empty($form))
{
return false;
}
return $form;
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
* @since 2.5
*/
protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState('com_helloworld.edit.helloworld.data', array());
if (empty($data))
{
$data = $this->getItem();
}
return $data;
}
}
</source>
</span>

This model inherits from the ''JModelAdmin'' class and uses its ''loadForm'' method. This method searches for forms in the ''forms'' folder. With your favorite file manager and editor, put a file ''admin/models/forms/helloworld.xml'' containing:

<span id="admin/models/forms/helloworld.xml">
''admin/models/forms/helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fieldset>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_GREETING_DESC"
size="40"
class="inputbox"
default=""
/>
</fieldset>
</form>
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* [[J3.x:Developing a MVC Component/Adding language management#site.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/forms/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/controllers/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[#admin/language/index.html|admin/language/index.html]]''
* ''[[#admin/language/en-GB/index.html|admin/language/en-GB/index.html]]''
* ''[[J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.sys.ini|language/en-GB/en-GB.com_helloworld.sys.ini]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-9-adding-backend-actions.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.9</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
<folder>language</folder>
</files>

<administration>

<menu>COM_HELLOWORLD_MENU</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>language</folder>

<folder>controllers</folder>
</files>
</administration>
</extension>
</source>
</span>

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Adding language management 

|next=Adding decorations to the backend }}

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:betweenbrain|Matt Thomas]]
*[[User:Gunjanpatel|Gunjan Patel]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding backend actions

2014-08-14T11:33:10Z

Gunjanpatel: /* Packaging the component */

{{:J3.1:Developing a MVC Component}}

{{review}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding a toolbar ==
In Joomla, the administrator interacts generally with components through the use of a toolbar. In the file ''admin/views/helloworlds/view.html.php'' put this content. It will create a basic toolbar and a title for the component.

The arguments used in, for example, JToolBarHelper::addNew is used to set a controller instance which will be used after button is clicked. Further details below in the [[#Adding_specific_controllers | adding specific controllers]] section.

<span id ="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise a JError object.
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS'));
JToolBarHelper::deleteList('', 'helloworlds.delete');
JToolBarHelper::editList('helloworld.edit');
JToolBarHelper::addNew('helloworld.add');
}
}
</source>
</span>

You can find other classic backend actions in the ''administrator/includes/toolbar.php'' file of your Joomla installation.

Since the view can perform some actions, we have to add some input data. With your favorite file manager and editor, put in the file ''admin/views/helloworlds/tmpl/default.php''

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
<div>
<input type="hidden" name="task" value="" />
<input type="hidden" name="boxchecked" value="0" />
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

== Adding specific controllers ==
Three actions have been added:
* ''helloworlds.delete''
* ''helloworld.edit''
* ''helloworld.add''
read more about [[JController_and_its_subclass_usage_overview|subcontrollers...]]

These are compound tasks (''controller''.''task''). So two new controllers ''HelloWorldControllerHelloWorlds'' and ''HelloWorldControllerHelloWorld'' have to be coded.

<span id="admin/controllers/helloworlds.php">
''admin/controllers/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controlleradmin library
jimport('joomla.application.component.controlleradmin');

/**
* HelloWorlds Controller
*/
class HelloWorldControllerHelloWorlds extends JControllerAdmin
{
/**
* Proxy for getModel.
* @since 2.5
*/
public function getModel($name = 'HelloWorld', $prefix = 'HelloWorldModel')
{
$model = parent::getModel($name, $prefix, array('ignore_request' => true));
return $model;
}
}
</source>
</span>

<span id="admin/controllers/helloworld.php">
''admin/controllers/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controllerform library
jimport('joomla.application.component.controllerform');

/**
* HelloWorld Controller
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
}
</source>
</span>

== Adding an editing view ==
With your favorite file manager and editor, put a file ''admin/views/helloworld/view.html.php'' containing:

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorld View
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* display method of Hello view
* @return void
*/
public function display($tpl = null)
{
// get the Data
$form = $this->get('Form');
$item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign the Data
$this->form = $form;
$this->item = $item;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
$input = JFactory::getApplication()->input;
$input->set('hidemainmenu', true);
$isNew = ($this->item->id == 0);
JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'));
JToolBarHelper::save('helloworld.save');
JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL'
: 'JTOOLBAR_CLOSE');
}
}
</source>
</span>

This view will display data using a layout.

Put a file ''admin/views/helloworld/tmpl/edit.php'' containing

<span id="admin/views/helloworld/tmpl/edit.php">
''admin/views/helloworld/tmpl/edit.php''
<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die('Restricted access');
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld&layout=edit&id=' . (int) $this->item->id); ?>"
method="post" name="adminForm" id="adminForm">
<div class="form-horizontal">
<fieldset class="adminform">
<legend><?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_DETAILS'); ?></legend>
<div class="row-fluid">
<div class="span6">
<?php foreach ($this->form->getFieldset() as $field): ?>
<div class="control-group">
<div class="control-label"><?php echo $field->label; ?></div>
<div class="controls"><?php echo $field->input; ?></div>
</div>
<?php endforeach; ?>
</div>
</div>
</fieldset>
</div>
<input type="hidden" name="task" value="helloworld.edit" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>
</span>

== Adding a model and modifying the existing one ==

The ''HelloWorldViewHelloWorld'' view asks form and data from a model. This model has to provide a ''getTable'', a ''getForm'' method and a ''loadData'' method (called from the ''JModelAdmin'' controller)

<span id="admin/models/helloworld.php">
''admin/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla modelform library
jimport('joomla.application.component.modeladmin');

/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Returns a reference to the a Table object, always creating it.
*
* @param type The table type to instantiate
* @param string A prefix for the table class name. Optional.
* @param array Configuration array for model. Optional.
* @return JTable A database object
* @since 2.5
*/
public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
/**
* Method to get the record form.
*
* @param array $data Data for the form.
* @param boolean $loadData True if the form is to load its own data (default case), false if not.
* @return mixed A JForm object on success, false on failure
* @since 2.5
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm('com_helloworld.helloworld', 'helloworld',
array('control' => 'jform', 'load_data' => $loadData));
if (empty($form))
{
return false;
}
return $form;
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
* @since 2.5
*/
protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState('com_helloworld.edit.helloworld.data', array());
if (empty($data))
{
$data = $this->getItem();
}
return $data;
}
}
</source>
</span>

This model inherits from the ''JModelAdmin'' class and uses its ''loadForm'' method. This method searches for forms in the ''forms'' folder. With your favorite file manager and editor, put a file ''admin/models/forms/helloworld.xml'' containing:

<span id="admin/models/forms/helloworld.xml">
''admin/models/forms/helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fieldset>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_GREETING_DESC"
size="40"
class="inputbox"
default=""
/>
</fieldset>
</form>
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* [[J3.x:Developing a MVC Component/Adding language management#site.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/forms/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/controllers/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[#admin/language/index.html|admin/language/index.html]]''
* ''[[#admin/language/en-GB/index.html|admin/language/en-GB/index.html]]''
* ''[[J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[J3.x:Developing a MVC Component/Adding language management##admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[J3.x:Developing a MVC Component/Adding language management##admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.sys.ini|language/en-GB/en-GB.com_helloworld.sys.ini]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-9-adding-backend-actions.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.9</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
<folder>language</folder>
</files>

<administration>

<menu>COM_HELLOWORLD_MENU</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>language</folder>

<folder>controllers</folder>
</files>
</administration>
</extension>
</source>
</span>

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Adding language management 

|next=Adding decorations to the backend }}

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:betweenbrain|Matt Thomas]]
*[[User:Gunjanpatel|Gunjan Patel]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding backend actions

2014-08-14T11:29:07Z

Gunjanpatel: /* Contributors */

{{:J3.1:Developing a MVC Component}}

{{review}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding a toolbar ==
In Joomla, the administrator interacts generally with components through the use of a toolbar. In the file ''admin/views/helloworlds/view.html.php'' put this content. It will create a basic toolbar and a title for the component.

The arguments used in, for example, JToolBarHelper::addNew is used to set a controller instance which will be used after button is clicked. Further details below in the [[#Adding_specific_controllers | adding specific controllers]] section.

<span id ="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise a JError object.
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS'));
JToolBarHelper::deleteList('', 'helloworlds.delete');
JToolBarHelper::editList('helloworld.edit');
JToolBarHelper::addNew('helloworld.add');
}
}
</source>
</span>

You can find other classic backend actions in the ''administrator/includes/toolbar.php'' file of your Joomla installation.

Since the view can perform some actions, we have to add some input data. With your favorite file manager and editor, put in the file ''admin/views/helloworlds/tmpl/default.php''

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
<div>
<input type="hidden" name="task" value="" />
<input type="hidden" name="boxchecked" value="0" />
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

== Adding specific controllers ==
Three actions have been added:
* ''helloworlds.delete''
* ''helloworld.edit''
* ''helloworld.add''
read more about [[JController_and_its_subclass_usage_overview|subcontrollers...]]

These are compound tasks (''controller''.''task''). So two new controllers ''HelloWorldControllerHelloWorlds'' and ''HelloWorldControllerHelloWorld'' have to be coded.

<span id="admin/controllers/helloworlds.php">
''admin/controllers/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controlleradmin library
jimport('joomla.application.component.controlleradmin');

/**
* HelloWorlds Controller
*/
class HelloWorldControllerHelloWorlds extends JControllerAdmin
{
/**
* Proxy for getModel.
* @since 2.5
*/
public function getModel($name = 'HelloWorld', $prefix = 'HelloWorldModel')
{
$model = parent::getModel($name, $prefix, array('ignore_request' => true));
return $model;
}
}
</source>
</span>

<span id="admin/controllers/helloworld.php">
''admin/controllers/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controllerform library
jimport('joomla.application.component.controllerform');

/**
* HelloWorld Controller
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
}
</source>
</span>

== Adding an editing view ==
With your favorite file manager and editor, put a file ''admin/views/helloworld/view.html.php'' containing:

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorld View
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* display method of Hello view
* @return void
*/
public function display($tpl = null)
{
// get the Data
$form = $this->get('Form');
$item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign the Data
$this->form = $form;
$this->item = $item;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
$input = JFactory::getApplication()->input;
$input->set('hidemainmenu', true);
$isNew = ($this->item->id == 0);
JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'));
JToolBarHelper::save('helloworld.save');
JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL'
: 'JTOOLBAR_CLOSE');
}
}
</source>
</span>

This view will display data using a layout.

Put a file ''admin/views/helloworld/tmpl/edit.php'' containing

<span id="admin/views/helloworld/tmpl/edit.php">
''admin/views/helloworld/tmpl/edit.php''
<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die('Restricted access');
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld&layout=edit&id=' . (int) $this->item->id); ?>"
method="post" name="adminForm" id="adminForm">
<div class="form-horizontal">
<fieldset class="adminform">
<legend><?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_DETAILS'); ?></legend>
<div class="row-fluid">
<div class="span6">
<?php foreach ($this->form->getFieldset() as $field): ?>
<div class="control-group">
<div class="control-label"><?php echo $field->label; ?></div>
<div class="controls"><?php echo $field->input; ?></div>
</div>
<?php endforeach; ?>
</div>
</div>
</fieldset>
</div>
<input type="hidden" name="task" value="helloworld.edit" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>
</span>

== Adding a model and modifying the existing one ==

The ''HelloWorldViewHelloWorld'' view asks form and data from a model. This model has to provide a ''getTable'', a ''getForm'' method and a ''loadData'' method (called from the ''JModelAdmin'' controller)

<span id="admin/models/helloworld.php">
''admin/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla modelform library
jimport('joomla.application.component.modeladmin');

/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Returns a reference to the a Table object, always creating it.
*
* @param type The table type to instantiate
* @param string A prefix for the table class name. Optional.
* @param array Configuration array for model. Optional.
* @return JTable A database object
* @since 2.5
*/
public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
/**
* Method to get the record form.
*
* @param array $data Data for the form.
* @param boolean $loadData True if the form is to load its own data (default case), false if not.
* @return mixed A JForm object on success, false on failure
* @since 2.5
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm('com_helloworld.helloworld', 'helloworld',
array('control' => 'jform', 'load_data' => $loadData));
if (empty($form))
{
return false;
}
return $form;
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
* @since 2.5
*/
protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState('com_helloworld.edit.helloworld.data', array());
if (empty($data))
{
$data = $this->getItem();
}
return $data;
}
}
</source>
</span>

This model inherits from the ''JModelAdmin'' class and uses its ''loadForm'' method. This method searches for forms in the ''forms'' folder. With your favorite file manager and editor, put a file ''admin/models/forms/helloworld.xml'' containing:

<span id="admin/models/forms/helloworld.xml">
''admin/models/forms/helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fieldset>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_GREETING_DESC"
size="40"
class="inputbox"
default=""
/>
</fieldset>
</form>
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* [[J3.x:Developing a MVC Component/Adding language management#site.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/forms/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/controllers/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[#admin/language/index.html|admin/language/index.html]]''
* ''[[#admin/language/en-GB/index.html|admin/language/en-GB/index.html]]''
* ''[[#admin/language/en-GB/en-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[#admin/language/en-GB/en-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[#language/en-GB/en-GB.com_helloworld.sys.ini|language/en-GB/en-GB.com_helloworld.sys.ini]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-9-adding-backend-actions.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.9</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
<folder>language</folder>
</files>

<administration>

<menu>COM_HELLOWORLD_MENU</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>language</folder>

<folder>controllers</folder>
</files>
</administration>
</extension>
</source>
</span>

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Adding language management 

|next=Adding decorations to the backend }}

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:betweenbrain|Matt Thomas]]
*[[User:Gunjanpatel|Gunjan Patel]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding backend actions

2014-08-14T11:28:24Z

Gunjanpatel: /* Packaging the component */

{{:J3.1:Developing a MVC Component}}

{{review}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding a toolbar ==
In Joomla, the administrator interacts generally with components through the use of a toolbar. In the file ''admin/views/helloworlds/view.html.php'' put this content. It will create a basic toolbar and a title for the component.

The arguments used in, for example, JToolBarHelper::addNew is used to set a controller instance which will be used after button is clicked. Further details below in the [[#Adding_specific_controllers | adding specific controllers]] section.

<span id ="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return mixed A string if successful, otherwise a JError object.
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS'));
JToolBarHelper::deleteList('', 'helloworlds.delete');
JToolBarHelper::editList('helloworld.edit');
JToolBarHelper::addNew('helloworld.add');
}
}
</source>
</span>

You can find other classic backend actions in the ''administrator/includes/toolbar.php'' file of your Joomla installation.

Since the view can perform some actions, we have to add some input data. With your favorite file manager and editor, put in the file ''admin/views/helloworlds/tmpl/default.php''

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
<div>
<input type="hidden" name="task" value="" />
<input type="hidden" name="boxchecked" value="0" />
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

== Adding specific controllers ==
Three actions have been added:
* ''helloworlds.delete''
* ''helloworld.edit''
* ''helloworld.add''
read more about [[JController_and_its_subclass_usage_overview|subcontrollers...]]

These are compound tasks (''controller''.''task''). So two new controllers ''HelloWorldControllerHelloWorlds'' and ''HelloWorldControllerHelloWorld'' have to be coded.

<span id="admin/controllers/helloworlds.php">
''admin/controllers/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controlleradmin library
jimport('joomla.application.component.controlleradmin');

/**
* HelloWorlds Controller
*/
class HelloWorldControllerHelloWorlds extends JControllerAdmin
{
/**
* Proxy for getModel.
* @since 2.5
*/
public function getModel($name = 'HelloWorld', $prefix = 'HelloWorldModel')
{
$model = parent::getModel($name, $prefix, array('ignore_request' => true));
return $model;
}
}
</source>
</span>

<span id="admin/controllers/helloworld.php">
''admin/controllers/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controllerform library
jimport('joomla.application.component.controllerform');

/**
* HelloWorld Controller
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
}
</source>
</span>

== Adding an editing view ==
With your favorite file manager and editor, put a file ''admin/views/helloworld/view.html.php'' containing:

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorld View
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* display method of Hello view
* @return void
*/
public function display($tpl = null)
{
// get the Data
$form = $this->get('Form');
$item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign the Data
$this->form = $form;
$this->item = $item;

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);
}

/**
* Setting the toolbar
*/
protected function addToolBar()
{
$input = JFactory::getApplication()->input;
$input->set('hidemainmenu', true);
$isNew = ($this->item->id == 0);
JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'));
JToolBarHelper::save('helloworld.save');
JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL'
: 'JTOOLBAR_CLOSE');
}
}
</source>
</span>

This view will display data using a layout.

Put a file ''admin/views/helloworld/tmpl/edit.php'' containing

<span id="admin/views/helloworld/tmpl/edit.php">
''admin/views/helloworld/tmpl/edit.php''
<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die('Restricted access');
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld&layout=edit&id=' . (int) $this->item->id); ?>"
method="post" name="adminForm" id="adminForm">
<div class="form-horizontal">
<fieldset class="adminform">
<legend><?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_DETAILS'); ?></legend>
<div class="row-fluid">
<div class="span6">
<?php foreach ($this->form->getFieldset() as $field): ?>
<div class="control-group">
<div class="control-label"><?php echo $field->label; ?></div>
<div class="controls"><?php echo $field->input; ?></div>
</div>
<?php endforeach; ?>
</div>
</div>
</fieldset>
</div>
<input type="hidden" name="task" value="helloworld.edit" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>
</span>

== Adding a model and modifying the existing one ==

The ''HelloWorldViewHelloWorld'' view asks form and data from a model. This model has to provide a ''getTable'', a ''getForm'' method and a ''loadData'' method (called from the ''JModelAdmin'' controller)

<span id="admin/models/helloworld.php">
''admin/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla modelform library
jimport('joomla.application.component.modeladmin');

/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Returns a reference to the a Table object, always creating it.
*
* @param type The table type to instantiate
* @param string A prefix for the table class name. Optional.
* @param array Configuration array for model. Optional.
* @return JTable A database object
* @since 2.5
*/
public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
/**
* Method to get the record form.
*
* @param array $data Data for the form.
* @param boolean $loadData True if the form is to load its own data (default case), false if not.
* @return mixed A JForm object on success, false on failure
* @since 2.5
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm('com_helloworld.helloworld', 'helloworld',
array('control' => 'jform', 'load_data' => $loadData));
if (empty($form))
{
return false;
}
return $form;
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
* @since 2.5
*/
protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState('com_helloworld.edit.helloworld.data', array());
if (empty($data))
{
$data = $this->getItem();
}
return $data;
}
}
</source>
</span>

This model inherits from the ''JModelAdmin'' class and uses its ''loadForm'' method. This method searches for forms in the ''forms'' folder. With your favorite file manager and editor, put a file ''admin/models/forms/helloworld.xml'' containing:

<span id="admin/models/forms/helloworld.xml">
''admin/models/forms/helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fieldset>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_GREETING_DESC"
size="40"
class="inputbox"
default=""
/>
</fieldset>
</form>
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* [[J3.x:Developing a MVC Component/Adding language management#site.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/forms/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/controllers/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[#admin/language/index.html|admin/language/index.html]]''
* ''[[#admin/language/en-GB/index.html|admin/language/en-GB/index.html]]''
* ''[[#admin/language/en-GB/en-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[#admin/language/en-GB/en-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[#language/en-GB/en-GB.com_helloworld.sys.ini|language/en-GB/en-GB.com_helloworld.sys.ini]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-9-adding-backend-actions.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.9</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
<folder>language</folder>
</files>

<administration>

<menu>COM_HELLOWORLD_MENU</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>language</folder>

<folder>controllers</folder>
</files>
</administration>
</extension>
</source>
</span>

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Adding language management 

|next=Adding decorations to the backend }}

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:betweenbrain|Matt Thomas]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding a view to the site part

2014-08-13T07:13:39Z

Gunjanpatel: /* Contributors */

{{version/tutor|3.2}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!3.1 - Contents}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();
</source>

The ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''yoursite/components/com_helloworld/controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* Hello World Component Controller
*
* @since 0.0.1
*/
class HelloWorldController extends JControllerLegacy
{
}
</source>

When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JControllerLegacy'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JControllerLegacy'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''yoursite/components/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>

The ''display'' method of the ''[http://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql/</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>
</span>

'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==

*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

J3.x:Developing an MVC Component/Basic backend

2014-08-13T06:44:54Z

Gunjanpatel: /* Contributors */

{{:J3.1:Developing a MVC Component}}

{{review}}

This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Basic backend ==
Designing the backend interface leads us to create at least a Model-View-Controller triptych. We have to modify the administrator entry point of our component, the ''admin/helloworld.php'' file

<span id="admin/helloworld.php">
''admin/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import joomla controller library
jimport('joomla.application.component.controller');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();

</source>
</span>

== Create the general controller ==
The entry point now gets an instance of a ''HelloWorld'' prefixed controller. Let's create a basic controller for the administrator part:

<span id="admin/controller.php">
''admin/controller.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* General Controller of HelloWorld component
*/
class HelloWorldController extends JControllerLegacy
{
/**
* display task
*
* @return void
*/
function display($cachable = false, $urlparams = false)
{
// set default view if not set
$input = JFactory::getApplication()->input;
$input->set('view', $input->getCmd('view', 'HelloWorlds'));

// call parent behavior
parent::display($cachable);
}
}

</source>
</span>

This controller will display the 'HelloWorlds' view by default.

== Create the view ==

With your favorite file manager and editor, create a file ''admin/views/helloworlds/view.html.php'' containing:

<span id="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Display the template
parent::display($tpl);
}
}
</source>
</span>

In Joomla, views display data using layout. With your favorite file manager and editor, put a file ''admin/views/helloworlds/tmpl/default.php'' containing

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');

// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
</form>
</source>
</span>

This layout calls several sub-layout (''head'', ''foot'' and ''body''). Each sub-layout corresponds to a file prefixed by the name of the main layout (''default''), and an underscore.

Put a file ''admin/views/helloworlds/tmpl/default_head.php'' containing

<span id="admin/views/helloworlds/tmpl/default_head.php">
''admin/views/helloworlds/tmpl/default_head.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<th width="20">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th>
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'); ?>
</th>
<th width="5">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_ID'); ?>
</th>
</tr>
</source>
</span>

''COM_HELLOWORLD_HELLOWORLD_HEADING_ID'' and ''COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'' are placeholders which will later be replaced with language-specific text. The [http://api.joomla.org/cms-3/classes/JText.html JText::_] method translates a string into the current language.

''checkAll'' is a javascript function defined in the Joomla core able to check all items.

Put a file ''admin/views/helloworlds/tmpl/default_body.php'' containing

<span id="admin/views/helloworlds/tmpl/default_body.php">
''admin/views/helloworlds/tmpl/default_body.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<?php foreach($this->items as $i => $item): ?>
<tr class="row<?php echo $i % 2; ?>">
<td>
<?php echo JHtml::_('grid.id', $i, $item->id); ?>
</td>
<td>
<?php echo $item->greeting; ?>
</td>
<td>
<?php echo $item->id; ?>
</td>
</tr>
<?php endforeach; ?>
</source>
</span>

''JHtml::_'' is a helper function able to display several HTML output. In this case, it will display a checkbox for the item.

Put a file ''admin/views/helloworlds/tmpl/default_foot.php'' containing

<span id="admin/views/helloworlds/tmpl/default_foot.php">
''admin/views/helloworlds/tmpl/default_foot.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<td colspan="3"><?php echo $this->pagination->getListFooter(); ?></td>
</tr>
</source>
</span>

''JPagination'' is a Joomla class able to manage and display pagination object.

== Create the model ==
The ''HelloWorlds'' view asks the model for data. In Joomla, there is a class able to manage a list of data: ''JModelList''. Class ''JModelList'' and inherited classes need only one method:
* ''getListQuery'' which constructs an SQL query

and two states:
* ''list.start'' for determining the list offset
* ''list.limit'' for determining the list length

The ''getItems'' and ''getPagination'' methods are defined in JModelList class. They don't need to be defined in the ''HelloWorldModelHelloWorlds'' class.

<span id="admin/models/helloworlds.php">
''admin/models/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import the Joomla modellist library
jimport('joomla.application.component.modellist');
/**
* HelloWorldList Model
*/
class HelloWorldModelHelloWorlds extends JModelList
{
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Create a new query object.
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields from the hello table
$query
->select('id,greeting')
->from('#__helloworld');

return $query;
}
}
</source>
</span>

The ''_populateState'' method is, by default, automatically called when a state is read by the ''getState'' method.

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-7-basic-backend.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">
<name>Hello World!</name>
<creationDate>January 2014</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<version>0.0.7</version>
<description>Description of the Hello World component ...</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>

<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
</files>

<administration>
<menu>Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>

<folder>views</folder>
</files>
</administration>
</extension>
</source>
</span>

Now you can see in your component '''hello-world''' an array with two colums, two rows and checkboxes. You can click the checkboxes in order to select the different options you want.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Using the database 
|next=Adding language management }}

== Contributors ==
*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:presto|Preston Smith]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

User:Gunjanpatel

2014-08-13T06:44:22Z

Gunjanpatel: Created page with " I am [http://about.me/patelgunjan Gunjan Patel] from Ahmedabad, Gujarat, India. I am an active contributor and volunteer of Joomla! Project. Among others, my roles are: B..."

I am [http://about.me/patelgunjan Gunjan Patel] from Ahmedabad, Gujarat, India. I am an active contributor and volunteer of Joomla! Project. Among others, my roles are: [[Bug Squad Coding Team|Joomla! Bug Squad member]], [[GSOC 2014|Google Summer Of Code (GSoC) 2014 ]] mentor, Founder of Joomla! User Network Ahmedabad ([http://community.joomla.org/user-groups/asia-pacific/india/joomla-user-group-gujarat.html JUGAhmedabad]), [https://github.com/joomla-projects/com_localise com_localise] component helper and Gujarati Translator, Joomla! Event Speaker.

J3.x:Developing an MVC Component/Basic backend

2014-08-13T06:24:33Z

Gunjanpatel: JText API link Corrected

{{:J3.1:Developing a MVC Component}}

{{review}}

This is a multiple-article series of tutorials on how to develop a Model-View-Contoller [[Component]] for Joomla! Version {{JVer|{{CurrentSTSVer|minor}}}}.

== Introduction ==
This tutorial is part of the [[J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Basic backend ==
Designing the backend interface leads us to create at least a Model-View-Controller triptych. We have to modify the administrator entry point of our component, the ''admin/helloworld.php'' file

<span id="admin/helloworld.php">
''admin/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import joomla controller library
jimport('joomla.application.component.controller');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();

</source>
</span>

== Create the general controller ==
The entry point now gets an instance of a ''HelloWorld'' prefixed controller. Let's create a basic controller for the administrator part:

<span id="admin/controller.php">
''admin/controller.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* General Controller of HelloWorld component
*/
class HelloWorldController extends JControllerLegacy
{
/**
* display task
*
* @return void
*/
function display($cachable = false, $urlparams = false)
{
// set default view if not set
$input = JFactory::getApplication()->input;
$input->set('view', $input->getCmd('view', 'HelloWorlds'));

// call parent behavior
parent::display($cachable);
}
}

</source>
</span>

This controller will display the 'HelloWorlds' view by default.

== Create the view ==

With your favorite file manager and editor, create a file ''admin/views/helloworlds/view.html.php'' containing:

<span id="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* HelloWorlds view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

// Display the template
parent::display($tpl);
}
}
</source>
</span>

In Joomla, views display data using layout. With your favorite file manager and editor, put a file ''admin/views/helloworlds/tmpl/default.php'' containing

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');

// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
</form>
</source>
</span>

This layout calls several sub-layout (''head'', ''foot'' and ''body''). Each sub-layout corresponds to a file prefixed by the name of the main layout (''default''), and an underscore.

Put a file ''admin/views/helloworlds/tmpl/default_head.php'' containing

<span id="admin/views/helloworlds/tmpl/default_head.php">
''admin/views/helloworlds/tmpl/default_head.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<th width="20">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th>
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'); ?>
</th>
<th width="5">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_ID'); ?>
</th>
</tr>
</source>
</span>

''COM_HELLOWORLD_HELLOWORLD_HEADING_ID'' and ''COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'' are placeholders which will later be replaced with language-specific text. The [http://api.joomla.org/cms-3/classes/JText.html JText::_] method translates a string into the current language.

''checkAll'' is a javascript function defined in the Joomla core able to check all items.

Put a file ''admin/views/helloworlds/tmpl/default_body.php'' containing

<span id="admin/views/helloworlds/tmpl/default_body.php">
''admin/views/helloworlds/tmpl/default_body.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<?php foreach($this->items as $i => $item): ?>
<tr class="row<?php echo $i % 2; ?>">
<td>
<?php echo JHtml::_('grid.id', $i, $item->id); ?>
</td>
<td>
<?php echo $item->greeting; ?>
</td>
<td>
<?php echo $item->id; ?>
</td>
</tr>
<?php endforeach; ?>
</source>
</span>

''JHtml::_'' is a helper function able to display several HTML output. In this case, it will display a checkbox for the item.

Put a file ''admin/views/helloworlds/tmpl/default_foot.php'' containing

<span id="admin/views/helloworlds/tmpl/default_foot.php">
''admin/views/helloworlds/tmpl/default_foot.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<td colspan="3"><?php echo $this->pagination->getListFooter(); ?></td>
</tr>
</source>
</span>

''JPagination'' is a Joomla class able to manage and display pagination object.

== Create the model ==
The ''HelloWorlds'' view asks the model for data. In Joomla, there is a class able to manage a list of data: ''JModelList''. Class ''JModelList'' and inherited classes need only one method:
* ''getListQuery'' which constructs an SQL query

and two states:
* ''list.start'' for determining the list offset
* ''list.limit'' for determining the list length

The ''getItems'' and ''getPagination'' methods are defined in JModelList class. They don't need to be defined in the ''HelloWorldModelHelloWorlds'' class.

<span id="admin/models/helloworlds.php">
''admin/models/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import the Joomla modellist library
jimport('joomla.application.component.modellist');
/**
* HelloWorldList Model
*/
class HelloWorldModelHelloWorlds extends JModelList
{
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Create a new query object.
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields from the hello table
$query
->select('id,greeting')
->from('#__helloworld');

return $query;
}
}
</source>
</span>

The ''_populateState'' method is, by default, automatically called when a state is read by the ''getState'' method.

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#admin/controller.php|admin/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''

Create a compressed file of this directory or directly download the [https://github.com/joomla/Joomla-3.2-Hello-World-Component/archive/step-7-basic-backend.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">
<name>Hello World!</name>
<creationDate>January 2014</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<version>0.0.7</version>
<description>Description of the Hello World component ...</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>

<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
</files>

<administration>
<menu>Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>

<folder>views</folder>
</files>
</administration>
</extension>
</source>
</span>

Now you can see in your component '''hello-world''' an array with two colums, two rows and checkboxes. You can click the checkboxes in order to select the different options you want.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Using the database 
|next=Adding language management }}

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:presto|Preston Smith]]

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Beginner Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding a view to the site part

2014-08-11T06:30:47Z

Gunjanpatel: /* Correcting based on coding standard */

{{version/tutor|3.2}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!3.1 - Contents}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();
</source>

The ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''yoursite/components/com_helloworld/controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* Hello World Component Controller
*
* @since 0.0.1
*/
class HelloWorldController extends JControllerLegacy
{
}
</source>

When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JControllerLegacy'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JControllerLegacy'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''yoursite/components/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>

The ''display'' method of the ''[http://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql/</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>
</span>

'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

J3.x:Developing an MVC Component/Adding a view to the site part

2014-08-11T05:58:17Z

Gunjanpatel: /* Setting the view */

{{version/tutor|3.2}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!3.1 - Contents}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();
</source>

The ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''yoursite/components/com_helloworld/controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JControllerLegacy
{
}
</source>

When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JControllerLegacy'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JControllerLegacy'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''yoursite/components/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>

The ''display'' method of the ''[http://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql/</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>
</span>

'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

J3.x:Developing an MVC Component/Adding a view to the site part

2014-08-11T05:52:41Z

Gunjanpatel: /* Setting the controller */

{{version/tutor|3.2}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!3.1 - Contents}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();
</source>

The ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''yoursite/components/com_helloworld/controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JControllerLegacy
{
}
</source>

When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JControllerLegacy'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JControllerLegacy'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''yoursite/components/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HTML View class for the HelloWorld Component
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
// Overwriting JView display method
function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>

The ''display'' method of the ''[http://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql/</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>
</span>

'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

Talk:Sandbox2

2014-08-11T05:48:30Z

Gunjanpatel: /* This is test */

Feel free to play with the wikitext and features on this page. It'll be purged irregulary.
You can find a few links to the manual on the [[Help:Contents|Help page]].

Have fun!

<math>[[Image:Insert formula here]]
== [[Headline text]]'''''Italic text'''[[Media:
----
Example.ogg]]'' ==
</math>

== New Section ==

This is a new section of a talk page.

Talk:Sandbox2

2014-08-11T05:47:54Z

Gunjanpatel:

JDOC:Sandbox

2014-08-11T05:46:52Z

Gunjanpatel: hello test

Our sandbox
CHEYYAR TNSF MOTHILAL

=== something else ===
Testing More

JDOC:Sandbox

2014-08-11T05:45:55Z

Gunjanpatel: ~~~~Gunjan

Our sandbox
CHEYYAR TNSF MOTHILAL

=== something else ===
Testing

J3.x:Developing an MVC Component/Adding a view to the site part

2014-08-11T05:42:39Z

Gunjanpatel: /* Setting the controller */

{{version/tutor|3.2}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!3.1 - Contents}}

== Introduction ==
This tutorial is part of the [[J3.2:Developing_a_MVC_Component|Developing a Model-View-Controller (MVC) Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

In the Joomla!3.x framework, third party component authors divide their code into three main parts:
* ''models'' They manage the data
* ''controllers'' They perform tasks, set and get the states of the models and ask the views to display
* ''views'' They display the content according to the type (''error'', ''feed'', ''html'', ''json'', ''raw'', ''xml'') and the layout chosen by the controllers

== Setting the controller ==
In the core code of Joomla, there is a class able to manage controllers: ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]''. This class has to be extended to be used in our component. In the file ''yoursite/components/com_helloworld/helloworld.php'' (entry point of our ''Hello World'' component), put these lines:

{{vanchor|site/helloworld.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2014 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die;

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();
</source>

The ''[http://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in an aptly named file called ''yoursite/components/com_helloworld/controller.php'' (it's a default behavior).

Now, ''controller.php'' needs to be created and ''HelloWorldController'' needs to be declared and defined. So with your favorite file manager and editor, create a ''yoursite/components/com_helloworld/controller.php'' file containing

{{vanchor|site/controller.php}}
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* Hello World Component Controller
*/
class HelloWorldController extends JControllerLegacy
{
}
</source>

When no task is given in the request variables, the default task will be executed. It's the ''display'' task by default. The ''JControllerLegacy'' class has such a task. In our example, it will display a view named ''HelloWorld''.

So with ''task'' simply a public function display() of ''JControllerLegacy'' is refered to.

{{tip|Just a side note for completion, you could call another function aside from ''display()'' by using an URL like this one:

<pre>http://localhost/index.php?option=com_helloworld&task=insert</pre>

This would try to call a function ''insert()'' of our controller (which we would actually have to implement in ''HelloWorldController'' ).}}

== Setting the view ==

When JControllerLegacy wants to display a view, it will look for certain files in the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder.

The name of the folder of the default view is the name of the component itself. In our case the path is ''yoursite/components/com_helloworld/views/helloworld/''.

The file that will contain the code of the view is called ''view.[view_mode].php''. The default view mode, and probably the only view a component might need is the ''html'' mode. So this give us our file name which is ''view.html.php''.

With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/view.html.php'' able to display the default view and containing:

<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HTML View class for the HelloWorld Component
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
// Overwriting JView display method
function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>

The ''display'' method of the ''[http://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' class is called with the ''display'' task of the JControllerLegacy class. In our case, this method will display data using the ''tmpl/default.php'' file. With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/views/helloworld/tmpl/default.php'' able to display the default view and containing:

<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

This template file will be included by the JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.

So to give an example, one could call the view inside the ''yoursite/components/com_[component_name]/views/[name of view]/'' folder by calling <code>index.php?option=com_helloworld</code> (this would default to the ''yoursite/components/com_helloworld/views/helloworld/'' folder) or we could explicitly call the folder by calling: <code>index.php?option=com_helloworld&view=helloworld</code>

if we change <code>&view=helloworld</code> to something else, e.g. <code>&view=fluffy</code> we would have to create a folder <code>components/com_helloworld/views/fluffy/</code>.

Copy the contents of <code>views/helloworld</code> to <code>views/fluffy</code>

The classname of the file <code>view.html.php</code> of the fluffy folder would be ''HelloWorldViewFluffy''. Afterwards you can customize the contents of ''default.php'' of the ''fluffy'' subfolder for custom output and see the output by calling <code>index.php?option=com_helloworld&view=fluffy</code>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[#site/controller.php|site/controller.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58226/com_helloworld-1.6-part02.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="2.5.0" method="upgrade">

<name>Hello World!</name>

<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.2</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql/</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
</files>

<administration>

<menu>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>
</span>

'''Result:'''
You will see by default the message contained in the variable ''$this->msg'' in the ''view.html.php'' file.

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate|prev=Developing a Basic Component|next=Adding a menu type to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]

J3.x:Developing an MVC Component

2014-08-08T13:12:27Z

Gunjanpatel:

{{version/tutor|3.x}}
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!3.1 - Contents}}

This is a multiple-article series of tutorials on how to develop a Model-View-Controller [[Component]] for Joomla! Version {{JVer|{{Ns}}}}.

Begin with the [[Developing a Model-View-Controller Component/3.1/Introduction|Introduction]], and navigate the articles in this series by using the navigation box to the right (the ''Articles in this series'').

[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Beginner Development]]
[[Category:Component Development]]

Finding module positions on any given page

2014-08-07T07:22:41Z

Gunjanpatel:

To get a visual indication of all module positions used on a page you can follow this procedure:-

* {{JVer|2.5}}{{JVer|3.1}} In the administrative backend go to Extensions->Template Manager. Click on Options and set '''Preview Module Positions''' to '''enabled'''.
* navigate to any of the page in your web browser.
* click into the URL field in your browser.
* look for any "parameters" at the end of the URL. These are separated from the main part of the URL by a question mark. For example, in the URL <tt><nowiki>http://mydomain.com/index.php?id=17</nowiki></tt>, the "id=17" is a parameter.
* if there are no parameters, append "?tp=1" to the URL and press RETURN. For example, <tt><nowiki>http://mydomain.com/index.php?tp=1</nowiki></tt>.
* if there are already parameters in the URL, append "&tp=1" to the URL and press RETURN. For example, <tt><nowiki>http://mydomain.com/index.php?id=17&tp=1</nowiki></tt>.
* the module positions will be outlined in red.

Note that in some circumstances there may be module positions available that are not outlined in red. This can happen when a template defines those module positions as conditional on there being modules enabled in that position. If there are no modules enabled in that position then the template may adapt and the position will not be visible.
<noinclude>
[[Category:Modules]]
[[Category:Procedures]]
[[Category:Templates]]
[[Category:Template Development]]
[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]
[[Category:Tips and tricks 1.6]]
[[Category:Tips and tricks 1.7]]</noinclude>

Git for Testers and Trackers

2014-02-12T07:12:14Z

Gunjanpatel: /* CLI */

The following tasks are the typical ones needed for the Testing and Tracker teams.

# '''Set up local Git repository (read only from trunk).'''
# '''Keep local repository updated with changes from trunk.'''
# '''Apply patches and pull requests.'''
## Option with branches.
## Option without branches.
# '''Reset files to unmodified state.'''
# '''Work with older versions.'''

{{tip|If you want to try a easy way for testing patches without learning git check this page: [[Component Patchtester for Testers]]}}

== Testing and Tracker Teams Work Flow ==
People who want to test Pending issues need to do the following. These same tasks apply to people who want to monitor the tracker and confirm Open issues.

# Create a local working copy of the Joomla trunk.
# Update this local copy with changes made to trunk.
# Apply proposed patches (from Confirmed issues) to trunk to see if they work correctly.
# Be able to restore the local copy to its unmodified state.

Testers may or may not wish to use Git branches in their testing work. For simple testing of one issue at a time, creating local branches is not necessary. For more complex testing or for testing multiple issues at a time, it is more convenient to create a local branch for each issue. Both approaches are documented here.

In some cases, it is important to identify when a bug or issue was first introduced. With Git it is easy to restore the local repository to a prior state (for example, to a point in time in the past) and test whether the issue was present in that version. This process is also documented here.

== Create Local Read-Only Repository ==
Testers do not need to create a remote repository on Github. They can simply create a local clone of the CMS trunk on their local test machine. This clone will allow them to easily keep up with changes made to the CMS trunk.

The steps for this process are shown below, first using the command-line-interface (CLI) for Git and then using Eclipse and eGit.

=== CLI Commands ===
# Navigate to your project root folder, for example: <code>c:\xampp\htdocs\joomla-cms</code>
# Enter command: <code>git clone <nowiki>git://github.com/joomla/joomla-cms.git</nowiki></code>. The system will work for a few minutes, copying the entire remote repository to your local system. When you are done, you will have a local copy of the Joomla CMS repository in the current directory, along with a git repository (in the .git subdirectory). Note that this URL points to the joomla-cms project on Github. This project becomes the remote origin for the local git repository. For example, the command <code>git remote -v</code> will now list origin as follows:
<div style="margin-left:42px;">
<source>
git remote -v
origin git://github.com/joomla/joomla-cms.git (fetch)
origin git://github.com/joomla/joomla-cms.git (push)
</source></div>

=== Eclipse Commands: ===
# Clone joomla-cms repository using the read-only URL. In Repositories View, click the button "Clone a Git Repository and add to this View". This screen will show the following.<br/>[[Image:Git-document-screenshot-20120529-02.png|Git-document-screenshot-20120529-02.png]]
# Select URI and click Next. The screen below will show.<br/>[[Image:Git-document-screenshot-20120529-03.png|Git-document-screenshot-20120529-03.png]]
#Enter the URI git://github.com/joomla/joomla-cms.git as shown above. Then click Next to see the screen below.<br/>[[Image:Git-document-screenshot-20120529-04.png|Git-document-screenshot-20120529-04.png]]
#This will default to select all branches. Keep this default and click Next to show the screen below.<br/>[[Image:Git-document-screenshot-20120529-05.png|Git-document-screenshot-20120529-05.png]]
#Click on Browse and browse to the desired root directory for the project (for example, c:\xampp\htdocs\joomla_development\joomla-cms). Then click Finish.
# In Eclipse, create new PHP project in same folder. It will give a warning that files exist in this folder (which is OK).
# In Eclipse, right-click on the project and select Team→Share to share the project. In the Share Project window, select Git and click Next. In the Configure Git Repository window, select "Use or create repository in parent folder of project" and click finish.
# Note that this creates a relationship between the local repository and the joomla-cms repository on Github. You can see this relationship by opening the Repositories View and expanding the Remotes tree as shown below.<br/>[[Image:Git-document-screenshot-20120530-01.png|Git-document-screenshot-20120530-01.png]]

=== TortoiseGit Commands: ===
# Clone joomla-cms repository using the read-only URL. Right-click on project folder ("tortoise-git" in this example) and select "Git Clone" as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-01.png|Tortoisegit-tutorial-screenshot-20120612-01.png]]{{-}}
# Enter the read-only URL and the desired project directory (again, "tortoise-git" in this example), as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-02.png|Tortoisegit-tutorial-screenshot-20120612-02.png]]{{-}}
# The system will work for a few minutes, showing progress in the Receiving objects window. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-03.png|Tortoisegit-tutorial-screenshot-20120612-03.png]]{{-}}
# When it is done, a success message will show as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-04.png|Tortoisegit-tutorial-screenshot-20120612-04.png]]{{-}}

== Update Local Git Repository with Changes Made to Trunk ==
The first time you clone the Joomla CMS repository on Github, you will have the latest version of trunk. However, the trunk changes frequently, as bugs are fixed and new features added. This means that you need to keep your local repository up to date with these changes, for example each day when you start working.

=== CLI: ===
# Make sure you are in the master branch of your local repository with this command: <code>git checkout master</code>
# Pull changes from the origin (joomla-cms): <code>git pull origin</code>
# If there are any changes, these will show. Otherwise, it will say "Already up to date."
# Check your status by entering: git status. The display should show:
$ git status<br/> <nowiki># On branch master</nowiki><br/> nothing to commit (working directory clean)

=== Eclipse ===
# Make sure you are on the master branch: {{rarr|Team,Switch To,master}}. (If you are already on master, the master branch will be grayed out.)
# Pull changes from origin. Right-click on the project in PHP Explorer and select Team→Pull.
# If there were changes made, you will see something like this. {{-}}[[Image:Git-document-screenshot-20120529-01.png|Git-document-screenshot-20120529-01.png]]{{-}} Otherwise, you will see a message indicating that everything was up to date, like this.{{-}} [[Image:Git-document-screenshot-20120529-06.png|Git-document-screenshot-20120529-06.png]]

=== TortoiseGit ===
# Make sure you are on the master branch by entering TortoiseGit→Switch/Checkout and selecting the "master" branch.
# Pull changes from origin. Right-click on the project folder, and select TortoiseGit→Pull as shown below. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-05.png|Tortoisegit-tutorial-screenshot-20120612-05.png]]
# In Remote, select "origin" as shown below and press OK. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-06.png|Tortoisegit-tutorial-screenshot-20120612-06.png]]
# The system will show a success message as follows. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-05.png|Tortoisegit-tutorial-screenshot-20120612-05.png]]

== Important Notes About Patch File Format ==
===Leading "a/" and "b/"===
There is a confusing aspect of working with patches between SVN, Eclipse, Git and the CLI. This has to do with the way files are referenced inside a patch. Most patches made with Eclipse and Git will have a leading "a/" and "b/" in front of the file names. For example, a standard Git patch will look like this:

diff --git a/components/com_content/controller.php b/components/com_content/controller.php
index 53cc63a..25cee76 100644
--- a/components/com_content/controller.php
+++ b/components/com_content/controller.php

However, patches made with SVN or using the "--no-prefix" option in Git will omit the leading "a/" and "b/" and show in the following format:

diff --git components/com_content/controller.php components/com_content/controller.php
index 53cc63a..ba2de80 100644
--- components/com_content/controller.php
+++ components/com_content/controller.php

Most patches will be in the first format. It is easy to apply patches in either format, but the exact commands are different. These are outlined below.

===Error Applying Patch Using CLI===
In some cases, patches made using Eclipse may not apply correctly using the CLI "apply" command. For example, you might get an error: <code>fatal: corrupt patch at line xxx</code>. This appears to be caused by the fact that Eclipse does not add a blank line to the end of the patch file. If you have this problem, try adding a blank line at the end of the patch file.

== Apply Patches and Pull Requests Without Branches ==
This can be done either with or without using branches. If you want to work on one patch at a time (similar to the SVN work flow), you can follow this work flow without branches.

=== CLI ===
# To apply a Git format patch: <code>git apply <file></code>. For example: <code>git apply mypatchfile.patch</code>.
# To apply an SVN format patch: <code>git apply -p0 <file></code>. For example: <code>git apply -p0 mypatchfile.patch.</code>

At this point, the proposed code changes have been made to your Joomla files. Now you can test the proposed changes to see whether they work correctly.

To apply a Github pull request, add ".diff" to the end of the pull request URL. For example:
<pre>https://github.com/joomla/joomla-cms/pull/2531.diff</pre>
This will display a Git-formatted patch file in your browser. Save this file to your local machine and use the command above to apply it.

=== Eclipse ===
# To apply a Git format patch: Team→Apply patch. The Patch input specification window will show. You can apply a patch from a file or by copying the patch to the clipboard.
# Click Next to show the Target Resource window. Select the PHP project to apply to patch and click Next.
# The Review Patch window will show. IMPORTANT: If the patch is in Git format, set "Ignore leading path elements" to 1. If the patch is in SVN format, this is not needed.
# At this point, if the patch will apply correctly, the files will show with a blue arrow as shown below.{{-}}[[File:Git-document-screenshot-20120530-02.png|Git-document-screenshot-20120530-02.png]]

Note: If a red "X" appears next to a file, it means the patch will not apply correctly. Check the patch file format to make sure you have the right setting for this type. Also, make sure you haven't already applied the patch.

=== TortoiseGit ===
# To apply a Git format patch: TortoiseGit→Review/apply single patch. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-08.png|Tortoisegit-tutorial-screenshot-20120612-08.png]]
# The following windows will show the files to be patched. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-09.png|Tortoisegit-tutorial-screenshot-20120612-09.png]]
# Click on the button "Patch all items". The screen will now show the changes to the last file in the patch as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-10.png|Tortoisegit-tutorial-screenshot-20120612-10.png]]

=== Video applying a patch using Github and PHPstorm ===
This 1 minute video shows how a .patch or .diff file is downloaded and added to your current PHPStorm project: {{#ev:youtube|7xdwNFPJdWk}}

== Apply Patches and Pull Requests Using Branches ==
In many cases, it can be easier to create a Git branch for each issue you are working on. This way you can be working on several issues at one time while keeping the code changes for each issue separated. Creating branches in Git is very easy. Here is the work flow for applying patches using branches.

=== CLI ===
# Create a new branch: <code>git branch issue-123</code> (creates a new branch called issue-123).
# Apply the patch as shown earlier.
# Commit the code change to the branch: <code>commit -a</code>. Now git will open the editor you chose when you installed git. Enter the commit message in the first line of the editor and save and exit. (If you are unfamiliar with the editor, you can either change the editor or use Eclipse, which bypasses this step in the process.) The commit message should be something short that tells you what you did, for example "Applied patch 123.patch"). OR You can commit the code change to the branch wihtout opening editor using <code>commit -a -m "<type_your_message_here>"</code>
# At this point, the branch contains the modified version of the Joomla files for you to test. You can easily switch back to the standard files with the command: <code>git checkout master</code>. To switch back to the modified version, use the command: <code>git checkout issue-123</code>.

=== Eclipse ===
# Create a new branch: Team→Switch To→New Branch. The Create a new branch window will show. Enter the name of the branch and click on Finish.
# Apply the patch as shown earlier.
# Commit the code change: Team→Commit. The Commit Changes window will show. Enter the commit message as shown in the example below.{{-}}[[Image:Git-document-screenshot-20120530-03.png|Git-document-screenshot-20120530-03.png]]{{-}} At this point, you can review the code changes or simply press the Commit button to commit the changes.
# To switch back to master or any other branch, again use Team→Switch To and select master or the desired branch.

=== TortoiseGit ===
# Create a new branch: Right-click on the project folder and select TortoiseGit→Create Branch, as shown below.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-11.png|Tortoisegit-tutorial-screenshot-20120612-11.png]]
# The following screen will show.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-12.png]]
# Enter the name of the new branch in Branch and press OK. Note that this also switches you to the new branch.
# Apply the patch as shown earlier.
# Commit the code change: Right-click on project folder, then Git Commit -> <your branch> as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-16.png|Tortoisegit-tutorial-screenshot-20120612-16.png]]
# Enter a commit message, check that you are in the right branch, and press OK, as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-17.png|Tortoisegit-tutorial-screenshot-20120612-17.png]]
# The system will show a success message as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-18.png|Tortoisegit-tutorial-screenshot-20120612-18.png]]

== Restore to Unmodified State (Without Branches) ==
If you are not using branches, when you are done testing an issue, you will need to restore your programs to the original unmodified state. Note that this is not needed if you are using branches.

=== CLI ===
# Use this command to undo ''any'' file changes: <code>git reset --hard origin/master</code>. If it doesn't work, you can use <code>git apply -R <file></code> ''to the state before the patch was applied''. For example, <code>git apply -R folder/file.diff</code>.
# Use this command to delete any new files added by the patch: <code>git clean -f -d</code>
#: This removes added files and directories.
# Run the command: git status and make sure it says "nothing to commit (working directory clean)".

=== Eclipse ===
# Use this command to undo any file changes: Team→Reset to show the Reset window. Select "Hard" for the Reset type and click on Reset.
# To remove any new files added by a patch, simple navigate to the files and delete them.

=== TortoiseGit ===
# Use this command to undo any file changes: TortoiseGit→Revert. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-21.png|Tortoisegit-tutorial-screenshot-20120612-21.png]]
#* Any changed files will show in a window as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-22.png|Tortoisegit-tutorial-screenshot-20120612-22.png]]
#* Check all changed files and click OK. The success screen will show as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-22a.png|Tortoisegit-tutorial-screenshot-20120612-22a.png]]
# Use this command to delete any new files: TortoiseGit→Clean up. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-23.png|Tortoisegit-tutorial-screenshot-20120612-23.png]]{{-}} The system will show a success window and the files that were deleted as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-24.png|Tortoisegit-tutorial-screenshot-20120612-24.png]]

== Restore to Unmodified State With Branches ==
If you use branches, it is much easier to switch back to the unmodified programs. You simply change back to the master branch. Once you are done with an issue, you will likely want to delete the branch you created. Here are the commands for that.

=== CLI ===
# Change back to the master branch: <code>git checkout master</code>
# Delete the desired branch: <code>git branch -D issue-123</code> (where issue-123 is the branch name)

=== Eclipse ===
# Change back to the master branch: Team→Switch to→master.
# Delete the desired branch: Team→Advanced→Delete Branch and select the desired branch to delete.

===TortoiseGit ===
# Change back to the master branch: TortoiseGit→Switch/Checkout. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-13.png|Tortoisegit-tutorial-screenshot-20120612-13.png]]
# Select master as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-25.png|Tortoisegit-tutorial-screenshot-20120612-25.png]]
# Delete the desired branch:
#* TortoiseGit→Show Log as shown here. [{{-}}[File:Tortoisegit-tutorial-screenshot-20120612-19.png|Tortoisegit-tutorial-screenshot-20120612-19.png]]
#* Right-click on the HEAD line and select Delete branch/tag→<name of the branch> as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-26.png|Tortoisegit-tutorial-screenshot-20120612-26.png]]

== Testing Older Versions of Trunk ==
At times, it is helpful to figure out which commit might have introduced a new issue. With Git it is easy to restore the code base to any point in time and then test whether an issue was present or not. Note that this is more difficult with the CLI version.

=== CLI ===
# Write some past commits to a temporary file. For example: <code>git log --since="2 weeks ago" --mylogfile.txt</code>
# Find the commit id of the desired date. Note that we only need the first 8 characters of the commit id.
# Checkout the desired commit: <code>git checkout <id></code> (for example: <code>git checkout ba574af0</code>).
# See the command reference for git bisect for a more advanced way to find which commit caused a bug.

=== Eclipse ===

# Open the History View: Team→Show in History. This will show a view similar to this:{{-}}[[Image:Git-document-screenshot-20120530-04.png|900px]]{{-}}This view shows every commit to the CMS repository. To restore your local files to a prior time, right click on the desired row in the history view and select Checkout. Your local files will be changed to the state as of that commit. You can now test that version.
# To change to a different version, repeat this process. To change back to the master branch (the latest version), do Team→Switch to→Master.

=== TortoiseGit ===
# Open the Log window. TortoiseGit→Show Log as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-19.png|Tortoisegit-tutorial-screenshot-20120612-19.png]]
# Right-click on the desired commit in the log listing and select Switch/Checkout to this... as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-27.png|Tortoisegit-tutorial-screenshot-20120612-27.png]]{{-}} You can now test that version.
# To change to a different version, repeat this process. To change back to the master branch (the latest version), do TortoiseGit→Switch/Checkout and select master.

[[Category:Bug Squad]]
[[Category:Development]]
[[Category:GitHub]]
[[Category:Video]]
[[Category:Testing]]

Git for Testers and Trackers

2014-02-12T07:11:27Z

Gunjanpatel: /* CLI */

The following tasks are the typical ones needed for the Testing and Tracker teams.

# '''Set up local Git repository (read only from trunk).'''
# '''Keep local repository updated with changes from trunk.'''
# '''Apply patches and pull requests.'''
## Option with branches.
## Option without branches.
# '''Reset files to unmodified state.'''
# '''Work with older versions.'''

{{tip|If you want to try a easy way for testing patches without learning git check this page: [[Component Patchtester for Testers]]}}

== Testing and Tracker Teams Work Flow ==
People who want to test Pending issues need to do the following. These same tasks apply to people who want to monitor the tracker and confirm Open issues.

# Create a local working copy of the Joomla trunk.
# Update this local copy with changes made to trunk.
# Apply proposed patches (from Confirmed issues) to trunk to see if they work correctly.
# Be able to restore the local copy to its unmodified state.

Testers may or may not wish to use Git branches in their testing work. For simple testing of one issue at a time, creating local branches is not necessary. For more complex testing or for testing multiple issues at a time, it is more convenient to create a local branch for each issue. Both approaches are documented here.

In some cases, it is important to identify when a bug or issue was first introduced. With Git it is easy to restore the local repository to a prior state (for example, to a point in time in the past) and test whether the issue was present in that version. This process is also documented here.

== Create Local Read-Only Repository ==
Testers do not need to create a remote repository on Github. They can simply create a local clone of the CMS trunk on their local test machine. This clone will allow them to easily keep up with changes made to the CMS trunk.

The steps for this process are shown below, first using the command-line-interface (CLI) for Git and then using Eclipse and eGit.

=== CLI Commands ===
# Navigate to your project root folder, for example: <code>c:\xampp\htdocs\joomla-cms</code>
# Enter command: <code>git clone <nowiki>git://github.com/joomla/joomla-cms.git</nowiki></code>. The system will work for a few minutes, copying the entire remote repository to your local system. When you are done, you will have a local copy of the Joomla CMS repository in the current directory, along with a git repository (in the .git subdirectory). Note that this URL points to the joomla-cms project on Github. This project becomes the remote origin for the local git repository. For example, the command <code>git remote -v</code> will now list origin as follows:
<div style="margin-left:42px;">
<source>
git remote -v
origin git://github.com/joomla/joomla-cms.git (fetch)
origin git://github.com/joomla/joomla-cms.git (push)
</source></div>

=== Eclipse Commands: ===
# Clone joomla-cms repository using the read-only URL. In Repositories View, click the button "Clone a Git Repository and add to this View". This screen will show the following.<br/>[[Image:Git-document-screenshot-20120529-02.png|Git-document-screenshot-20120529-02.png]]
# Select URI and click Next. The screen below will show.<br/>[[Image:Git-document-screenshot-20120529-03.png|Git-document-screenshot-20120529-03.png]]
#Enter the URI git://github.com/joomla/joomla-cms.git as shown above. Then click Next to see the screen below.<br/>[[Image:Git-document-screenshot-20120529-04.png|Git-document-screenshot-20120529-04.png]]
#This will default to select all branches. Keep this default and click Next to show the screen below.<br/>[[Image:Git-document-screenshot-20120529-05.png|Git-document-screenshot-20120529-05.png]]
#Click on Browse and browse to the desired root directory for the project (for example, c:\xampp\htdocs\joomla_development\joomla-cms). Then click Finish.
# In Eclipse, create new PHP project in same folder. It will give a warning that files exist in this folder (which is OK).
# In Eclipse, right-click on the project and select Team→Share to share the project. In the Share Project window, select Git and click Next. In the Configure Git Repository window, select "Use or create repository in parent folder of project" and click finish.
# Note that this creates a relationship between the local repository and the joomla-cms repository on Github. You can see this relationship by opening the Repositories View and expanding the Remotes tree as shown below.<br/>[[Image:Git-document-screenshot-20120530-01.png|Git-document-screenshot-20120530-01.png]]

=== TortoiseGit Commands: ===
# Clone joomla-cms repository using the read-only URL. Right-click on project folder ("tortoise-git" in this example) and select "Git Clone" as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-01.png|Tortoisegit-tutorial-screenshot-20120612-01.png]]{{-}}
# Enter the read-only URL and the desired project directory (again, "tortoise-git" in this example), as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-02.png|Tortoisegit-tutorial-screenshot-20120612-02.png]]{{-}}
# The system will work for a few minutes, showing progress in the Receiving objects window. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-03.png|Tortoisegit-tutorial-screenshot-20120612-03.png]]{{-}}
# When it is done, a success message will show as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-04.png|Tortoisegit-tutorial-screenshot-20120612-04.png]]{{-}}

== Update Local Git Repository with Changes Made to Trunk ==
The first time you clone the Joomla CMS repository on Github, you will have the latest version of trunk. However, the trunk changes frequently, as bugs are fixed and new features added. This means that you need to keep your local repository up to date with these changes, for example each day when you start working.

=== CLI: ===
# Make sure you are in the master branch of your local repository with this command: <code>git checkout master</code>
# Pull changes from the origin (joomla-cms): <code>git pull origin</code>
# If there are any changes, these will show. Otherwise, it will say "Already up to date."
# Check your status by entering: git status. The display should show:
$ git status<br/> <nowiki># On branch master</nowiki><br/> nothing to commit (working directory clean)

=== Eclipse ===
# Make sure you are on the master branch: {{rarr|Team,Switch To,master}}. (If you are already on master, the master branch will be grayed out.)
# Pull changes from origin. Right-click on the project in PHP Explorer and select Team→Pull.
# If there were changes made, you will see something like this. {{-}}[[Image:Git-document-screenshot-20120529-01.png|Git-document-screenshot-20120529-01.png]]{{-}} Otherwise, you will see a message indicating that everything was up to date, like this.{{-}} [[Image:Git-document-screenshot-20120529-06.png|Git-document-screenshot-20120529-06.png]]

=== TortoiseGit ===
# Make sure you are on the master branch by entering TortoiseGit→Switch/Checkout and selecting the "master" branch.
# Pull changes from origin. Right-click on the project folder, and select TortoiseGit→Pull as shown below. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-05.png|Tortoisegit-tutorial-screenshot-20120612-05.png]]
# In Remote, select "origin" as shown below and press OK. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-06.png|Tortoisegit-tutorial-screenshot-20120612-06.png]]
# The system will show a success message as follows. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-05.png|Tortoisegit-tutorial-screenshot-20120612-05.png]]

== Important Notes About Patch File Format ==
===Leading "a/" and "b/"===
There is a confusing aspect of working with patches between SVN, Eclipse, Git and the CLI. This has to do with the way files are referenced inside a patch. Most patches made with Eclipse and Git will have a leading "a/" and "b/" in front of the file names. For example, a standard Git patch will look like this:

diff --git a/components/com_content/controller.php b/components/com_content/controller.php
index 53cc63a..25cee76 100644
--- a/components/com_content/controller.php
+++ b/components/com_content/controller.php

However, patches made with SVN or using the "--no-prefix" option in Git will omit the leading "a/" and "b/" and show in the following format:

diff --git components/com_content/controller.php components/com_content/controller.php
index 53cc63a..ba2de80 100644
--- components/com_content/controller.php
+++ components/com_content/controller.php

Most patches will be in the first format. It is easy to apply patches in either format, but the exact commands are different. These are outlined below.

===Error Applying Patch Using CLI===
In some cases, patches made using Eclipse may not apply correctly using the CLI "apply" command. For example, you might get an error: <code>fatal: corrupt patch at line xxx</code>. This appears to be caused by the fact that Eclipse does not add a blank line to the end of the patch file. If you have this problem, try adding a blank line at the end of the patch file.

== Apply Patches and Pull Requests Without Branches ==
This can be done either with or without using branches. If you want to work on one patch at a time (similar to the SVN work flow), you can follow this work flow without branches.

=== CLI ===
# To apply a Git format patch: <code>git apply <file></code>. For example: <code>git apply mypatchfile.patch</code>.
# To apply an SVN format patch: <code>git apply -p0 <file></code>. For example: <code>git apply -p0 mypatchfile.patch.</code>

At this point, the proposed code changes have been made to your Joomla files. Now you can test the proposed changes to see whether they work correctly.

To apply a Github pull request, add ".diff" to the end of the pull request URL. For example:
<pre>https://github.com/joomla/joomla-cms/pull/2531.diff</pre>
This will display a Git-formatted patch file in your browser. Save this file to your local machine and use the command above to apply it.

=== Eclipse ===
# To apply a Git format patch: Team→Apply patch. The Patch input specification window will show. You can apply a patch from a file or by copying the patch to the clipboard.
# Click Next to show the Target Resource window. Select the PHP project to apply to patch and click Next.
# The Review Patch window will show. IMPORTANT: If the patch is in Git format, set "Ignore leading path elements" to 1. If the patch is in SVN format, this is not needed.
# At this point, if the patch will apply correctly, the files will show with a blue arrow as shown below.{{-}}[[File:Git-document-screenshot-20120530-02.png|Git-document-screenshot-20120530-02.png]]

Note: If a red "X" appears next to a file, it means the patch will not apply correctly. Check the patch file format to make sure you have the right setting for this type. Also, make sure you haven't already applied the patch.

=== TortoiseGit ===
# To apply a Git format patch: TortoiseGit→Review/apply single patch. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-08.png|Tortoisegit-tutorial-screenshot-20120612-08.png]]
# The following windows will show the files to be patched. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-09.png|Tortoisegit-tutorial-screenshot-20120612-09.png]]
# Click on the button "Patch all items". The screen will now show the changes to the last file in the patch as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-10.png|Tortoisegit-tutorial-screenshot-20120612-10.png]]

=== Video applying a patch using Github and PHPstorm ===
This 1 minute video shows how a .patch or .diff file is downloaded and added to your current PHPStorm project: {{#ev:youtube|7xdwNFPJdWk}}

== Apply Patches and Pull Requests Using Branches ==
In many cases, it can be easier to create a Git branch for each issue you are working on. This way you can be working on several issues at one time while keeping the code changes for each issue separated. Creating branches in Git is very easy. Here is the work flow for applying patches using branches.

=== CLI ===
# Create a new branch: <code>git branch issue-123</code> (creates a new branch called issue-123).
# Apply the patch as shown earlier.
# Commit the code change to the branch: <code>commit -a</code>. Now git will open the editor you chose when you installed git. Enter the commit message in the first line of the editor and save and exit. (If you are unfamiliar with the editor, you can either change the editor or use Eclipse, which bypasses this step in the process.) The commit message should be something short that tells you what you did, for example "Applied patch 123.patch").
OR You can commit the code change to the branch wihtout opening editor using <code>commit -a -m "<type_your_message_here>"</code>
# At this point, the branch contains the modified version of the Joomla files for you to test. You can easily switch back to the standard files with the command: <code>git checkout master</code>. To switch back to the modified version, use the command: <code>git checkout issue-123</code>.

=== Eclipse ===
# Create a new branch: Team→Switch To→New Branch. The Create a new branch window will show. Enter the name of the branch and click on Finish.
# Apply the patch as shown earlier.
# Commit the code change: Team→Commit. The Commit Changes window will show. Enter the commit message as shown in the example below.{{-}}[[Image:Git-document-screenshot-20120530-03.png|Git-document-screenshot-20120530-03.png]]{{-}} At this point, you can review the code changes or simply press the Commit button to commit the changes.
# To switch back to master or any other branch, again use Team→Switch To and select master or the desired branch.

=== TortoiseGit ===
# Create a new branch: Right-click on the project folder and select TortoiseGit→Create Branch, as shown below.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-11.png|Tortoisegit-tutorial-screenshot-20120612-11.png]]
# The following screen will show.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-12.png]]
# Enter the name of the new branch in Branch and press OK. Note that this also switches you to the new branch.
# Apply the patch as shown earlier.
# Commit the code change: Right-click on project folder, then Git Commit -> <your branch> as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-16.png|Tortoisegit-tutorial-screenshot-20120612-16.png]]
# Enter a commit message, check that you are in the right branch, and press OK, as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-17.png|Tortoisegit-tutorial-screenshot-20120612-17.png]]
# The system will show a success message as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-18.png|Tortoisegit-tutorial-screenshot-20120612-18.png]]

== Restore to Unmodified State (Without Branches) ==
If you are not using branches, when you are done testing an issue, you will need to restore your programs to the original unmodified state. Note that this is not needed if you are using branches.

=== CLI ===
# Use this command to undo ''any'' file changes: <code>git reset --hard origin/master</code>. If it doesn't work, you can use <code>git apply -R <file></code> ''to the state before the patch was applied''. For example, <code>git apply -R folder/file.diff</code>.
# Use this command to delete any new files added by the patch: <code>git clean -f -d</code>
#: This removes added files and directories.
# Run the command: git status and make sure it says "nothing to commit (working directory clean)".

=== Eclipse ===
# Use this command to undo any file changes: Team→Reset to show the Reset window. Select "Hard" for the Reset type and click on Reset.
# To remove any new files added by a patch, simple navigate to the files and delete them.

=== TortoiseGit ===
# Use this command to undo any file changes: TortoiseGit→Revert. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-21.png|Tortoisegit-tutorial-screenshot-20120612-21.png]]
#* Any changed files will show in a window as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-22.png|Tortoisegit-tutorial-screenshot-20120612-22.png]]
#* Check all changed files and click OK. The success screen will show as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-22a.png|Tortoisegit-tutorial-screenshot-20120612-22a.png]]
# Use this command to delete any new files: TortoiseGit→Clean up. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-23.png|Tortoisegit-tutorial-screenshot-20120612-23.png]]{{-}} The system will show a success window and the files that were deleted as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-24.png|Tortoisegit-tutorial-screenshot-20120612-24.png]]

== Restore to Unmodified State With Branches ==
If you use branches, it is much easier to switch back to the unmodified programs. You simply change back to the master branch. Once you are done with an issue, you will likely want to delete the branch you created. Here are the commands for that.

=== CLI ===
# Change back to the master branch: <code>git checkout master</code>
# Delete the desired branch: <code>git branch -D issue-123</code> (where issue-123 is the branch name)

=== Eclipse ===
# Change back to the master branch: Team→Switch to→master.
# Delete the desired branch: Team→Advanced→Delete Branch and select the desired branch to delete.

===TortoiseGit ===
# Change back to the master branch: TortoiseGit→Switch/Checkout. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-13.png|Tortoisegit-tutorial-screenshot-20120612-13.png]]
# Select master as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-25.png|Tortoisegit-tutorial-screenshot-20120612-25.png]]
# Delete the desired branch:
#* TortoiseGit→Show Log as shown here. [{{-}}[File:Tortoisegit-tutorial-screenshot-20120612-19.png|Tortoisegit-tutorial-screenshot-20120612-19.png]]
#* Right-click on the HEAD line and select Delete branch/tag→<name of the branch> as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-26.png|Tortoisegit-tutorial-screenshot-20120612-26.png]]

== Testing Older Versions of Trunk ==
At times, it is helpful to figure out which commit might have introduced a new issue. With Git it is easy to restore the code base to any point in time and then test whether an issue was present or not. Note that this is more difficult with the CLI version.

=== CLI ===
# Write some past commits to a temporary file. For example: <code>git log --since="2 weeks ago" --mylogfile.txt</code>
# Find the commit id of the desired date. Note that we only need the first 8 characters of the commit id.
# Checkout the desired commit: <code>git checkout <id></code> (for example: <code>git checkout ba574af0</code>).
# See the command reference for git bisect for a more advanced way to find which commit caused a bug.

=== Eclipse ===

# Open the History View: Team→Show in History. This will show a view similar to this:{{-}}[[Image:Git-document-screenshot-20120530-04.png|900px]]{{-}}This view shows every commit to the CMS repository. To restore your local files to a prior time, right click on the desired row in the history view and select Checkout. Your local files will be changed to the state as of that commit. You can now test that version.
# To change to a different version, repeat this process. To change back to the master branch (the latest version), do Team→Switch to→Master.

=== TortoiseGit ===
# Open the Log window. TortoiseGit→Show Log as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-19.png|Tortoisegit-tutorial-screenshot-20120612-19.png]]
# Right-click on the desired commit in the log listing and select Switch/Checkout to this... as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-27.png|Tortoisegit-tutorial-screenshot-20120612-27.png]]{{-}} You can now test that version.
# To change to a different version, repeat this process. To change back to the master branch (the latest version), do TortoiseGit→Switch/Checkout and select master.

[[Category:Bug Squad]]
[[Category:Development]]
[[Category:GitHub]]
[[Category:Video]]
[[Category:Testing]]

Git for Testers and Trackers

2014-02-12T07:08:15Z

Gunjanpatel: /* Video applying a patch using Github and PHPstorm */

The following tasks are the typical ones needed for the Testing and Tracker teams.

# '''Set up local Git repository (read only from trunk).'''
# '''Keep local repository updated with changes from trunk.'''
# '''Apply patches and pull requests.'''
## Option with branches.
## Option without branches.
# '''Reset files to unmodified state.'''
# '''Work with older versions.'''

{{tip|If you want to try a easy way for testing patches without learning git check this page: [[Component Patchtester for Testers]]}}

== Testing and Tracker Teams Work Flow ==
People who want to test Pending issues need to do the following. These same tasks apply to people who want to monitor the tracker and confirm Open issues.

# Create a local working copy of the Joomla trunk.
# Update this local copy with changes made to trunk.
# Apply proposed patches (from Confirmed issues) to trunk to see if they work correctly.
# Be able to restore the local copy to its unmodified state.

Testers may or may not wish to use Git branches in their testing work. For simple testing of one issue at a time, creating local branches is not necessary. For more complex testing or for testing multiple issues at a time, it is more convenient to create a local branch for each issue. Both approaches are documented here.

In some cases, it is important to identify when a bug or issue was first introduced. With Git it is easy to restore the local repository to a prior state (for example, to a point in time in the past) and test whether the issue was present in that version. This process is also documented here.

== Create Local Read-Only Repository ==
Testers do not need to create a remote repository on Github. They can simply create a local clone of the CMS trunk on their local test machine. This clone will allow them to easily keep up with changes made to the CMS trunk.

The steps for this process are shown below, first using the command-line-interface (CLI) for Git and then using Eclipse and eGit.

=== CLI Commands ===
# Navigate to your project root folder, for example: <code>c:\xampp\htdocs\joomla-cms</code>
# Enter command: <code>git clone <nowiki>git://github.com/joomla/joomla-cms.git</nowiki></code>. The system will work for a few minutes, copying the entire remote repository to your local system. When you are done, you will have a local copy of the Joomla CMS repository in the current directory, along with a git repository (in the .git subdirectory). Note that this URL points to the joomla-cms project on Github. This project becomes the remote origin for the local git repository. For example, the command <code>git remote -v</code> will now list origin as follows:
<div style="margin-left:42px;">
<source>
git remote -v
origin git://github.com/joomla/joomla-cms.git (fetch)
origin git://github.com/joomla/joomla-cms.git (push)
</source></div>

=== Eclipse Commands: ===
# Clone joomla-cms repository using the read-only URL. In Repositories View, click the button "Clone a Git Repository and add to this View". This screen will show the following.<br/>[[Image:Git-document-screenshot-20120529-02.png|Git-document-screenshot-20120529-02.png]]
# Select URI and click Next. The screen below will show.<br/>[[Image:Git-document-screenshot-20120529-03.png|Git-document-screenshot-20120529-03.png]]
#Enter the URI git://github.com/joomla/joomla-cms.git as shown above. Then click Next to see the screen below.<br/>[[Image:Git-document-screenshot-20120529-04.png|Git-document-screenshot-20120529-04.png]]
#This will default to select all branches. Keep this default and click Next to show the screen below.<br/>[[Image:Git-document-screenshot-20120529-05.png|Git-document-screenshot-20120529-05.png]]
#Click on Browse and browse to the desired root directory for the project (for example, c:\xampp\htdocs\joomla_development\joomla-cms). Then click Finish.
# In Eclipse, create new PHP project in same folder. It will give a warning that files exist in this folder (which is OK).
# In Eclipse, right-click on the project and select Team→Share to share the project. In the Share Project window, select Git and click Next. In the Configure Git Repository window, select "Use or create repository in parent folder of project" and click finish.
# Note that this creates a relationship between the local repository and the joomla-cms repository on Github. You can see this relationship by opening the Repositories View and expanding the Remotes tree as shown below.<br/>[[Image:Git-document-screenshot-20120530-01.png|Git-document-screenshot-20120530-01.png]]

=== TortoiseGit Commands: ===
# Clone joomla-cms repository using the read-only URL. Right-click on project folder ("tortoise-git" in this example) and select "Git Clone" as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-01.png|Tortoisegit-tutorial-screenshot-20120612-01.png]]{{-}}
# Enter the read-only URL and the desired project directory (again, "tortoise-git" in this example), as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-02.png|Tortoisegit-tutorial-screenshot-20120612-02.png]]{{-}}
# The system will work for a few minutes, showing progress in the Receiving objects window. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-03.png|Tortoisegit-tutorial-screenshot-20120612-03.png]]{{-}}
# When it is done, a success message will show as shown below. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-04.png|Tortoisegit-tutorial-screenshot-20120612-04.png]]{{-}}

== Update Local Git Repository with Changes Made to Trunk ==
The first time you clone the Joomla CMS repository on Github, you will have the latest version of trunk. However, the trunk changes frequently, as bugs are fixed and new features added. This means that you need to keep your local repository up to date with these changes, for example each day when you start working.

=== CLI: ===
# Make sure you are in the master branch of your local repository with this command: <code>git checkout master</code>
# Pull changes from the origin (joomla-cms): <code>git pull origin</code>
# If there are any changes, these will show. Otherwise, it will say "Already up to date."
# Check your status by entering: git status. The display should show:
$ git status<br/> <nowiki># On branch master</nowiki><br/> nothing to commit (working directory clean)

=== Eclipse ===
# Make sure you are on the master branch: {{rarr|Team,Switch To,master}}. (If you are already on master, the master branch will be grayed out.)
# Pull changes from origin. Right-click on the project in PHP Explorer and select Team→Pull.
# If there were changes made, you will see something like this. {{-}}[[Image:Git-document-screenshot-20120529-01.png|Git-document-screenshot-20120529-01.png]]{{-}} Otherwise, you will see a message indicating that everything was up to date, like this.{{-}} [[Image:Git-document-screenshot-20120529-06.png|Git-document-screenshot-20120529-06.png]]

=== TortoiseGit ===
# Make sure you are on the master branch by entering TortoiseGit→Switch/Checkout and selecting the "master" branch.
# Pull changes from origin. Right-click on the project folder, and select TortoiseGit→Pull as shown below. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-05.png|Tortoisegit-tutorial-screenshot-20120612-05.png]]
# In Remote, select "origin" as shown below and press OK. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-06.png|Tortoisegit-tutorial-screenshot-20120612-06.png]]
# The system will show a success message as follows. {{-}}[[Image:Tortoisegit-tutorial-screenshot-20120612-05.png|Tortoisegit-tutorial-screenshot-20120612-05.png]]

== Important Notes About Patch File Format ==
===Leading "a/" and "b/"===
There is a confusing aspect of working with patches between SVN, Eclipse, Git and the CLI. This has to do with the way files are referenced inside a patch. Most patches made with Eclipse and Git will have a leading "a/" and "b/" in front of the file names. For example, a standard Git patch will look like this:

diff --git a/components/com_content/controller.php b/components/com_content/controller.php
index 53cc63a..25cee76 100644
--- a/components/com_content/controller.php
+++ b/components/com_content/controller.php

However, patches made with SVN or using the "--no-prefix" option in Git will omit the leading "a/" and "b/" and show in the following format:

diff --git components/com_content/controller.php components/com_content/controller.php
index 53cc63a..ba2de80 100644
--- components/com_content/controller.php
+++ components/com_content/controller.php

Most patches will be in the first format. It is easy to apply patches in either format, but the exact commands are different. These are outlined below.

===Error Applying Patch Using CLI===
In some cases, patches made using Eclipse may not apply correctly using the CLI "apply" command. For example, you might get an error: <code>fatal: corrupt patch at line xxx</code>. This appears to be caused by the fact that Eclipse does not add a blank line to the end of the patch file. If you have this problem, try adding a blank line at the end of the patch file.

== Apply Patches and Pull Requests Without Branches ==
This can be done either with or without using branches. If you want to work on one patch at a time (similar to the SVN work flow), you can follow this work flow without branches.

=== CLI ===
# To apply a Git format patch: <code>git apply <file></code>. For example: <code>git apply mypatchfile.patch</code>.
# To apply an SVN format patch: <code>git apply -p0 <file></code>. For example: <code>git apply -p0 mypatchfile.patch.</code>

At this point, the proposed code changes have been made to your Joomla files. Now you can test the proposed changes to see whether they work correctly.

To apply a Github pull request, add ".diff" to the end of the pull request URL. For example:
<pre>https://github.com/joomla/joomla-cms/pull/2531.diff</pre>
This will display a Git-formatted patch file in your browser. Save this file to your local machine and use the command above to apply it.

=== Eclipse ===
# To apply a Git format patch: Team→Apply patch. The Patch input specification window will show. You can apply a patch from a file or by copying the patch to the clipboard.
# Click Next to show the Target Resource window. Select the PHP project to apply to patch and click Next.
# The Review Patch window will show. IMPORTANT: If the patch is in Git format, set "Ignore leading path elements" to 1. If the patch is in SVN format, this is not needed.
# At this point, if the patch will apply correctly, the files will show with a blue arrow as shown below.{{-}}[[File:Git-document-screenshot-20120530-02.png|Git-document-screenshot-20120530-02.png]]

Note: If a red "X" appears next to a file, it means the patch will not apply correctly. Check the patch file format to make sure you have the right setting for this type. Also, make sure you haven't already applied the patch.

=== TortoiseGit ===
# To apply a Git format patch: TortoiseGit→Review/apply single patch. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-08.png|Tortoisegit-tutorial-screenshot-20120612-08.png]]
# The following windows will show the files to be patched. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-09.png|Tortoisegit-tutorial-screenshot-20120612-09.png]]
# Click on the button "Patch all items". The screen will now show the changes to the last file in the patch as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-10.png|Tortoisegit-tutorial-screenshot-20120612-10.png]]

=== Video applying a patch using Github and PHPstorm ===
This 1 minute video shows how a .patch or .diff file is downloaded and added to your current PHPStorm project: {{#ev:youtube|7xdwNFPJdWk}}

== Apply Patches and Pull Requests Using Branches ==
In many cases, it can be easier to create a Git branch for each issue you are working on. This way you can be working on several issues at one time while keeping the code changes for each issue separated. Creating branches in Git is very easy. Here is the work flow for applying patches using branches.

=== CLI ===
# Create a new branch: <code>git branch issue-123</code> (creates a new branch called issue-123).
# Apply the patch as shown earlier.
# Commit the code change to the branch: <code>commit -a</code>. Now git will open the editor you chose when you installed git. Enter the commit message in the first line of the editor and save and exit. (If you are unfamiliar with the editor, you can either change the editor or use Eclipse, which bypasses this step in the process.) The commit message should be something short that tells you what you did, for example "Applied patch 123.patch").
# At this point, the branch contains the modified version of the Joomla files for you to test. You can easily switch back to the standard files with the command: <code>git checkout master</code>. To switch back to the modified version, use the command: <code>git checkout issue-123</code>.

=== Eclipse ===
# Create a new branch: Team→Switch To→New Branch. The Create a new branch window will show. Enter the name of the branch and click on Finish.
# Apply the patch as shown earlier.
# Commit the code change: Team→Commit. The Commit Changes window will show. Enter the commit message as shown in the example below.{{-}}[[Image:Git-document-screenshot-20120530-03.png|Git-document-screenshot-20120530-03.png]]{{-}} At this point, you can review the code changes or simply press the Commit button to commit the changes.
# To switch back to master or any other branch, again use Team→Switch To and select master or the desired branch.

=== TortoiseGit ===
# Create a new branch: Right-click on the project folder and select TortoiseGit→Create Branch, as shown below.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-11.png|Tortoisegit-tutorial-screenshot-20120612-11.png]]
# The following screen will show.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-12.png]]
# Enter the name of the new branch in Branch and press OK. Note that this also switches you to the new branch.
# Apply the patch as shown earlier.
# Commit the code change: Right-click on project folder, then Git Commit -> <your branch> as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-16.png|Tortoisegit-tutorial-screenshot-20120612-16.png]]
# Enter a commit message, check that you are in the right branch, and press OK, as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-17.png|Tortoisegit-tutorial-screenshot-20120612-17.png]]
# The system will show a success message as shown here.
::[[Image:Tortoisegit-tutorial-screenshot-20120612-18.png|Tortoisegit-tutorial-screenshot-20120612-18.png]]

== Restore to Unmodified State (Without Branches) ==
If you are not using branches, when you are done testing an issue, you will need to restore your programs to the original unmodified state. Note that this is not needed if you are using branches.

=== CLI ===
# Use this command to undo ''any'' file changes: <code>git reset --hard origin/master</code>. If it doesn't work, you can use <code>git apply -R <file></code> ''to the state before the patch was applied''. For example, <code>git apply -R folder/file.diff</code>.
# Use this command to delete any new files added by the patch: <code>git clean -f -d</code>
#: This removes added files and directories.
# Run the command: git status and make sure it says "nothing to commit (working directory clean)".

=== Eclipse ===
# Use this command to undo any file changes: Team→Reset to show the Reset window. Select "Hard" for the Reset type and click on Reset.
# To remove any new files added by a patch, simple navigate to the files and delete them.

=== TortoiseGit ===
# Use this command to undo any file changes: TortoiseGit→Revert. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-21.png|Tortoisegit-tutorial-screenshot-20120612-21.png]]
#* Any changed files will show in a window as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-22.png|Tortoisegit-tutorial-screenshot-20120612-22.png]]
#* Check all changed files and click OK. The success screen will show as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-22a.png|Tortoisegit-tutorial-screenshot-20120612-22a.png]]
# Use this command to delete any new files: TortoiseGit→Clean up. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-23.png|Tortoisegit-tutorial-screenshot-20120612-23.png]]{{-}} The system will show a success window and the files that were deleted as follows. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-24.png|Tortoisegit-tutorial-screenshot-20120612-24.png]]

== Restore to Unmodified State With Branches ==
If you use branches, it is much easier to switch back to the unmodified programs. You simply change back to the master branch. Once you are done with an issue, you will likely want to delete the branch you created. Here are the commands for that.

=== CLI ===
# Change back to the master branch: <code>git checkout master</code>
# Delete the desired branch: <code>git branch -D issue-123</code> (where issue-123 is the branch name)

=== Eclipse ===
# Change back to the master branch: Team→Switch to→master.
# Delete the desired branch: Team→Advanced→Delete Branch and select the desired branch to delete.

===TortoiseGit ===
# Change back to the master branch: TortoiseGit→Switch/Checkout. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-13.png|Tortoisegit-tutorial-screenshot-20120612-13.png]]
# Select master as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-25.png|Tortoisegit-tutorial-screenshot-20120612-25.png]]
# Delete the desired branch:
#* TortoiseGit→Show Log as shown here. [{{-}}[File:Tortoisegit-tutorial-screenshot-20120612-19.png|Tortoisegit-tutorial-screenshot-20120612-19.png]]
#* Right-click on the HEAD line and select Delete branch/tag→<name of the branch> as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-26.png|Tortoisegit-tutorial-screenshot-20120612-26.png]]

== Testing Older Versions of Trunk ==
At times, it is helpful to figure out which commit might have introduced a new issue. With Git it is easy to restore the code base to any point in time and then test whether an issue was present or not. Note that this is more difficult with the CLI version.

=== CLI ===
# Write some past commits to a temporary file. For example: <code>git log --since="2 weeks ago" --mylogfile.txt</code>
# Find the commit id of the desired date. Note that we only need the first 8 characters of the commit id.
# Checkout the desired commit: <code>git checkout <id></code> (for example: <code>git checkout ba574af0</code>).
# See the command reference for git bisect for a more advanced way to find which commit caused a bug.

=== Eclipse ===

# Open the History View: Team→Show in History. This will show a view similar to this:{{-}}[[Image:Git-document-screenshot-20120530-04.png|900px]]{{-}}This view shows every commit to the CMS repository. To restore your local files to a prior time, right click on the desired row in the history view and select Checkout. Your local files will be changed to the state as of that commit. You can now test that version.
# To change to a different version, repeat this process. To change back to the master branch (the latest version), do Team→Switch to→Master.

=== TortoiseGit ===
# Open the Log window. TortoiseGit→Show Log as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-19.png|Tortoisegit-tutorial-screenshot-20120612-19.png]]
# Right-click on the desired commit in the log listing and select Switch/Checkout to this... as shown here. {{-}}[[File:Tortoisegit-tutorial-screenshot-20120612-27.png|Tortoisegit-tutorial-screenshot-20120612-27.png]]{{-}} You can now test that version.
# To change to a different version, repeat this process. To change back to the master branch (the latest version), do TortoiseGit→Switch/Checkout and select master.

[[Category:Bug Squad]]
[[Category:Development]]
[[Category:GitHub]]
[[Category:Video]]
[[Category:Testing]]

Joomla info page/hi-IN

2013-11-30T07:09:53Z

Gunjanpatel: /* जुमला के लिए मदद कहाँ से मीलेगी? */

= Hindi / हिन्दी =
== जुमला क्या है? ==
जुमला एक पुरस्कारसे सम्मानीत कन्टेन्ट मेनेजमेन्ट सिस्टम (CMS) है, जो आपको आपकी वेब साइट और शक्तिशाली ऑनलाइन अप्लीकेसन का निर्माण करने के लिए सक्षम बनाता है। अपने आसानी के उपयोग सहित कई पहलुओं ने जुमला को सबसे लोकप्रिय वेब साइट सॉफ्टवेयर उपलब्ध कराया है और इससे भी अधिक अच्छी बात ये है की जुमला एक ओपन-सोर्स सॉफ्टवेयर है।

जूमला उपयोग करने के लाभ:

* आसान इन्स्टोलेशन
* सरल वेबसाइट संभरण
* बढिया सुरक्षा और स्थिरता
* शक्तिशाली निःशुल्क और वाणिज्यिक प्रसारक
* अद्भुत टेम्‍पलेट जिनसे आप अपनी वेबसाइट सरलता से बदल सके

== जुमला कैसे डाउनलोड करे? ==
* जूमला यहा से प्रयाप्त करे: http://www.joomla.org/download.html
* जूमला को हिन्दी मे यहा से प्रयाप्त करे (hi-IN): http://extensions.joomla.org/extensions/languages/translations-for-joomla/5811

== एक्सटेंशन कैसे डाउनलोड करे? ==
* एक्सटेन्षन यहा से पाये: http://extensions.joomla.org/
* जूमला एक्सटेंशन भिन्न भाषा ओ में यहाँ से पाये : {http://extensions.joomla.org/extensions/languages/translations-for-joomla}

== जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? ==
* अंग्रेजी प्रलेखन: http://docs.joomla.org/
* भाषाकीय प्रलेखन: {http://www.example.com/}

== जुमला के लिए मदद कहाँ से मीलेगी? ==
* मुफ्त अंग्रेजी मदद: http://forum.joomla.org/
* मुफ्त भाषाकिय मदद:
** http://forum.joomla.org/viewforum.php?f=162
** {http://www.example.com/}
** {http://www.example.com/}
** {http://www.example.com/}
* वाणिज्यिक सहायता: http://resources.joomla.org/ (website in English)

== जुमला क्षेत्रीय कार्यक्रम / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== जुमला उपयोग करने वाला समुह (JUG) ==
Local Joomla User Groups (JUG) are a great way to meet new people, get help with a project, or share your own knowledge with other Joomla users. Joomla is everywhere so check to see if there's already a JUG in your area. If not, you might want to consider forming one.
* JUGs in India: http://community.joomla.org/user-groups/asia-pacific/india.html
* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== जुमला मे कैसे अपना योगदान दे? ==
* Answer Questions in any Joomla! Forum (link to: Where to get support for Joomla?)
* Write or Translate a Tutorial or Documentation (link to: Where to get documentation for Joomla?)
* Develop an Extension or Template
* Test or Add a Comment to an Issue Report
* Join a Joomla! Working Group
* Help Out at a Joomla! Event
* Contribute in Other Ways, see http://contribute.joomla.org/

Joomla info page/hi-IN

2013-11-30T07:05:27Z

Gunjanpatel: /* जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? */

= Hindi / हिन्दी =
== जुमला क्या है? ==
जुमला एक पुरस्कारसे सम्मानीत कन्टेन्ट मेनेजमेन्ट सिस्टम (CMS) है, जो आपको आपकी वेब साइट और शक्तिशाली ऑनलाइन अप्लीकेसन का निर्माण करने के लिए सक्षम बनाता है। अपने आसानी के उपयोग सहित कई पहलुओं ने जुमला को सबसे लोकप्रिय वेब साइट सॉफ्टवेयर उपलब्ध कराया है और इससे भी अधिक अच्छी बात ये है की जुमला एक ओपन-सोर्स सॉफ्टवेयर है।

जूमला उपयोग करने के लाभ:

* आसान इन्स्टोलेशन
* सरल वेबसाइट संभरण
* बढिया सुरक्षा और स्थिरता
* शक्तिशाली निःशुल्क और वाणिज्यिक प्रसारक
* अद्भुत टेम्‍पलेट जिनसे आप अपनी वेबसाइट सरलता से बदल सके

== जुमला कैसे डाउनलोड करे? ==
* जूमला यहा से प्रयाप्त करे: http://www.joomla.org/download.html
* जूमला को हिन्दी मे यहा से प्रयाप्त करे (hi-IN): http://extensions.joomla.org/extensions/languages/translations-for-joomla/5811

== एक्सटेंशन कैसे डाउनलोड करे? ==
* एक्सटेन्षन यहा से पाये: http://extensions.joomla.org/
* जूमला एक्सटेंशन भिन्न भाषा ओ में यहाँ से पाये : {http://extensions.joomla.org/extensions/languages/translations-for-joomla}

== जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? ==
* अंग्रेजी प्रलेखन: http://docs.joomla.org/
* भाषाकीय प्रलेखन: {http://www.example.com/}

== जुमला के लिए मदद कहाँ से मीलेगी? ==
* Free English support: http://forum.joomla.org/
* Free {language} support:
** http://forum.joomla.org/viewforum.php?f=162
** {http://www.example.com/}
** {http://www.example.com/}
** {http://www.example.com/}
* Commercial support: http://resources.joomla.org/ (website in English)

== जुमला क्षेत्रीय कार्यक्रम / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== जुमला उपयोग करने वाला समुह (JUG) ==
Local Joomla User Groups (JUG) are a great way to meet new people, get help with a project, or share your own knowledge with other Joomla users. Joomla is everywhere so check to see if there's already a JUG in your area. If not, you might want to consider forming one.
* JUGs in India: http://community.joomla.org/user-groups/asia-pacific/india.html
* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== जुमला मे कैसे अपना योगदान दे? ==
* Answer Questions in any Joomla! Forum (link to: Where to get support for Joomla?)
* Write or Translate a Tutorial or Documentation (link to: Where to get documentation for Joomla?)
* Develop an Extension or Template
* Test or Add a Comment to an Issue Report
* Join a Joomla! Working Group
* Help Out at a Joomla! Event
* Contribute in Other Ways, see http://contribute.joomla.org/

Joomla info page/hi-IN

2013-11-30T07:00:53Z

Gunjanpatel: /* एक्सटेंशन कैसे डाउनलोड करे? */

= Hindi / हिन्दी =
== जुमला क्या है? ==
जुमला एक पुरस्कारसे सम्मानीत कन्टेन्ट मेनेजमेन्ट सिस्टम (CMS) है, जो आपको आपकी वेब साइट और शक्तिशाली ऑनलाइन अप्लीकेसन का निर्माण करने के लिए सक्षम बनाता है। अपने आसानी के उपयोग सहित कई पहलुओं ने जुमला को सबसे लोकप्रिय वेब साइट सॉफ्टवेयर उपलब्ध कराया है और इससे भी अधिक अच्छी बात ये है की जुमला एक ओपन-सोर्स सॉफ्टवेयर है।

जूमला उपयोग करने के लाभ:

* आसान इन्स्टोलेशन
* सरल वेबसाइट संभरण
* बढिया सुरक्षा और स्थिरता
* शक्तिशाली निःशुल्क और वाणिज्यिक प्रसारक
* अद्भुत टेम्‍पलेट जिनसे आप अपनी वेबसाइट सरलता से बदल सके

== जुमला कैसे डाउनलोड करे? ==
* जूमला यहा से प्रयाप्त करे: http://www.joomla.org/download.html
* जूमला को हिन्दी मे यहा से प्रयाप्त करे (hi-IN): http://extensions.joomla.org/extensions/languages/translations-for-joomla/5811

== एक्सटेंशन कैसे डाउनलोड करे? ==
* एक्सटेन्षन यहा से पाये: http://extensions.joomla.org/
* जूमला एक्सटेंशन भिन्न भाषा ओ में यहाँ से पाये : {http://extensions.joomla.org/extensions/languages/translations-for-joomla}

== जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? ==
* English documentation: http://docs.joomla.org/
* {language} documentation: {http://www.example.com/}

== जुमला के लिए मदद कहाँ से मीलेगी? ==
* Free English support: http://forum.joomla.org/
* Free {language} support:
** http://forum.joomla.org/viewforum.php?f=162
** {http://www.example.com/}
** {http://www.example.com/}
** {http://www.example.com/}
* Commercial support: http://resources.joomla.org/ (website in English)

== जुमला क्षेत्रीय कार्यक्रम / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== जुमला उपयोग करने वाला समुह (JUG) ==
Local Joomla User Groups (JUG) are a great way to meet new people, get help with a project, or share your own knowledge with other Joomla users. Joomla is everywhere so check to see if there's already a JUG in your area. If not, you might want to consider forming one.
* JUGs in India: http://community.joomla.org/user-groups/asia-pacific/india.html
* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== जुमला मे कैसे अपना योगदान दे? ==
* Answer Questions in any Joomla! Forum (link to: Where to get support for Joomla?)
* Write or Translate a Tutorial or Documentation (link to: Where to get documentation for Joomla?)
* Develop an Extension or Template
* Test or Add a Comment to an Issue Report
* Join a Joomla! Working Group
* Help Out at a Joomla! Event
* Contribute in Other Ways, see http://contribute.joomla.org/

Joomla info page/hi-IN

2013-11-30T06:53:45Z

Gunjanpatel: /* जुमला कैसे डाउनलोड करे? */

= Hindi / हिन्दी =
== जुमला क्या है? ==
जुमला एक पुरस्कारसे सम्मानीत कन्टेन्ट मेनेजमेन्ट सिस्टम (CMS) है, जो आपको आपकी वेब साइट और शक्तिशाली ऑनलाइन अप्लीकेसन का निर्माण करने के लिए सक्षम बनाता है। अपने आसानी के उपयोग सहित कई पहलुओं ने जुमला को सबसे लोकप्रिय वेब साइट सॉफ्टवेयर उपलब्ध कराया है और इससे भी अधिक अच्छी बात ये है की जुमला एक ओपन-सोर्स सॉफ्टवेयर है।

जूमला उपयोग करने के लाभ:

* आसान इन्स्टोलेशन
* सरल वेबसाइट संभरण
* बढिया सुरक्षा और स्थिरता
* शक्तिशाली निःशुल्क और वाणिज्यिक प्रसारक
* अद्भुत टेम्‍पलेट जिनसे आप अपनी वेबसाइट सरलता से बदल सके

== जुमला कैसे डाउनलोड करे? ==
* जूमला यहा से प्रयाप्त करे: http://www.joomla.org/download.html
* जूमला को हिन्दी मे यहा से प्रयाप्त करे (hi-IN): http://extensions.joomla.org/extensions/languages/translations-for-joomla/5811

== एक्सटेंशन कैसे डाउनलोड करे? ==
* Download extensions: http://extensions.joomla.org/
* Download {language} language packs for extensions: {http://www.example.com/}

== जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? ==
* English documentation: http://docs.joomla.org/
* {language} documentation: {http://www.example.com/}

== जुमला के लिए मदद कहाँ से मीलेगी? ==
* Free English support: http://forum.joomla.org/
* Free {language} support:
** http://forum.joomla.org/viewforum.php?f=162
** {http://www.example.com/}
** {http://www.example.com/}
** {http://www.example.com/}
* Commercial support: http://resources.joomla.org/ (website in English)

== जुमला क्षेत्रीय कार्यक्रम / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== जुमला उपयोग करने वाला समुह (JUG) ==
Local Joomla User Groups (JUG) are a great way to meet new people, get help with a project, or share your own knowledge with other Joomla users. Joomla is everywhere so check to see if there's already a JUG in your area. If not, you might want to consider forming one.
* JUGs in India: http://community.joomla.org/user-groups/asia-pacific/india.html
* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== जुमला मे कैसे अपना योगदान दे? ==
* Answer Questions in any Joomla! Forum (link to: Where to get support for Joomla?)
* Write or Translate a Tutorial or Documentation (link to: Where to get documentation for Joomla?)
* Develop an Extension or Template
* Test or Add a Comment to an Issue Report
* Join a Joomla! Working Group
* Help Out at a Joomla! Event
* Contribute in Other Ways, see http://contribute.joomla.org/

Joomla info page/hi-IN

2013-11-30T06:50:23Z

Gunjanpatel: /* जुमला क्या है? */

= Hindi / हिन्दी =
== जुमला क्या है? ==
जुमला एक पुरस्कारसे सम्मानीत कन्टेन्ट मेनेजमेन्ट सिस्टम (CMS) है, जो आपको आपकी वेब साइट और शक्तिशाली ऑनलाइन अप्लीकेसन का निर्माण करने के लिए सक्षम बनाता है। अपने आसानी के उपयोग सहित कई पहलुओं ने जुमला को सबसे लोकप्रिय वेब साइट सॉफ्टवेयर उपलब्ध कराया है और इससे भी अधिक अच्छी बात ये है की जुमला एक ओपन-सोर्स सॉफ्टवेयर है।

जूमला उपयोग करने के लाभ:

* आसान इन्स्टोलेशन
* सरल वेबसाइट संभरण
* बढिया सुरक्षा और स्थिरता
* शक्तिशाली निःशुल्क और वाणिज्यिक प्रसारक
* अद्भुत टेम्‍पलेट जिनसे आप अपनी वेबसाइट सरलता से बदल सके

== जुमला कैसे डाउनलोड करे? ==
* Download Joomla: http://www.joomla.org/download.html
* Download Joomla language pack for Hindi (hi-IN): http://extensions.joomla.org/extensions/languages/translations-for-joomla/5811

== एक्सटेंशन कैसे डाउनलोड करे? ==
* Download extensions: http://extensions.joomla.org/
* Download {language} language packs for extensions: {http://www.example.com/}

== जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? ==
* English documentation: http://docs.joomla.org/
* {language} documentation: {http://www.example.com/}

== जुमला के लिए मदद कहाँ से मीलेगी? ==
* Free English support: http://forum.joomla.org/
* Free {language} support:
** http://forum.joomla.org/viewforum.php?f=162
** {http://www.example.com/}
** {http://www.example.com/}
** {http://www.example.com/}
* Commercial support: http://resources.joomla.org/ (website in English)

== जुमला क्षेत्रीय कार्यक्रम / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== जुमला उपयोग करने वाला समुह (JUG) ==
Local Joomla User Groups (JUG) are a great way to meet new people, get help with a project, or share your own knowledge with other Joomla users. Joomla is everywhere so check to see if there's already a JUG in your area. If not, you might want to consider forming one.
* JUGs in India: http://community.joomla.org/user-groups/asia-pacific/india.html
* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== जुमला मे कैसे अपना योगदान दे? ==
* Answer Questions in any Joomla! Forum (link to: Where to get support for Joomla?)
* Write or Translate a Tutorial or Documentation (link to: Where to get documentation for Joomla?)
* Develop an Extension or Template
* Test or Add a Comment to an Issue Report
* Join a Joomla! Working Group
* Help Out at a Joomla! Event
* Contribute in Other Ways, see http://contribute.joomla.org/

Joomla info page/hi-IN

2013-11-30T06:48:36Z

Gunjanpatel: /* जुमला क्या है? */

= Hindi / हिन्दी =
== जुमला क्या है? ==
जुमला एक पुरस्कारसे सम्मानीत कन्टेन्ट मेनेजमेन्ट सिस्टम (CMS) है, जो आपको आपकी वेब साइट और शक्तिशाली ऑनलाइन अप्लीकेसन का निर्माण करने के लिए सक्षम बनाता है। अपने आसानी के उपयोग सहित कई पहलुओं ने जुमला को सबसे लोकप्रिय वेब साइट सॉफ्टवेयर उपलब्ध कराया है और इससे भी अधिक अच्छी बात ये है की जुमला एक ओपन-सोर्स सॉफ्टवेयर है।

जुमल उपयोग करने के लाभ:

* आसान इन्स्टोलेशन
* सरल वेबसाइट संभरण
* बढिया सुरक्षा और स्थिरता
* शक्तिशाली निःशुल्क और वाणिज्यिक प्रसारक
* अद्भुत टेम्‍पलेट जिनसे आप अपनी वेबसाइट सरलता से बदल सके

== जुमला कैसे डाउनलोड करे? ==
* Download Joomla: http://www.joomla.org/download.html
* Download Joomla language pack for Hindi (hi-IN): http://extensions.joomla.org/extensions/languages/translations-for-joomla/5811

== एक्सटेंशन कैसे डाउनलोड करे? ==
* Download extensions: http://extensions.joomla.org/
* Download {language} language packs for extensions: {http://www.example.com/}

== जुमला के लिए दस्तावेज़ीकरण कहाँ से पाए जाए? ==
* English documentation: http://docs.joomla.org/
* {language} documentation: {http://www.example.com/}

== जुमला के लिए मदद कहाँ से मीलेगी? ==
* Free English support: http://forum.joomla.org/
* Free {language} support:
** http://forum.joomla.org/viewforum.php?f=162
** {http://www.example.com/}
** {http://www.example.com/}
** {http://www.example.com/}
* Commercial support: http://resources.joomla.org/ (website in English)

== जुमला क्षेत्रीय कार्यक्रम / Joomladays ==
Local communities worldwide organise Joomla Days. A Joomla Day is an event created exclusively for Joomla users and projects and usually draws a regional audience. More information: http://community.joomla.org/events/joomla-days.html

== जुमला उपयोग करने वाला समुह (JUG) ==
Local Joomla User Groups (JUG) are a great way to meet new people, get help with a project, or share your own knowledge with other Joomla users. Joomla is everywhere so check to see if there's already a JUG in your area. If not, you might want to consider forming one.
* JUGs in India: http://community.joomla.org/user-groups/asia-pacific/india.html
* JUG FAQ: http://community.joomla.org/user-groups/jug-faq.html

== जुमला मे कैसे अपना योगदान दे? ==
* Answer Questions in any Joomla! Forum (link to: Where to get support for Joomla?)
* Write or Translate a Tutorial or Documentation (link to: Where to get documentation for Joomla?)
* Develop an Extension or Template
* Test or Add a Comment to an Issue Report
* Join a Joomla! Working Group
* Help Out at a Joomla! Event
* Contribute in Other Ways, see http://contribute.joomla.org/