Joomla! Documentation - User contributions [en]

J3.x:Updating from an existing version

2013-11-08T10:55:00Z

Pwiseman: Fixed Typo

{{warning|This page is only for upgrading from Joomla! versions '''"1.7''' or '''2.5"''' to '''3.x''' OR a '''3.x.x''' version to '''{{CurrentSTSVer}}'''.<br/><center><big>'''Always back up your site before updating.'''</big></center>}}

The recommended way to update installations of Joomla! is to use the Joomla Updater component found in the Components menu of your site Administrator(Method A) introduced in J2.5.4.

Updating earlier versions? Use one of the following methods.
*Use Install Method ([[#Method B - Install Method|Method B]])
*Manual Upgrade ([[#Method C - Manual Upgrade|Method C]])

{{notice|You should always review '''[[:Category:Upgrading Issues|Upgrading Issues]]''' and '''[[J3.1:Known upgrading issues and solutions|Known upgrading issues and solutions]]''' before upgrading.|title=Before You Begin}}

==Browse to Components, Joomla Update==
[[File:Componentsmenu.PNG]]

If an update is available there will be a message indicating this and a button to press. Otherwise for J2.5 go to Extension manager => Update and press Purge cache.

[[File:Updatewaitingj3.PNG|475px]]
{{-}}
==Click on the "Install the Update" button and allow the update to run==

[[File:Updatesuccess3.PNG]]

== When it has completed you may need to refresh your screen or empty your browser cache to adjust for template CSS changes.==

Note: Joomla! will notify you on your administrator home page (control panel) when an update is needed, but it will not do the update for you. You need to press the button to start the update.

{{ambox|text=[[J3.1:Detailed_instructions_for_updating_from_3.1.2_to_3.1.4| Special Instructions for Version 3.1.2 Upgrades]]}}

'''Recommended Steps and actions:'''
It is recommended that you follow these steps when updating a production site:
# Back up your site before upgrading to a new version. That way, if something goes wrong during the upgrade process, you can easily restore your site to the earlier version.
# Review the release notes for the new version to be familiar with what was changed.
# Update using one of the recommended methods outlined in this document. These methods install the new program files, delete unneeded old program files, and update the database as needed for the new Joomla version.
# Clear your browser cache and check that the update was successful, using the steps outlined in the '''Checking Site''' tab.

=Method A - Update Method=
This is the easier way, also called ''One click update''

==Step 1: Make sure you have a current backup of your site==
In many cases, your host will make periodic site backups.

==Step 2a: Find and install updates==
# '''If your site is prior to 2.5.4, see Step 2b instead'''
# In the back end of your Joomla site, navigate to Components → Joomla Update.
# Click on Install the Update [[Image:Update-screenshot-20120618-01.png|frame|center]]
# '''IMPORTANT:''' This process will take a few minutes. Wait until the process completes and it tells you that you are already on the current release, similar to the screen shown below. [[Image:Update-screenshot-20120618-02.png|frame|center]]
# Congratulations! At this point, your site is updated.
'''Important:''' Clear your browser cache and check that your site is working correctly. See below Checking Your Site

==Step 2b: Find and install updates (Prior to updating 2.5.4)==
# In the back end of your Joomla site, navigate to Extensions → Extension Manager and open the Update tab.
# Click on the Purge Cache icon to clear out the cache.
# Click on the Find Updates icon in the toolbar. If there is an available update, the screen will list it, similar to the screen shown below. [[Image:Update-screenshot-20120124-01.png|frame|center]] Note that available upgrades for extensions used in the site will also show in the list.
# Select the update (using the checkbox) and click on the Update icon in the toolbar.
# '''IMPORTANT:''' This process will take a few minutes. Wait until the process completes and the success message shows, similar to the screen shown below. [[Image:Update-screenshot-20120124-02.png|frame|center]]
# Congratulations! At this point, your site is updated.
'''Important:''' Clear your browser cache and check that your site is working correctly. See below Checking Your Site

=Method B - Install Method=
In some cases it may not be possible to use the Extension Manager: Update method to update your site. One reason for this might be that you are using a non-standard distribution (for example, a distribution with a different default language installed). Another reason might be that your don't have a reliable enough internet connection to support automatic installation.

In this case, you can still do an easy installation using the Extension Manager: Install screen. Like the Update screen, this method will do the database updates automatically and will completely update your system without any further steps.

==Step 1: Make sure you have a current backup of your site==
In many cases, your host will make periodic site backups.

==Step 2: Locate the update file==
Locate the required archive file (for example, .zip, .tag.gz, or tar.bz2 archive) for your version. If you are updating to an x.x.0 release (for example, from 1.7.3 to 2.5.0), this will normally be a file like Joomla_2.5.0-Stable-Update_Package.zip. If you are updating within the same release series (for example, 2.5.0 to 2.5.1), then the file will be named something like Joomla_2.5.0_to_2.5.1-Stable-Patch_Package.zip.

At this point, you have three options:
# Install from URL
# Install from Directory
# Upload Package File

Install from URL is the easiest to do. With this option, the upgrade archive is loaded directly by the server, so it works well even if your local computer has a slow or unreliable internet connection.

Install from Directory is the safest method if the server itself has a slow internet connection. With this method, you use FTP to load the unpacked update files into a temporary folder on the server. Then you point to that directory on the server for the installation.

Upload Package File is fairly simple, but it requires that you have a good connection between your local computer and the server.

The screen below shows the Extension Manager: Install screen with the three options labeled.
[[Image:Update-screenshot-20120124-03.png|frame|center]]

===Install from URL===
This option is the easiest, if the archive file is available on a website.
# In the Extension Manager: Install screen, enter the URL for the archive file in the Install URL field.
# Press the Install button.
The system will work for a period of time, up to two minutes or more for a full version update. Then a message indicating a successful installation will display.

===Install from Directory===
This option requires that you unpack the archive file in a directory on your server. This is the best method if you have a slow internet connection or you are experiencing timeouts during the update process.
# Unpack the archive file in a temporary directory on your local machine.
# Upload all the files in this directory (for example, using FTP) to a temporary directory that is visible to the web server. For example, you can create a sub-directory under the tmp directory in your Joomla root. For this example, let's say the directory on the server is <code>/home/myuser/myjoomla/tmp/upgrade250</code>).
# In the Extension Manager: Install screen, enter the full path of the temporary directory (on the server) from step 2 (for example, <code>/home/myuser/myjoomla/tmp/upgrade250</code>).
# Press the Install button.
The system will work for a short time (perhaps a minute or less, depending on your server). Then a message indicating a successful installation will display.

===Upload Package File===
This option requires that you first download the archive file to your local machine.
# Download the file to your local computer.
# In the Extension Manager: Install screen, click the Browse button next to the Package File field and browse to the archive file.
# Press the Install button.
The system will work for a period of time, up to two minutes or more for a full version update. Then a message indicating a successful installation will display.

# Congratulations! At this point, your site is updated.
'''Important:''' Clear your browser cache and check that your site is working correctly. See below Checking Your Site

=Method C - Manual Upgrade=
This method is similar to the old method for updating Joomla versions. Here we want to replace the existing program files with the files from the update archive. The advantage of this method is that it will work on slower shared hosts. The disadvantage is that it requires more work by the system administrator.

''Important: This method can also be used to repair a site where the automatic update failed due to a server timeout.''

==Copy the New Program Files to Your Site==
There are two ways you can do this.
# Copy the archive file to the root directory of your site and unpack the archive. The update archive will be named something like <code>Joomla_2.5.0-Stable-Update_Package.zip</code>. Note that you need to tell the system to replace any existing files. For example, in GoDaddy.com, use the FTP File Manager to upload the update file and then use "Unarchive" to unpack it. Check the box "Overwrite existing files".
# If you don't have the ability to unpack the archive on the server, create a temporary directory on your local machine and unpack the archive file there. Then FTP these files to the root directory of your site, overwriting the existing files.

==Update the Database==
At this point, you should be able to log into the back end of your site with the new version installed. However, you are not done. Navigate to Extension Manager: Database. You will initially have Database problems when you check the Database, similar to the screen below.
[[Image:Update-screenshot-20120124-08.png|frame|center|Database Screen Before Fix]]
This is expected. Click on the Fix icon to correct the problems. Now the screen should show that the database is up to date.

==Install New Extensions==
Navigate to Extension Manager: Discover and click on the Discover icon in the toolbar. If the updated version has new core extensions, new extensions will be listed, as shown below.
[[Image:Update-screenshot-20120124-09.png|frame|center|Discover Screen Before Install]]
Select all the extensions and click on the Install icon in the toolbar. The system should display a success message similar to the screen below.
[[Image:Update-screenshot-20120124-10.png|frame|center|Discover Screen After Install]]

==Update the #__extensions Table==
At this point, your site is updated. However, there is one more thing to do. The site will think it needs to be updated because a value in the #__extensions table is wrong. To fix this:
* Using phpMyAdmin or a similar tool, edit the row of the #__extensions table where the id column is '700'. (Note that the table prefix will be different in your site. For example, if your table prefix is "jos_", then the table will be called "jos_extensions".
* In the manifest_cache column, you will see the old version in the text (for example, <code>"version":"1.7.3"</code>). Change this to the new version (for example, <code>"version":"3.1.4"</code>). Be careful to not change anything else in this column.
* To check that this was successful, navigate to Extension Manager: Update and click Check for Updates. You should '''not''' see the current Joomla version in the list.

At this point, your site should be updated correctly.

=Checking Site=
'''This is required for method A and B!'''
After an update, it is a good idea to clear your browser cache snd check your site to make sure the update was successful. There are two quick checks you can do from the Extension Manager.
==Extension Manager: Check Database==
{{JVer|2.5}} This feature was added in version 2.5.0. It checks that your database is up to date with your Joomla programs.

Navigate to Extension Manager: Database. If your database is up to date, you should see a screen similar to the one below:
[[Image:Update-screenshot-20120124-04.png|frame|center|Database Screen With No Problems]]

If your database is not up to date, you will see a screen listing the problems found, similar to the one below:
[[Image:Update-screenshot-20120124-05.png|frame|center|Database Screen With 3 Database Problems]]
In this case, press the Fix button in the upper right corner. Joomla will update your database to correct the issues listed and then it will re-display the screen. If the fix was successful, the display will indicate that the database is up to date.

'''N.B.''' If any errors fail to fix then make sure all the database Tables are checked in.

==Extension Manager: Discover==
In some cases, when you update to a new Joomla version, new core extensions are added. If there were problems with the database update, these extensions may not have been correctly installed. To check this, navigate to Extension Manager: Discover. Then click on the Discover icon in the toolbar. The screen should show as follows:
[[Image:Update-screenshot-20120124-06.png|frame|center|Discover Screen With No Extensions To Install]]
If so, you know that any new extensions added during the udpate were correctly installed in the database.

If there are uninstalled extensions, they will show similar to the following screen:
[[Image:Update-screenshot-20120124-07.png|frame|center|Discover Screen With Two Extensions To Install]]
In this case, check the check boxes and click on the Install icon in the toolbar. Joomla will install the extension(s) and then display the screen showing no extensions discovered. At this point, the new extensions have been installed in the database.

=Troubleshooting=
If you have any questions before, during, or after the upgrade then please ask them on the '''[[jforum:710|Migrating and Upgrading to Joomla! 3.x Forum]]'''.

If you have problems or errors during the update process, here are some tips.
* Check the following locations for more information:
:*'''[[J3.1:Known upgrading issues and solutions|Known upgrading issues and solutions]]'''
:*'''[[:Category:Upgrading Issues|Upgrading Issues]]'''
* Sometimes a simple clearing your browser cache as there may have been changes to the css or javascript that will need to be reloaded by your web browser after an upgrade.
* If any database error messages show after the update, be sure to check the Extension Manager: Database tab followed by the Extension Manager: Discover tab. In some cases, if a database error occurs it will prevent all the database updates from running. In this case, you can run them from the Database tab and then use the Discover→Install method to check and install any new extensions.
* If you encounter any errors or problems during or after the update, be sure to check the FAQ for the version you updated to. For example, for version 3.1.0, this will be an category entitled [[:Category:Version_3.1.0_FAQ|Category:Version 3.1.0 FAQ]].

[[Category:Upgrading]]
[[Category:Joomla! 3.0]][[Category:Joomla! 3.1]]

Git for Coders

2013-01-24T00:00:39Z

Pwiseman: /* Create a Patch File */

=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 with 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 fist 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 and 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=
== 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>

===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 create 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 ===
Some files we don't want Git to track. One way to have Git ignore files is to use the "exclude" file. An advantage of this approach is that this file sits outside of your Git project and doesn't get committed to the repository. This is handy when you want your master branch to be identical to the CMS master branch, even if you want to add some file types to ignore.

To use this feature, follow these steps:
# Create a folder called <code>info</code> under your <code>.git</code> folder. (The .git folder will be at the root of your Joomla project.)
# Create a text file in this folder called <code>exclude</code> and enter in the desired file types to exclude.

Here is an example of a file.
*~
.buildpath
.project
.settings/
tests/system/servers/configdef.php
tests/system/screenshots
configuration.php
logs/error.php
cache/*
administrator/cache/*
*.patch
*.diff
As you can see from the example, we can exclude specific file names or use wild cards.

Once you have this file created, Git will ignore any of these files.
[[Category:Bug Squad]]
[[Category:Development]]

Joomla LESS

2012-12-20T00:16:55Z

Pwiseman:

Most of the Joomla 3.0 default template stylesheets are written using [[wikipedia:LESS_(stylesheet_language)|LESS]] and then compiled to generate the [[wikipedia:CSS|CSS]] files.

== Where can you find the .less stylesheets and compiler? ==

The <code>.less</code> building blocks are located in <code>media/jui/less/</code>. The template specific <code>.less</code>files are located in <code>templates/<templates>/less/</code>.

The CSS generation wrapper script, LESS compiler, and other similar build tools are located in the <code>build/</code> directory of the Joomla source located on GitHub. Refer to [[Git_for_Coders]] for more information on using GitHub. The build directory is only available from the Joomla source, it is not included in an official Joomla release.

== How to re-generate the CSS stylesheets ==

To re-generate all the CSS files from a Joomla core distribution, you will need to execute the generation scripts as a [[wikipedia:Command-line_interface|CLI application]].

For example:
<pre>cd joomla-cms/build
c:\xampp\php\php.exe generatecss.php
</pre>

== Compiling your own LESS files for your template ==

To compile less files for your own template, you will need to take a copy of the <code>generatecss.php</code> script and adjust it to suite your template.

== Not all LESS compilers are equal ==
The LESS compiler used for the Joomla core for code style consistency is obtained from [http://leafo.net/lessphp leafo.net/lessphp].

If you're working on your own template you can use any compiler you like.

== References ==

* [http://kyleledbetter.com/jui/less kyleledbetter.com/jui/less] - Example of building your own template.less

<noinclude>[[Category:New in Joomla! 3.0]][[Category:Bug Squad]]</noinclude>

Joomla LESS

2012-12-19T23:57:47Z

Pwiseman: /* Not all LESS compilers are equal */

Most of the Joomla 3.0 default template stylesheets are written using [[wikipedia:LESS_(stylesheet_language)|LESS]] and then compiled to generate the [[wikipedia:CSS|CSS]] files.

== Where can you find the .less stylesheets and compiler? ==

The <code>.less</code> building blocks are located in <code>media/jui/less/</code>. The template specific <code>.less</code>files are located in <code>templates/<templates>/less/</code>.

The CSS generation wrapper script, LESS compiler, and other similar build tools are located in the <code>build/</code> directory of the Joomla source located on GitHub. Refer to [[Git_for_Coders]] for more information on using GitHub. The build directory is only available from the Joomla source, it is not included in an official Joomla release.

== How to re-generate the CSS stylesheets ==

To re-generate all the CSS files from a Joomla core distribution, you will need to execute the generation scripts as a [[wikipedia:Command-line_interface|CLI application]].

For example:
<pre>cd joomla-cms/build
c:\xampp\php\php.exe generatecss.php
</pre>

== Compiling your own LESS files for your template ==

To compile less files for your own template, you will need to take a copy of the <code>generatecss.php</code> script and adjust it to suite your template.

== Not all LESS compilers are equal ==
The LESS compiler used for the Joomla core is obtained from [http://leafo.net/lessphp leafo.net/lessphp].

If you're working on your own template you can use any compiler you like.

<noinclude>[[Category:New in Joomla! 3.0]][[Category:Bug Squad]]</noinclude>

Joomla LESS

2012-12-19T23:41:56Z

Pwiseman:

Most of the Joomla 3.0 default template stylesheets are written using [[wikipedia:LESS_(stylesheet_language)|LESS]] and then compiled to generate the [[wikipedia:CSS|CSS]] files.

== Where can you find the .less stylesheets and compiler? ==

The <code>.less</code> building blocks are located in <code>media/jui/less/</code>. The template specific <code>.less</code>files are located in <code>templates/<templates>/less/</code>.

The CSS generation wrapper script, LESS compiler, and other similar build tools are located in the <code>build/</code> directory of the Joomla source located on GitHub. Refer to [[Git_for_Coders]] for more information on using GitHub. The build directory is only available from the Joomla source, it is not included in an official Joomla release.

== How to re-generate the CSS stylesheets ==

To re-generate all the CSS files from a Joomla core distribution, you will need to execute the generation scripts as a [[wikipedia:Command-line_interface|CLI application]].

For example:
<pre>cd joomla-cms/build
c:\xampp\php\php.exe generatecss.php
</pre>

== Compiling your own LESS files for your template ==

To compile less files for your own template, you will need to take a copy of the <code>generatecss.php</code> script and adjust it to suite your template.

== Not all LESS compilers are equal ==
The LESS compiler used for the Joomla core is obtained from [http://leafo.net/lessphp leafo.net/lessphp].

<noinclude>[[Category:New in Joomla! 3.0]][[Category:Bug Squad]]</noinclude>

Joomla LESS

2012-12-19T23:35:29Z

Pwiseman:

Most of the Joomla 3.0 default template stylesheets are written using [[wikipedia:LESS_(stylesheet_language)|LESS]] and then compiled to generate the [[wikipedia:CSS|CSS]] files.

The <code>.less</code> building blocks are located in <code>media/jui/less/</code>. The template specific <code>.less</code>files are located in <code>templates/<templates>/less/</code>.

The CSS generation wrapper script, LESS compiler, and other similar build tools are located in the <code>build/</code> directory of the Joomla source located on GitHub. Refer to [[Git_for_Coders]] for more information on using GitHub. The build directory is only available from the Joomla source, it is not included in an official Joomla release.

To re-generate all the CSS files from a Joomla core distribution, you will need to execute the generation scripts as a [[wikipedia:Command-line_interface|CLI application]].

For example:
<pre>cd joomla-cms/build
c:\xampp\php\php.exe generatecss.php
</pre>

To generate your own less files in your own template, you will need to take a copy of the <code>generatecss.php</code> script and adjust it to suite your template.

== Not all LESS compilers are equal ==
The LESS compiler used for the Joomla core is obtained from [http://leafo.net/lessphp leafo.net/lessphp].

<noinclude>[[Category:New in Joomla! 3.0]][[Category:Bug Squad]]</noinclude>

Joomla LESS

2012-12-19T23:32:07Z

Pwiseman:

Most of the Joomla 3.0 default template stylesheets are written using [[http://en.wikipedia.org/wiki/LESS_(stylesheet_language)|LESS]] and then compiled to generate the [[http://en.wikipedia.org/wiki/CSS|CSS]] files.

The <code>.less</code> building blocks are located in <code>media/jui/less/</code>. The template specific <code>.less</code>files are located in <code>templates/<templates>/less/</code>.

The CSS generation wrapper script, LESS compiler, and other similar build tools are located in the <code>build/</code> directory of the Joomla source located on GitHub. Refer to [[Git_for_Coders]] for more information on using GitHub. The build directory is only available from the Joomla source, it is not included in an official Joomla release.

To re-generate all the CSS files from a Joomla core distribution, you will need to execute the generation scripts as a [[wikipedia:Command-line_interface|CLI application]].

For example:
<pre>cd joomla-cms/build
c:\xampp\php\php.exe generatecss.php
</pre>

To generate your own less files in your own template, you will need to take a copy of the <code>generatecss.php</code> script and adjust it to suite your template.

== Not all LESS compilers are equal ==
The LESS compiler used for the Joomla core is obtained from [[http://leafo.net/lessphp]].

<noinclude>[[Category:New in Joomla! 3.0]][[Category:Bug Squad]]</noinclude>

Joomla LESS

2012-12-19T07:54:45Z

Pwiseman: Created page with "''This page is intended for Joomla Bug Squad members.'' Joomla 3.0 is shipped with a LESS compiler to generate default template and bootstrap CSS files from LESS files. The ..."

''This page is intended for Joomla Bug Squad members.''

Joomla 3.0 is shipped with a LESS compiler to generate default template and bootstrap CSS files from LESS files.

The css generation wrapper script, LESS compiler, and other similar build tools are located in the build directory. The build directory is only available from a GitHub clone; it is not included in an official Joomla release.

To generate the CSS files you will need to execute the generation scrips as a CLI application.

Talk:Working with Git and Eclipse

2012-06-24T13:35:15Z

Pwiseman: /* GITHUB recommends HTTPS */

== GITHUB recommends HTTPS ==
GITHUB now (June 2012) recommends the HTTP protocol rather than the SSH protocol, and have changed the order of the buttons accordingly.
[[File:GITHUB Protocol 2012-06.png]]

File:GITHUB Protocol 2012-06.png

2012-06-24T13:34:31Z

Pwiseman: uploaded a new version of "File:GITHUB Protocol 2012-06.png"

Talk:Working with Git and Eclipse

2012-06-24T13:32:35Z

Pwiseman: GUTHUB recommendation for HTTP

== GITHUB recommends HTTPS ==
GITHUB now recommends the HTTP protocol rather than the SSH protocol, and have changed the order of the buttons accordingly.
[[File:GITHUB Protocol 2012-06.png]]

File:GITHUB Protocol 2012-06.png

2012-06-24T13:29:43Z

Pwiseman:

Archived:Developing a MVC Component/Adding configuration

2010-09-28T13:19:05Z

Pwiseman: /* Adding configuration parameters */

{{underconstruction}}
{{future|1.6}}

== Articles in this series ==
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!1.6 - Contents}}

== Introduction ==
This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!1.6]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding configuration parameters ==
The Joomla!1.6 framework allows the use of parameters stored in each component. With your favorite file manager and editor, put a file ''admin/config.xml'' file containing these lines:

<span id="admin/config.xml">
''admin/config.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<config>
<fieldset
name="greetings"
label="com_helloworld_Config_Greeting_Settings_Label"
description="com_helloworld_Config_Greeting_Settings_Desc">

<field
name="show_category"
type="radio"
label="com_helloworld_Params_Show_Category_Label"
description="com_helloworld_Params_Show_Category_Desc"
default="0">
<option value="0">Hide</option>
<option value="1">Show</option>
</field>
</fieldset>
</config>
</source>
</span>

This file will be read by the ''com_config'' component of the Joola!1.6 core. For the moment, we defined only one parameter: is the category title displayed or not in the frontend?.

the best way to set the parameters is to put a ''Preferences'' button in a toolbar.

With your favorite editor, put these lines in ''admin/views/helloworldlist/view.html.php''

<span id="admin/views/helloworldlist/view.html.php">
''admin/views/helloworldlist/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');
/**
* HelloWorldList View
*/
class HelloWorldViewHelloWorldList extends JView {
/**
* items to be displayed
*/
protected $items;
/**
* pagination for the items
*/
protected $pagination;
/**
* HelloWorldList view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;
// Set the toolbar
$this->_setToolBar();
// Display the template
parent::display($tpl);
// Set the document
$this->_setDocument();
}
/**
* Setting the toolbar
*/
protected function _setToolBar()
{
JToolBarHelper::title(JText::_('com_helloworld_Manager'), 'helloworld');
JToolBarHelper::deleteListX('com_helloworld_HelloWorldList_Are_you_sure_you_want_to_delete_these_greetings', 'helloworldlist.remove');
JToolBarHelper::editListX('helloworld.edit');
JToolBarHelper::addNewX('helloworld.add');
JToolBarHelper::preferences('com_helloworld');
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function _setDocument()
{
$document = &JFactory::getDocument();
$document->setTitle(JText::_('com_helloworld_Administration'));
}
}
</source>
</span>

== Using configuration parameters as default value ==
We want to define this parameter individually on all HelloWorld data. With your favorite editor, put these lines into the ''admin/models/forms/helloworld.xml''

<span id="admin/models/forms/helloworld.xml">
''admin/models/forms/helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>

<form>
<fields>
<field
id="id"
name="id"
type="hidden"
/>
<field
id="greeting"
name="greeting"
type="text"
size="40"
class="inputbox validate-greeting"
validate="greeting"
required="true"
default=""
label="com_helloworld_HelloWorld_Greeting"
description="com_helloworld_HelloWorld_Greeting_Desc"
/>
<field
id="catid"
name="catid"
type="Categories"
extension="com_helloworld"
allow_none="true"
class="inputbox"
default=""
label="com_helloworld_HelloWorld_Category"
description="com_helloworld_HelloWorld_Category_Desc"
required="true"
>
<option value="0">JOption_No_Category</option>
</field>
</fields>
<fields
group="params"
array="true"
label="com_helloworld_Options">
<field
name="show_category"
type="list"
label="com_helloworld_Params_Show_Category_Label"
description="com_helloworld_Params_Show_Category_Desc"
default="">
<option value="">Use Global</option>
<option value="0">Hide</option>
<option value="1">Show</option>
</field>
</fields>
</form>
</source>
</span>

We define the same parameter for each message with an additional value: ''Use global''. The ''array="true"'' xml field means that parameters in this group will be grouped in the ''params'' array.

== Modifying the SQL ==
Data now contains a new parameter: ''params''. The SQL structure has to be modified.

With your favorite editor, put these lines into ''admin/sql/install.mysql.utf8.sql'':

<span id="admin/sql/install.mysql.utf8.sql">
''admin/sql/install.mysql.utf8.sql''
<source lang="sql">
DROP TABLE IF EXISTS `#__helloworld`;

CREATE TABLE `#__helloworld` (
`id` int(11) NOT NULL auto_increment,
`greeting` varchar(25) NOT NULL,
`catid` int(11) NOT NULL default '0',
`params` TEXT NOT NULL default '',
PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=0 DEFAULT CHARSET=utf8;

INSERT INTO `#__helloworld` (`greeting`) VALUES
('Hello World!'),
('Good bye World!');
</source>
</span>

With your favorite editor, put these lines into ''admin/sql/update.mysql.utf8.sql'':

<span id="admin/sql/update.mysql.utf8.sql">
''admin/sql/update.mysql.utf8.sql''
<source lang="sql">
ALTER TABLE `#__helloworld` ADD `params` TEXT NOT NULL default '';
</source>
</span>

The ''TableHelloWorld'' has to be modified in order to deal with these parameters: they will be stored in a JSON format and get in a ''JParameter'' class. We have to overload the ''bind'' and the ''load'' method. With your favorite editor, put these lines into ''admin/tables/helloworld.php''

<span id="admin/tables/helloworld.php">
''admin/tables/helloworld.php''
<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die('Restricted access');
// import Joomla table library
jimport('joomla.database.table');
/**
* Hello Table class
*/
class TableHelloWorld extends JTable
{
/**
* Primary Key
*
* @var int
*/
var $id = null;
/**
* @var string
*/
var $greeting = null;
/**
* @var int
*/
var $catid = null;
/**
* @var string
*/
var $params = null;
/**
* Constructor
*
* @param object Database connector object
*/
function TableHelloWorld(&$db)
{
parent::__construct('#__helloworld', 'id', $db);
}
/**
* Overloaded bind function
*
* @param array $hash named array
* @return null|string null is operation was satisfactory, otherwise returns an error
* @see JTable:bind
* @since 1.5
*/
public function bind($array, $ignore = '')
{
if (isset($array['params']) && is_array($array['params']))
{
// Convert the params field to an string.
$parameter = new JParameter;
$parameter->loadArray($array['params']);
$array['params'] = $parameter->toString();
}
return parent::bind($array, $ignore);
}
/**
* Overloaded load function
*
* @param int $pk primary key
* @param boolean $reset reset data
* @return boolean
* @see JTable:load
*/
public function load($pk = null, $reset = true)
{
if (parent::load($pk, $reset))
{
// Convert the params field to a parameter.
$parameter = new JParameter;
$parameter->loadJSON($this->params);
$this->params = $parameter;
return true;
}
else
{
return false;
}
}
}
</source>
</span>

== Modifying the backend ==
The backend model has to used the ''load'' method of the ''TableHelloWorld'' class. With your favorite editor, put these lines into the ''admin/models/helloworld.php'' file:

<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.modelform');
/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelForm
{
/**
* @var array data
*/
protected $data = null;
/**
* Method to auto-populate the model state.
*/
protected function _populateState()
{
$app = JFactory::getApplication('administrator');
// Load the User state.
if (!($pk = (int)$app->getUserState('com_helloworld.edit.helloworld.id')))
{
$pk = (int)JRequest::getInt('id');
}
$this->setState('helloworld.id', $pk);
}
/**
* Method to get the data.
*
* @access public
* @return array of string
* @since 1.0
*/
public function &getData()
{
if (empty($this->data))
{
$data = & JRequest::getVar('jform');
if (empty($data))
{
$selected = $this->getState('helloworld.id');
$data = $this->getTable();
$data->load((int)$selected);
}
$this->data = $data;
}
return $this->data;
}
/**
* Method to get the HelloWorld form.
*
* @access public
* @return mixed JForm object on success, false on failure.
* @since 1.0
*/
public function &getForm()
{
$form = & parent::getForm('helloworld', 'form', array(
'array' => 'jform'
) , false);
return $form;
}
/**
* Method to get the javascript attached to the form
*
* @return string URL to the script.
*/
function getScript()
{
return 'administrator/components/com_helloworld/models/forms/helloworld.js';
}
/**
* Method to save a record
*
* @param array $data array of data
* @access public
* @return boolean True on success
*/
function save($data)
{
// Database processing
$row = & $this->getTable();
// Bind the form fields to the hello table
if (!$row->save($data))
{
$this->setError($row->getErrorMsg());
return false;
}
return true;
}
}
</source>
</span>

The backend edit view has to display the options to the administrator. With your favorite editor, put these lines into the ''admin/views/helloworld/tmpl/edit.php'' file:

<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');
JHTML::_('behavior.formvalidation');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm" class="form-validate">
<div class="width-60 fltlft">
<fieldset class="adminform">
<legend><?php echo JText::_( 'com_helloworld_HelloWorld_Details' ); ?></legend>
<?php foreach($this->form->getFields() as $field): ?>
<?php if (!$field->hidden): ?>
<?php echo $field->label; ?>
<?php endif; ?>
<?php echo $field->input; ?>
<?php endforeach; ?>
</fieldset>
</div>
<div class="width-40 fltrt">
<fieldset class="adminform">
<legend><?php echo JText::_( 'com_helloworld_HelloWorld_Options' ); ?></legend>
<?php foreach($this->form->getFields('params') as $field): ?>
<?php if (!$field->hidden): ?>
<?php echo $field->label; ?>
<?php endif; ?>
<?php echo $field->input; ?>
<?php endforeach; ?>
</fieldset>
</div>
<input type="hidden" name="task" value="helloworld.edit" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>
</span>

== Modifying the frontend ==
The frontend has to be modified according to the new ''show_category'' parameter.

We have to modified the model:
* it has to merge global parameters and individual parameters
* it has to provide the category

With your favorite editor, put these lines into the ''site/models/helloworld.php'' file:

<span id="site/models/helloworld.php">
''site/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import Joomla modelitem library
jimport('joomla.application.component.modelitem');
/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelItem
{
/**
* @var object $item
*/
protected $item;
/**
* @var object $category
*/
protected $category;
/**
* Get the message
* @return object The message to be displayed to the user
*/
public function getItem()
{
if (!isset($this->item))
{
$id = JRequest::getInt('id');
// Get a TableHelloWorld instance
$table = $this->getTable();
// Load the message
$table->load($id);
// Add global parameters
$params = clone JFactory::getApplication('site')->getParams();
$params->merge($table->params);
$table->params = $params;
// Assign the message
$this->item = $table;
}
return $this->item;
}
/**
* Get the category
* @return object The category assigned to the message
*/
public function getCategory()
{
if (!isset($this->category))
{
$catid = $this->getItem()->catid;
// Get a TableHelloWorld instance
$table = $this->getTable('Category', 'JTable');
// Load the category
$table->load($catid);
// Assign the category
$this->category = $table;
}
return $this->category;
}
}
</source>
</span>

The view has to ask the model for the category. With your favorite editor, put these lines into the ''site/views/helloworld/view.html.php''

<span id="site/views/helloworld/view.html.php">
''site/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');
/**
* HTML View class for the HelloWorld Component
*/
class HelloWorldViewHelloWorld extends JView
{
protected $item = null;
protected $category = null;
// Overwriting JView display method
function display($tpl = null)
{
// Assign data to the view
$this->item = $this->get('Item');
// Assign data to the view
$this->category = $this->get('Category');
// Display the view
parent::display($tpl);
}
}
</source>
</span>

The layout can now display correctly the category or not. With your favorite editor, put these lines into ''site/views/helloworld/tmpl/default.php''

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

<h1>
<?php echo $this->item->greeting;?>
<?php if ($this->item->params->get('show_category') && !empty($this->category->title)):?>
(<?php echo $this->category->title;?>)
<?php endif;?>
</h1>
</source>
</span>

== Adding some translation strings ==
Some strings have to be added in the ''admin/language/en-GB/en-GB.com_helloworld.ini'' file

<span id="admin/language/en-GB/en-GB.com_helloworld.ini">
''admin/language/en-GB/en-GB.com_helloworld.ini''
<source lang="ini">
# Joomla16.Tutorials
# Copyright (C) 2005 - 2009 Open Source Matters. All rights reserved.
# License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM

COM_HELLOWORLD_ADMINISTRATION=HelloWorld administration
COM_HELLOWORLD_CATEGORIES=Categories
COM_HELLOWORLD_MANAGER=HelloWorld manager
COM_HELLOWORLD_MESSAGES=Messages
COM_HELLOWORLD_HELLOWORLD_CATEGORY=Category
COM_HELLOWORLD_HELLOWORLD_CATEGORY_DESC=Category of the message
COM_HELLOWORLD_HELLOWORLD_CREATING=Creating
COM_HELLOWORLD_HELLOWORLD_DETAILS=Details
COM_HELLOWORLD_HELLOWORLD_OPTIONS=Options
COM_HELLOWORLD_HELLOWORLD_EDITING=Editing
COM_HELLOWORLD_HELLOWORLD_ERROR_SOME_VALUES_ARE_UNACCEPTABLE=Some values are unacceptable
COM_HELLOWORLD_HELLOWORLD_GREETING_DESC=Message to be displayed
COM_HELLOWORLD_HELLOWORLD_GREETING=Greeting
COM_HELLOWORLD_HELLOWORLDLIST_ARE_YOU_SURE_YOU_WANT_TO_DELETE_THESE_GREETINGS=Are you sure you want to delete these greetings?
COM_HELLOWORLD_HELLOWORLDLIST_GREETING=Greeting
COM_HELLOWORLD_HELLOWORLDLIST_GREETINGS_REMOVED=Greetings removed
COM_HELLOWORLD_HELLOWORLDLIST_ID=Id
COM_HELLOWORLD_HELLOWORLDLIST_ONE_OR_MORE_GREETINGS_COULD_NOT_BE_DELETED=One or more greetings could not be deleted: %s
COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_MSG_DESC=This message will be displayed
COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_MSG_LABEL=Message

COM_HELLOWORLD_CONFIGURATION=Configuration
COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_LABEL=Greeting settings
COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_DESC=Greetings settings description
COM_HELLOWORLD_PARAMS_SHOW_CATEGORY_LABEL=Show category
COM_HELLOWORLD_PARAMS_SHOW_CATEGORY_DESC=Display the category after the message
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_02#site/helloworld.php|site/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_02#site/controller.php|site/controller.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/views/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/views/helloworld/index.html]]''
* ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_06#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/models/index.html]]''
* ''[[#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/language/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|site/language/en-GB/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_08#site/language/en-GB/en-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/index.html]]''
* ''[[#admin/config.xml|admin/config.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_12#admin/helloworld.php|admin/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_12#admin/controller.php|admin/controller.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/sql/index.html]]''
* ''[[#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_06#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[#admin/sql/update.mysql.utf8.sql|admin/sql/update.mysql.utf8.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/models/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/models/fields/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_12#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/models/forms/index.html]]''
* ''[[#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/models/rules/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]''
* ''[[#admin/models/helloworld.php|admin/models/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_09#admin/models/helloworldlist.php|admin/models/helloworldlist.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/views/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/views/helloworldlist/index.html]]''
* ''[[#admin/views/helloworldlist/view.html.php|admin/views/helloworldlist/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/views/helloworldlist/tmpl/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/views/helloworldlist/tmpl/default.php|admin/views/helloworldlist/tmpl/default.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_07#admin/views/helloworldlist/tmpl/default_head.php|admin/views/helloworldlist/tmpl/default_head.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_07#admin/views/helloworldlist/tmpl/default_body.php|admin/views/helloworldlist/tmpl/default_body.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_07#admin/views/helloworldlist/tmpl/default_foot.php|admin/views/helloworldlist/tmpl/default_foot.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/views/helloworldlist/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/views/helloworld/tmpl/index.html]]''
* ''[[#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/tables/index.html]]''
* ''[[#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[#admin/language/en-GB/en-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_08#admin/language/en-GB/en-GB.com_helloworld.menu.ini|admin/language/en-GB/en-GB.com_helloworld.menu.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|admin/controllers/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_11#admin/controllers/helloworldlist.php|admin/controllers/helloworldlist.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_08#language/en-GB/en-GB.ini|language/en-GB/en-GB.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|media/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.6_-_Part_01#index.html|media/images/index.html]]''
* ''media/images/tux-16x16.png''
* ''media/images/tux-48x48.png''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/46172/com_helloworld-1.6-part13.zip archive] and install it using the extension manager of Joomla!1.6. 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="1.6.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.13</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> 
<sql>
<file driver="mysql" charset="utf8">sql/update.mysql.utf8.sql</file>
</sql>
</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>

<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
</media>

<administration>
<menu img="../media/com_helloworld/images/tux-16x16.png">Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>config.xml</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>
<folder>views</folder>
<folder>controllers</folder>
<folder>helpers</folder>
</files>
<languages folder="admin">
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.ini</language>
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.menu.ini</language>
</languages>
</administration>
</extension>
</source>
</span>

== Contributors ==
*[[User:cdemko|Christophe Demko]]

[[Category:Development]]
[[category:Joomla! 1.6]]
[[category:Manual]]

Archived talk:Developing a MVC Component/Adding a variable request in the menu type

2010-09-10T03:56:13Z

Pwiseman: Possible fix for default.xml under 1.6

[10-09-2010 pwiseman] Testing failed. I needed to swap the order of the <fieldset> and <fields> tags to get it to work, and add a "name" attribute to fields. Possibly the "group" and "array" attributes are no longer required in 1.6?