Joomla! Documentation - User contributions [en]

Chunk:Managing Component Updates - Contents

2013-05-24T12:15:51Z

Hutchy68: fixing navigation links with correct namespace

{{ambox
| image = 2.5
| type = none
| imageright = [[File:Crystal Clear app help index.png|30px|link=|alt=]]
| text = <div style="margin-top:-3px; text-align:center; padding:3px">{{#if:{{{noheader|}}}||
<div class="center" style="width:auto; margin-left:auto; margin-right:auto;"><span style="font-size: 125%">'''Managing Component Updates Tutorial'''</span></div>}}
<div class="hlist">
* [[J2.5:Managing Component Updates|Overview]]
* [[J2.5:Managing Component Updates (Manifest file)|Manifest file]]
* [[J2.5:Managing Component Updates (Script.php)|Script.php]]
* [[J2.5:Managing Component Updates (Update SQL files)|Update SQL files]]
* [[J2.5:Managing Component Updates (Component release files)|Component release files]]
* [[J2.5:Managing Component Updates (How to use this example)|How to use this example]]
</div></div>}}
{{RightTOC}}
<includeonly>[[Category:Tutorials in a Series]]</includeonly>
<noinclude>[[Category:Tutorial Series Templates]]</noinclude>

J2.5:Managing Component Updates (Component release files)

2013-05-24T12:15:27Z

Hutchy68: Hutchy68 moved page Managing Component Updates (Component release files) to J2.5:Managing Component Updates (Component release files) without leaving a redirect: namespacing

{{version/tutor|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
== Component Release Files ==
Included in this example are zip files for four releases. You will need to download all four to exercise the features of this example.

=== Version 1.0 ===
The zip file can be downloaded from
[http://joomlacode.org/gf/download/frsrelease/16495/74511/democompupdate_10.zip democompupdate_10.zip].
It contains files:
* democompupdate_10/democompupdate.xml
* democompupdate_10/script.php
* democompupdate_10/admin/sql/install_data.sql
* democompupdate_10/admin/sql/uninstall.sql
* democompupdate_10/admin/sql/updates/1.0.sql
* democompupdate_10/site/controller.php
* democompupdate_10/site/democompupdate.php
* democompupdate_10/site/models/democompupdate.php
* democompupdate_10/site/views/democompupdate/view.html.php
* democompupdate_10/site/views/democompupdate/tmpl/default.php

=== Version 1.0.j3 ===
The zip file can be downloaded from
[http://joomlacode.org/gf/download/frsrelease/16495/74512/democompupdate_10j3.zip democompupdate_10j3.zip]. It is identical to version 1.0, except that is requires Joomla 30.0. The intent is that this will cause an abort of the install or update.
Diff's of ''democompupdate_10'' and ''democompupdate_10j3'' show how files have changed.
<blockquote>
<pre>
diff -r democompupdate_10/democompupdate.xml democompupdate_10j3/democompupdate.xml
2c2
< <extension type="component" version="1.6" method="new">
---
> <extension type="component" version="30.0" method="new">
</pre>
</blockquote>

=== Version 1.1.1 ===

The zip file can be downloaded from
[http://joomlacode.org/gf/download/frsrelease/16495/74513/democompupdate_111.zip democompupdate_111.zip].
Diff's of ''democompupdate_10'' and ''democompupdate_111'' show how files have changed.
<blockquote>
<pre>
diff -r democompupdate_10/admin/sql/install_data.sql democompupdate_111/admin/sql/install_data.sql
10c10
< (1,'1.0');
---
> (1,'1.1.1');
Only in democompupdate_111/admin/sql/updates: 1.1.1.sql
Only in democompupdate_111/admin/sql/updates: 1.1.sql
diff -r democompupdate_10/democompupdate.xml democompupdate_111/democompupdate.xml
2c2
< <extension type="component" version="1.6" method="new">
---
> <extension type="component" version="1.6" method="upgrade">
8c8
< <version>1.0</version>
---
> <version>1.1.1</version>
diff -r democompupdate_10/site/views/democompupdate/view.html.php democompupdate_111/site/views/democompupdate/view.html.php
25c25
< $myRev = '1.0';
---
> $myRev = '1.1.1';

</pre>
</blockquote>

=== Version 1.3 ===
The zip file can be downloaded from
[http://joomlacode.org/gf/download/frsrelease/16495/74514/democompupdate_13.zip democompupdate_13.zip].
Diff's of ''democompupdate_111'' and ''democompupdate_13'' show how files have changed.
<blockquote>
<pre>
diff -r democompupdate_111/admin/sql/install_data.sql democompupdate_13/admin/sql/install_data.sql
10c10,12
< (1,'1.1.1');
---
> (1,'1.1.1'),
> (2,'1.2.1'),
> (3,'1.3');
Only in democompupdate_13/admin/sql/updates: 1.2.1.sql
Only in democompupdate_13/admin/sql/updates: 1.2.sql
Only in democompupdate_13/admin/sql/updates: 1.3.sql
diff -r democompupdate_111/democompupdate.xml democompupdate_13/democompupdate.xml
8c8
< <version>1.1.1</version>
---
> <version>1.3</version>
diff -r democompupdate_111/site/views/democompupdate/view.html.php democompupdate_13/site/views/democompupdate/view.html.php
25c25
< $myRev = '1.1.1';
---
> $myRev = '1.3';
</pre>
</blockquote>

== Contributors ==
*[[User:sm990|Kim Eckert]]

[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]
[[Category:Component Development]]

Managing Component Updates with Joomla!2.5 - Part 5

2013-05-24T12:15:06Z

Hutchy68: fixing move error

#REDIRECT [[J2.5:Managing Component Updates (Component release files)]]

J2.5:Managing Component Updates (How to use this example)

2013-05-24T12:14:10Z

Hutchy68: Hutchy68 moved page Managing Component Updates (How to use this example) to J2.5:Managing Component Updates (How to use this example) without leaving a redirect: namespacing fix

{{version/tutor|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
You will need to download all four versions of this example to exercise all of the features.

== Normal update sequence ==

You can use the following sequence of installs, updates and uninstalls to show the effects of this example. You may also try installs, updates and uninstalls in any sequence that you desire.

* Previous state: no com_democompupdate component installed.
* Install democompupdate_10.zip.
** Verify the install is good by the text echoed in back-end.
** Front-end: verify database, files and parameter setting.
** optional: phpMyAdmin: verify:
*** jos_democompupdate_mytable exists and has one row, myvalue = '1.0'.
*** jos_extensions table has entry for com_democompupdate.
**** params field (JSON), has three values.
**** manifest_cache field (JSON) shows version '1.0'.

* Previous state: version 1.0 installed.
* Install democompupdate_111.zip.
** Verify the update is good by the text echoed in back-end.
** Front-end: verify database, files and parameter setting.
** optional: phpMyAdmin: verify:
*** jos_democompupdate_mytable exists and has one row, value '1.1.1'.
*** jos_extensions table has entry for com_democompupdate.
**** params field (JSON), has three values.
**** manifest_cache field (JSON) shows version '1.1.1'.

* Previous state: version 1.1.1 installed.
* Install democompupdate_13.zip.
** Verify the update is good by the text echoed in back-end.
** Front-end: verify database, files and parameter setting.
*** There should be three rows in the table.
** optional: phpMyAdmin: verify:
*** jos_democompupdate_mytable exists and has three rows, values '1.1.1', '1.2.1' and '1.3'.
*** jos_extensions table has entry for com_democompupdate.
**** params field (JSON), has three values.
**** manifest_cache field (JSON) shows version '1.3'.

== Try a reverse-sequence update ==

* Previous state: version 1.3 installed.
* Install democompupdate_10.zip.
** Update should fail, give useful information in the back-end.
** No change should be seen in the front-end, back-end or MySqlAdmin.

== Make sure that uninstall works ==

* Previous state: version 1.3 installed.
* Uninstall com_democompupdate
** Verify the component does not exist in Joomla extension manager or front-end.
** optional: phpMyAdmin: verify that democompupdate elements are gone.

== Verify full installs of each revision work correctly ==

* Previous state: no democompupdate component installed.
* Install democompupdate_111.zip.
** Verify that the full install created the same database and file state as the update to 1.1.1.

* Previous state: version 1.1.1 installed.
* Uninstall com_democompupdate
** Verify the component does not exist in Joomla extension manager or front-end.
** optional: phpMyAdmin: verify that democompupdate elements are gone.

* Previous state: no democompupdate component installed.
* Install democompupdate_13.zip.
** Verify that the full install created the same database and file state as the update to 1.3.

== Verify that Joomla version check works ==

* Previous state: version 1.3 installed.
* Uninstall com_democompupdate
* Install democompupdate_10j3.zip.
** The update should fail, give useful information in the back-end.
** No evidence of the installed component should exist in front-end, back-end or MySqlAdmin.

== Summary ==

You can use the update features in Joomla 1.6 (and greater) to ensure that the web site administrator installs your component properly.
* Your component version string sequence must follow the requirements shown in the PHP ''version_compare'' function.
* Create update SQL files for component revisions. The file names must match your version strings.
* Update the version string in the manifest file for each version.
* Update the required Joomla version in the manifest file, if you will use it in the script.php file to enable installs and updates.
* Modify the custom PHP code in the script.php file, if needed, for each version.

If your component requires non-standard update handling, you can implement it in the script.php file. You can disable the normal update SQL file execution and implement your own code. You can implement custom checks and custom install and update actions. You can, and should create confirmation messages and error messages to help the web site administrator understand what your code is doing.

I intentionally made this example simple, to make debugging easier. You can implement your custom code in this example, verify that it works correctly, then implement it in your component. Share your successes with the Joomla community.

== Contributors ==
*[[User:sm990|Kim Eckert]]

[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]
[[Category:Component Development]]

Managing Component Updates with Joomla!2.5 - Part 6

2013-05-24T12:13:40Z

Hutchy68: fixing move error

#REDIRECT [[J2.5:Managing Component Updates (How to use this example)]]

Managing Component Updates with Joomla!2.5 - Part 6

2013-05-24T12:08:01Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 6 to Managing Component Updates (How to use this example): namespacing for version

#REDIRECT [[Managing Component Updates (How to use this example)]]

J2.5:Managing Component Updates (How to use this example)

2013-05-24T12:08:01Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 6 to Managing Component Updates (How to use this example): namespacing for version

Managing Component Updates with Joomla!2.5 - Part 5

2013-05-24T12:07:00Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 5 to Managing Component Updates (Component release files): namespacing for version

#REDIRECT [[Managing Component Updates (Component release files)]]

J2.5:Managing Component Updates (Component release files)

2013-05-24T12:07:00Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 5 to Managing Component Updates (Component release files): namespacing for version

Managing Component Updates with Joomla!2.5 - Part 4

2013-05-24T12:05:36Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 4 to J2.5:Managing Component Updates (Update SQL files)

#REDIRECT [[J2.5:Managing Component Updates (Update SQL files)]]

J2.5:Managing Component Updates (Update SQL files)

2013-05-24T12:05:36Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 4 to J2.5:Managing Component Updates (Update SQL files)

{{version/tutor|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
== Update SQL files ==
The update SQL file(s) are located in a directory that is listed in the manifest file:

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

There is an SQL file for each component version. Each file name must match the version string in the manifest file for that version. Joomla uses this string to determine which SQL files(s) to execute, and in what order they will be executed.

''Important Note:'' These files are also used to set the version number in the <code>#__schemas</code> table. This version number must be present in the current version of the component in order for the new SQL files to be run during the update. For example, if you have version 1.0 and are updating to version 1.1, the <code>1.1.sql</code> file will not be executed if there was no <code>1.0.sql</code> file in the 1.0 release. For this reason, it is good practice to have a SQL update file for each version, even if there is no SQL change in that version. You can just use an empty file or a file with a comment line.

Joomla uses the PHP ''version_compare'' function to execute the correct SQL files.. Familiarize yourself with this function. Your version strings need to adhere to the conventions of this function.
For example, the SQL files for version 1.3 of this example include:
<blockquote>
<pre>
1.0.sql
(empty) OR
# Dummy SQL file to set schema version to 1.0 so next update will work

1.1.sql
UPDATE `#__democompupdate_mytable` SET myvalue='Version 1.1 text' WHERE id=1;

1.1.1.sql
UPDATE `#__democompupdate_mytable` SET myvalue='Version 1.1.1 text' WHERE id=1;

1.2.sql
INSERT INTO `#__democompupdate_mytable` (id,myvalue) VALUES (2,'Version 1.2 text');

1.2.1.sql
UPDATE `#__democompupdate_mytable` SET myvalue='Version 1.2.1 text' WHERE id=2;

1.3.sql
INSERT INTO `#__democompupdate_mytable` (id,myvalue) VALUES (3,'Version 1.3 text');
</pre>
</blockquote>

This example has complete install files for component versions 1.0 (initial), 1.1.1 and 1.3. Update SQL files are included for additional incremental component versions (1.1, 1.2 and 1.2.1) between these three versions. These extra versions illustrate the process for updates that span more than one incremental version.

* When updating from version 1.0 to version 1.1.1, both files 1.1.sql and 1.1.1.sql are executed. The SQL commands update the value of the first, and only, row in the database table. The command in 1.1.1.sql over-writes the value that was written by 1.1.sql.
* When updating from version 1.1.1 to version 1.3, files 1.2.sql, 1.2.1.sql and 1.3.sql are executed. The commands in 1.2.sql and 1.3.sql each create a new row in the database table.
* When updating from version 1.0 directly to 1.3, files 1.1.sql, 1.1.1.sql, 1.2.sql, 1.2.1.sql and 1.3.sql are all executed. You can see the cumulative effect of the table changes in the component front-end.

Joomla executes the database updates in the sequence that would occur, as if the user had updated each version separately. This would be necessary if an incremental database update depended on the correct update from the previous version. An example would be: if a modification of a table value during one update depended on the addition of a new table field during a previous update.

Joomla uses the PHP function ''version_compare'' to define the execution order of the SQL files. The sequencing of your component version string must adhere to that defined by the ''version_compare'' function.

== Contributors ==
*[[User:sm990|Kim Eckert]]

[[Category:Joomla! 2.5]]
[[Category:Component Development]]

Managing Component Updates with Joomla!2.5 - Part 3

2013-05-24T12:04:24Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 3 to J2.5:Managing Component Updates (Script.php): namespacing for version

#REDIRECT [[J2.5:Managing Component Updates (Script.php)]]

J2.5:Managing Component Updates (Script.php)

2013-05-24T12:04:24Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 3 to J2.5:Managing Component Updates (Script.php): namespacing for version

{{version/tutor|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}

== Script.php ==
This file contains the component-specific methods preflight, install, update, postflight and uninstall. This file is where the component developer implements all of the unique code for these actions.
For this example, in addition to various checks, HTML is inserted into the back-end output to show which code has been executed and several component parameters are created and maintained. You may choose to display different HTML, or to display none for your component.

=== preflight ===
This is where most of the checking should be done before install, update or discover_install. Preflight is executed prior to any Joomla install, update or discover_install actions. Preflight is not executed on uninstall. A string denoting the type of action (install, update or discover_install) is passed to preflight in the $type operand. Your code can use this string to execute different checks and responses for the three cases.

It is appropriate to check the Joomla version and the existing component version in the preflight module. A failure of either of these two should cause an abort of the action. An abort is triggered by returning a false value from this preflight method. On receiving a false return value, Joomla will reverse any actions already completed.

The PHP function ''version_compare'' is useful to compare version strings. Joomla also uses ''version_compare'' to define the sequence of SQL file execution, when an update is being executed that spans multiple versions.

In this example, the preflight method checks that Joomla version is equal to or greater than the value in the manifest file. If an earlier Joomla version is in use, the install or update will abort. Try changing the version string in the manifest file file to a value greater than the Joomla version that you are using. Installs and updates should fail. This is what the version ''democompupdate_10j3.zip'' demonstrates.

In addition to failing, it is important to give the web site administrator useful information as to why the component installation failed. See the example below.
<source lang="php">
function preflight( $type, $parent ) {
$jversion = new JVersion();

// Installing component manifest file version
$this->release = $parent->get( "manifest" )->version;

// Manifest file minimum Joomla version
$this->minimum_joomla_release = $parent->get( "manifest" )->attributes()->version;

// Show the essential information at the install/update back-end
echo '<p>Installing component manifest file version = ' . $this->release;
echo '<br />Current manifest cache commponent version = ' . $this->getParam('version');
echo '<br />Installing component manifest file minimum Joomla version = ' . $this->minimum_joomla_release;
echo '<br />Current Joomla version = ' . $jversion->getShortVersion();

// abort if the current Joomla release is older
if( version_compare( $jversion->getShortVersion(), $this->minimum_joomla_release, 'lt' ) ) {
Jerror::raiseWarning(null, 'Cannot install com_democompupdate in a Joomla release prior to '.$this->minimum_joomla_release);
return false;
}

// abort if the component being installed is not newer than the currently installed version
if ( $type == 'update' ) {
$oldRelease = $this->getParam('version');
$rel = $oldRelease . ' to ' . $this->release;
if ( version_compare( $this->release, $oldRelease, 'le' ) ) {
Jerror::raiseWarning(null, 'Incorrect version sequence. Cannot upgrade ' . $rel);
return false;
}
}
else { $rel = $this->release; }

echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_PREFLIGHT_' . $type . ' ' . $rel) . '</p>';
}
</source>

=== install ===
Install is executed after the Joomla install database scripts have completed. Returning 'false' will abort the install and undo any changes already made.
It is cleaner to abort the install during preflight, if possible. Since fewer install actions have occurred at preflight, there is less risk that that their reversal may be done incorrectly.
<source lang="php">
function install( $parent ) {
echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_INSTALL to ' . $this->release) . '</p>';
// You can have the backend jump directly to the newly installed component configuration page
// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');
}
</source>

=== update ===
Update is executed after the Joomla update database scripts have completed. Returning 'false' will abort the update and undo any changes already made.
It is cleaner to abort the update during preflight, if possible. Since fewer update actions have occurred at preflight, there is less risk that that their reversal may be done incorrectly.
<source lang="php">
function update( $parent ) {
echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UPDATE_ to ' . $this->release) . '</p>';
// You can have the backend jump directly to the newly updated component configuration page
// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');
}
</source>

=== postflight ===
Postflight is executed after the Joomla install, update or discover_update actions have completed. It is not executed after uninstall. Postflight is executed after the extension is registered in the database. The type of action (install, update or discover_install) is passed to postflight in the $type operand. Postflight cannot cause an abort of the Joomla install, update or discover_install action.

The postflight method is a good place to set the default values of component parameters during installs, and to set the values of hidden component parameters during installs and updates. Postflight can be used for any other action that must follow the install, update or discover_install actions.

This example defines component parameters in postflight. The value of ''my_param0'' is displayed in the component front-end. Both ''my_param0'' and ''my_param1'' are overwritten in all updates. This is how you would change revision-specific values during an update. The examples ''myparam2'' and ''myparam3'' represent component configuration parameters that you expect users to set, and you do not want to overwrite during an update. This example sets these two values only on a new install, not on an update. Parameters that control component operation would be treated this way.
<source lang="php">
function postflight( $type, $parent ) {
// always create or modify these parameters
$params['my_param0'] = 'Component version ' . $this->release;
$params['my_param1'] = 'Another value';

// define the following parameters only if it is an original install
if ( $type == 'install' ) {
$params['my_param2'] = '4';
$params['my_param3'] = 'Star';
}

$this->setParams( $params );

echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_POSTFLIGHT ' . $type . ' to ' . $this->release) . '</p>';
}
</source>

=== uninstall ===
The uninstall method is executed before any Joomla uninstall action, such as file removal or database changes. Uninstall cannot cause an abort of the Joomla uninstall action, so returning false would be a waste of time.
<source lang="php">
function uninstall( $parent ) {
echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UNINSTALL ' . $this->release) . '</p>';
}
</source>

== The entire script.php file ==
This is the entire script.php file. It is the same for all versions of com_democompupdate.
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

//the name of the class must be the name of your component + InstallerScript
//for example: com_contentInstallerScript for com_content.
class com_democompupdateInstallerScript
{
/*
* $parent is the class calling this method.
* $type is the type of change (install, update or discover_install, not uninstall).
* preflight runs before anything else and while the extracted files are in the uploaded temp folder.
* If preflight returns false, Joomla will abort the update and undo everything already done.
*/
function preflight( $type, $parent ) {
$jversion = new JVersion();

// Installing component manifest file version
$this->release = $parent->get( "manifest" )->version;

// Manifest file minimum Joomla version
$this->minimum_joomla_release = $parent->get( "manifest" )->attributes()->version;

// Show the essential information at the install/update back-end
echo '<p>Installing component manifest file version = ' . $this->release;
echo '<br />Current manifest cache commponent version = ' . $this->getParam('version');
echo '<br />Installing component manifest file minimum Joomla version = ' . $this->minimum_joomla_release;
echo '<br />Current Joomla version = ' . $jversion->getShortVersion();

// abort if the current Joomla release is older
if( version_compare( $jversion->getShortVersion(), $this->minimum_joomla_release, 'lt' ) ) {
Jerror::raiseWarning(null, 'Cannot install com_democompupdate in a Joomla release prior to '.$this->minimum_joomla_release);
return false;
}

// abort if the component being installed is not newer than the currently installed version
if ( $type == 'update' ) {
$oldRelease = $this->getParam('version');
$rel = $oldRelease . ' to ' . $this->release;
if ( version_compare( $this->release, $oldRelease, 'le' ) ) {
Jerror::raiseWarning(null, 'Incorrect version sequence. Cannot upgrade ' . $rel);
return false;
}
}
else { $rel = $this->release; }

echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_PREFLIGHT_' . $type . ' ' . $rel) . '</p>';
}

/*
* $parent is the class calling this method.
* install runs after the database scripts are executed.
* If the extension is new, the install method is run.
* If install returns false, Joomla will abort the install and undo everything already done.
*/
function install( $parent ) {
echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_INSTALL to ' . $this->release) . '</p>';
// You can have the backend jump directly to the newly installed component configuration page
// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');
}

/*
* $parent is the class calling this method.
* update runs after the database scripts are executed.
* If the extension exists, then the update method is run.
* If this returns false, Joomla will abort the update and undo everything already done.
*/
function update( $parent ) {
echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UPDATE_ to ' . $this->release) . '</p>';
// You can have the backend jump directly to the newly updated component configuration page
// $parent->getParent()->setRedirectURL('index.php?option=com_democompupdate');
}

/*
* $parent is the class calling this method.
* $type is the type of change (install, update or discover_install, not uninstall).
* postflight is run after the extension is registered in the database.
*/
function postflight( $type, $parent ) {
// always create or modify these parameters
$params['my_param0'] = 'Component version ' . $this->release;
$params['my_param1'] = 'Another value';

// define the following parameters only if it is an original install
if ( $type == 'install' ) {
$params['my_param2'] = '4';
$params['my_param3'] = 'Star';
}

$this->setParams( $params );

echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_POSTFLIGHT ' . $type . ' to ' . $this->release) . '</p>';
}

/*
* $parent is the class calling this method
* uninstall runs before any other action is taken (file removal or database processing).
*/
function uninstall( $parent ) {
echo '<p>' . JText::_('COM_DEMOCOMPUPDATE_UNINSTALL ' . $this->release) . '</p>';
}

/*
* get a variable from the manifest file (actually, from the manifest cache).
*/
function getParam( $name ) {
$db = JFactory::getDbo();
$db->setQuery('SELECT manifest_cache FROM #__extensions WHERE name = "com_democompupdate"');
$manifest = json_decode( $db->loadResult(), true );
return $manifest[ $name ];
}

/*
* sets parameter values in the component's row of the extension table
*/
function setParams($param_array) {
if ( count($param_array) > 0 ) {
// read the existing component value(s)
$db = JFactory::getDbo();
$db->setQuery('SELECT params FROM #__extensions WHERE name = "com_democompupdate"');
$params = json_decode( $db->loadResult(), true );
// add the new variable(s) to the existing one(s)
foreach ( $param_array as $name => $value ) {
$params[ (string) $name ] = (string) $value;
}
// store the combined new and existing values back as a JSON string
$paramsString = json_encode( $params );
$db->setQuery('UPDATE #__extensions SET params = ' .
$db->quote( $paramsString ) .
' WHERE name = "com_democompupdate"' );
$db->query();
}
}
}
</source>

== Contributors ==
*[[User:sm990|Kim Eckert]]
*[[User:tapaccos|Alex Tapaccos]]

[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]
[[Category:Component Development]]

Managing Component Updates with Joomla!2.5 - Part 2

2013-05-24T12:03:06Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 2 to J2.5:Managing Component Updates (Manifest file): namespacing for version

#REDIRECT [[J2.5:Managing Component Updates (Manifest file)]]

J2.5:Managing Component Updates (Manifest file)

2013-05-24T12:03:05Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 2 to J2.5:Managing Component Updates (Manifest file): namespacing for version

{{version/tutor|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}

== Manifest File (democompupdate.xml) ==
The manifest file in this example is very similar to that of normal components. Important contents for this example include:

=== sql folder ===
Note the inclusion of the SQL folder in the administration files section. This tells Joomla to copy the contents of this folder to the web site during install or update. The ''schemapath'' declaration below depends on Joomla copying these files during the install or update process.

<source lang="xml">
<administration>
<files folder="admin">
<folder>sql</folder>
</files>
</administration>
</source>

=== name ===
This is the name of the component. The 'getParam($key)' method in the ''script.php'' file uses this value to identify the correct row in the extensions table. The ''manifest_cache'' field in the ''extensions'' table has the version string for the currently installed component.

<source lang="xml">
<name>COM_DEMOCOMPUPDATE</name>
</source>

=== version ===
Joomla stores this value in the ''manifest_cache'' field of the ''extensions'' table. The ''extensions'' table is where the custom code in the ''script.php'' file reads the version string of the currently installed component, and compares it to the version string of the update.

The custom component code uses this comparison to abort an update if the version sequence is not allowed. Joomla also compares this string to the SQL update file names, to determine which SQL commands to execute.

<source lang="xml">
<version>1.0</version>
</source>

=== Joomla version ===
The component developer records in the manifest file the version of Joomla that is required to run the component.
<source lang="xml">
<extension type="component" version="1.6" method="new">
</source>

Your component installation script.php file can use this value to control whether a component installation or update should be allowed or not allowed.

=== schemapath ===
This defines the directory that contains SQL files for component incremental database updates.
You may choose to put the SQL files somewhere else in your component release, but make sure their location is documented here.

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

=== #__schemas table ===
The SQL files have a second function.
In addition to potentially modifying the MySQL database, Joomla uses the names of these SQL files to enable updates to the ''version_id'' field in the ''#__schemas'' table for your component.
It is important to have an SQL file for EVERY version of your component.
The file should be empty if you have no SQL code to execute when updating to that version.
You must have a file or the ''version_id'' will not get updated correctly.
Joomla uses the ''version_id'' in the ''#__schemas'' table as the ''from'' version when calculating updates ''from'' an older version ''to'' a new version.

It is important to include these ''schemapath'' lines in your manifest file, even if you have no SQL commands to execute.
By including these lines and including empty SQL files, the ''version_id'' value will be correctly maintained in the ''#__schemas'' table.

If your new component version is not executing the SQL file as expected, check the ''#__schemas'' table to see if the previous version was correctly recorded.
If it is not, then your update will not execute the SQL file when updating from that version to a newer version.

== The entire manifest file ==
Here is the entire manifest file for democompupdate version 1.0.

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="1.6" method="new">
<name>COM_DEMOCOMPUPDATE</name>
<creationDate>2011 05 11</creationDate>
<author>Your Name Here</author>
<copyright>Free to copy</copyright>
<license>none</license>
<version>1.0</version>
<description>Test the Install and Update Process</description>

<scriptfile>script.php</scriptfile>
<install>
<sql>
<file driver="mysql" charset="utf8">sql/install_data.sql</file>
</sql>
</install>
<uninstall>
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.sql</file>
</sql>
</uninstall>
<update>
<schemas>
<schemapath type="mysql">sql/updates</schemapath>
</schemas>
</update>
<files folder="site">
<filename>democompupdate.php</filename>
<filename>controller.php</filename>
<folder>models</folder>
<folder>views</folder>
</files>
<administration>
<files folder="admin">
<folder>sql</folder>
</files>
</administration>
</extension>
</source>

== Contributors ==
*[[User:sm990|Kim Eckert]]

[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]
[[Category:Component Development]]

J2.5:Managing Component Updates

2013-05-24T12:00:12Z

Hutchy68: fixing move error

{{version/tutor|2.5}}{{Chunk:Managing Component Updates - Contents}}{{review}}
== Intro ==
This component demonstrates how a component developer can use the features in Joomla 1.6 (and higher) to help the web site administrator correctly update the component. Capabilities that are implemented in this demo package include:
# Confirming that the correct version of Joomla is installed before allowing an install or update of the component.
# Confirming that the correct version of the component is installed before allowing an update of the component.
# Controlling the sequence of SQL updates, when the user updates the component over multiple release versions.
# Show where the component developer can create custom code that will execute before and after component install, update, discover_install and uninstall.
# Demonstrate how to create and update component parameters during the component install and update process.

There are two concerns when distributing component updates:
# Making sure that the correct update is selected for installation. This selection depends on the version currently installed, and the desired version following the update. Actions include both selecting appropriate updates and denying inappropriate updates. The update actions may require multiple sequential steps, each implementing a separate set of update commands.
# Ensuring that the updates are correctly installed, and taking the appropriate action if they fail.
Joomla manages much of this process, but depends on the component developer to capture the version dependencies. Additionally, the component may have unique update requirements that need to be enforced.
There are two parts of an install or update.
# Files. During an update, Joomla completely replaces the files of the existing version with the files of the new version. There is no incremental file update inherent in Joomla. The component developer can implement this functionality by creating custom update code, if desired.
# Database. During an update, Joomla can execute SQL commands to incrementally modify the component database. The component developer maintains files with SQL commands that are necessary to modify the database from each older version to a newer version.
After becoming familiar with this example, the component developer should study the Joomla JinstallerComponent source code. This is the best way to become familiar with the sequences and dependencies in the install, update, discover_install and uninstall processes.
The new update methods in Joomla 1.6 give the component developer the ability to implement complex, custom checks, abort conditions and installation sequences.

Parts 2 through 6 of this document describe the various sections of the software that the component developer must create to implement the features described in this document.

== This example ==
Files in this example implement an initial install and two subsequent updates of a component. Included are a minimal front-end to allow the user to observe the results of correct and incorrect updates. There is no component back-end.

This is a simple component. You can implement your custom code here and observe the results prior to implementing it in your component.
This example is for a component. Much of the example applies to other extensions, but those are not described here.

This example was developed on ''Joomla! 1.7.3 Stable''.

=== Version 1.0 ===
This is the initial component version. Joomla will detect that there is no existing component with files in this directory and will use the install function.
If you have a more recent version of this component installed, the custom update code will not allow version 1.0 to be installed. This is not a feature inherent to Joomla. The component developer must implement it in custom code.

=== Version 1.0j3 ===
This is a variation of the initial 1.0 version. It requires that Joomla 3.0 or higher be installed. It is intended that installing this version will fail, showing how this Joomla version check operates.

=== Version 1.1.1 ===
This can be implemented either as an original install or an update from version 1.0. If you do not install version 1.0, then Joomla will use the install function for this version. If you have installed version 1.0, then Joomla will use the update function.
Like the description above for version 1.0, the custom code in this example will not allow an update to 1.1.1 if the existing installed version is 1.3.

=== Version 1.3 ===
Just as in version 1.1.1, this version can be installed as an original install or as an update to an existing version. With this example, you can update to version 1.3 from either the original 1.0 version or from the intermediate 1.1.1 version.

=== Front-end ===
The front-end is a simple display of three fields. The field at the top of the page is a table that shows the contents of the component database. This database is a simple list of major component versions. There is one row in the table for each major version, with the latest installed minor version string stored (and displayed) for each major version. As the administrator updates this component, update SQL modifies the minor version string in the database. This is the display after version 1.3 has been installed or updated.

<blockquote>
<table style='border-style:solid;border-width:thin;padding:1em;'><tr><td>
<table border=1>
<tr style='background-color:#ccccff'><th>Index</th><th>Value</th></tr>
<tr><td>1</td><td>1.1.1</td></tr>
<tr><td>2</td><td>1.2.1</td></tr>
<tr><td>3</td><td>1.3</td></tr>
</table>

Files: 1.3

Param: Component version 1.3
</td></tr></table>
</blockquote>

Below the table is a line of text that shows the release string as defined in the component files. If the sequence of updates is implemented correctly, the release string displayed from the files will match the release string on the last (bottom) row of the table.

At the bottom of the page is a line of text that shows the value of the component parameter ''my_param0''. This parameter is defined in the script.php file during the install or update process. It should match the release string shown in the line above.

The front-end on this example is a convenient way to confirm that the files and the database are synchronized, and that the update process was correctly executed.

== version_compare ==
See PHP documentation: [[php:version_compare]]

Joomla uses the PHP function
<source lang="php">
version_compare( string $version1 , string $version2 [, string $operator ] )
</source>
to determine if any SQL file(s) should be executed on an update, and to determine the order of execution for those files. For this reason, the version string in your manifest file should follow the conventions that this command uses. From the PHP manual:

: The function first replaces _, - and + with a dot . in the version strings and also inserts dots . before and after any non number so that for example '4.3.2RC1' becomes '4.3.2.RC.1'. Then it splits the results like if you were using explode('.', $ver). Then it compares the parts starting from left to right. If a part contains special version strings these are handled in the following order: any string not found in this list < dev < alpha = a < beta = b < RC = rc < # < pl = p. This way not only versions with different levels like '4.1' and '4.1.2' can be compared but also any PHP specific version containing development state.

Use the optional $operator variable to perform a specific version string comparison that your code may require. Allowed values for $operator are:

: <, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=, <>, ne

In the script.php file, the component developer can use the same PHP version_compare function to execute code specific to a version, or to abort the update.

<source lang="php">
if ( $type == 'update' ) {
if ( version_compare( $this->release, $oldRelease, 'le' ) ) {
Jerror::raiseWarning(null, 'Incorrect version sequence. Cannot upgrade ' . $rel);
return false;
}
}
</source>

== Component parameters ==
The ''postflight'' function in the script.php file is a good place to define or update the values of component parameters. This example has a ''setParams'' function for this purpose. Joomla stores the parameters as a JSON string in the ''params'' field in the ''extensions'' table. The ''setParams'' function first converts the existing JSON string to a PHP array. Additions or modifications are made to the array, then it is converted back to a JSON string and written to the ''extensions'' table.
<source lang="php">
function setParams($param_array) {
if ( count($param_array) > 0 ) {
// read the existing component value(s)
$db = JFactory::getDbo();
$db->setQuery('SELECT params FROM #__extensions WHERE name = '.$db->quote('com_democompupdate'));
$params = json_decode( $db->loadResult(), true );
// add the new variable(s) to the existing one(s)
foreach ( $param_array as $name => $value ) {
$params[ (string) $name ] = (string) $value;
}
// store the combined new and existing values back as a JSON string
$paramsString = json_encode( $params );
$db->setQuery('UPDATE #__extensions SET params = ' .
$db->quote( $paramsString ) .
' WHERE name = '.$db->quote('com_democompupdate'));
$db->query();
}
}
</source>

== Component files ==
The install zip fles for the four versions can be individually downloaded from JoomlaCode.org.
* [http://joomlacode.org/gf/download/frsrelease/16495/74511/democompupdate_10.zip democompupdate_10.zip]
* [http://joomlacode.org/gf/download/frsrelease/16495/74512/democompupdate_10j3.zip democompupdate_10j3.zip]
* [http://joomlacode.org/gf/download/frsrelease/16495/74513/democompupdate_111.zip democompupdate_111.zip]
* [http://joomlacode.org/gf/download/frsrelease/16495/74514/democompupdate_13.zip democompupdate_13.zip]

You need to download all four of these to fully exercise the various update features.

== Contributors ==
*[[User:sm990|Kim Eckert]]

<noinclude>
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Development]]
[[Category:Joomla! 2.5]]
</noinclude>

Managing Component Updates with Joomla!2.5 - Part 1

2013-05-24T11:58:51Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 1 to J2.5:Managing Component Updates: namespacing for version

#REDIRECT [[J2.5:Managing Component Updates]]

J2.5:Managing Component Updates

2013-05-24T11:58:51Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 1 to J2.5:Managing Component Updates: namespacing for version

#REDIRECT [[Managing Component Updates]]

J2.5:Managing Component Updates

2013-05-24T11:57:59Z

Hutchy68: Hutchy68 moved page Managing Component Updates with Joomla!2.5 - Part 1 to Managing Component Updates: namespacing for version

#REDIRECT [[Managing Component Updates]]

Component Development/Reading list

2013-05-24T11:55:26Z

Hutchy68: alphabetizing, might not be the best for now, need a way to dpl these, but how to order them

* [[Adding ACL rules to your component]] {{JVer/multi|2.5,3.x}}
* [[Adding AJAX to your component]]
* [[Adding sortable columns to a table in a component]] {{JVer/multi|1.5,2.5,3.x}}
* [[Component Program Flow]]. {{JVer/multi|2.5,3.x}}
:(UML sequence diagrams showing the control flow for a component.)
* [[Creating a file uploader in your component]]
* [[Creating a toolbar for your component]]
* [[Creating Mootools accordion or simple slider/toggler]] {{JVer|2.5}}
* [[Creating PDF views]] {{JVer|2.5}}<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>
* [[Developing a MVC Component|Developing a Model-View-Controller Component]] {{JVer/multi|2.5,3.x}}
* [[File Structure and Naming Conventions]] {{JVer/multi|2.5,3.x}}
* [[How to add breadcrumbs]]
* [[How to add custom filters to components]] {{JVer|2.5}}
* [[How to implement XML-RPC in a component]]
* [[JController and its subclass usage overview]] {{JVer/multi|2.5}}
* [[Portal:Platform|Joomla Platform Portal]] {{JVer|platform}}
* [[Managing Component Updates with Joomla!2.5 - Part 1]] {{JVer/multi|2.5}}
* [[Manifest files]] {{JVer/multi|2.5,3.x}}
:(For the installation of extensions.)
* [[Sending email from extensions]]
* [[Supporting SEF URLs in your component]]
* [[Using a custom image in the menu bar title]]
* [[Using multiple models in an MVC component]]
* [[Using the JHtmlTabs class in a component]] {{JVer/multi|2.5,3.x}}
* [[Using the JToolBar class in the frontend]]
* [[J3.1:Using Tags in an Extension|Using Tags in an Extension]] {{JVer|3.x}}
* [[Xml-rpc changes in Joomla! 2.5]] {{JVer/multi|2.5,3.x}}

User:Hutchy68/example link

2013-05-24T01:18:40Z

Hutchy68: trying something else

==Working Method==

Working out a method to show a hyperlink in a pre style box without creating an actual hyperlink on the page.

<div style="margin:10px 0; width:auto; color:#0b0080; background:#eee; padding:12px; border:1px dashed #2f6fab;"><nowiki>http://www.example.com/index.php?option=com_content&view=article&id=1:welcome-to-joomla&catid=1:latest-news&Itemid=50</nowiki></div>

<div style="margin:10px 0; width:auto; color:#0b0080; background:#eee; padding:12px; border:1px dashed #2f6fab;"><nowiki>{{{1|no hyperlink supplied!}}}</nowiki></div>

User:Hutchy68/example link

2013-05-24T01:15:36Z

Hutchy68: update

User:Hutchy68/example link

2013-05-24T01:11:34Z

Hutchy68: update

User:Hutchy68/example link

2013-05-24T01:05:49Z

Hutchy68: update

==Working Method==

Working out a method to show a hyperlink in a pre style box without creating an actual hyperlink on the page.

<div style="margin:10px 0; width:auto; color:#0b0080; background:#eee; padding:12px; border:1px dashed #2f6fab;"><nowiki>http://www.example.com/index.php?option=com_content&view=article&id=1:welcome-to-joomla&catid=1:latest-news&Itemid=50</nowiki></div>

<div style="margin:10px 0; width:auto; color:#0b0080; background:#eee; padding:12px; border:1px dashed #2f6fab;"><includeonly><nowiki></includeonly>{{{1|no hyperlink supplied!}}}<includeonly></nowiki></includeonly></div>

User:Hutchy68/example link

2013-05-24T01:02:21Z

Hutchy68: example link in a pre wrap

Search Engine Friendly URLs

2013-05-24T00:46:48Z

Hutchy68: format of article, headertabs for readability

=Intro=
<onlyinclude>
'''Search engine friendly (SEF)''', '''human-readable''' or [[wikipedia:Clean_URL|clean URLs]] are URLs that make sense to both humans and search engines because they explain the path to the particular page they point to. Since version 1.5, Joomla! is capable of creating and parsing URLs in any format, including SEF URLs. This does not depend on URL rewriting executed by the web server, so it works even if Joomla! runs a server other than Apache with the mod_rewrite module. The SEF URLs follow a certain fixed pattern, but the user can define a [[Alias|short descriptive text (alias)]] for each segment of the URL.

Internally, the local part of a SEF URL (the part after the domain name) is called a '''route'''. Creating and processing SEF URLs is therefore referred to as '''routing''', and the relevant code is called a '''router'''.
</onlyinclude>
A good example of routing is the URL to "Welcome to Joomla!" article in the sample data.

* Without SEF URLs turned on, the URL is <tt><nowiki>http://www.example.com/index.php?option=com_content&view=article&id=1:welcome-to-joomla&catid=1:latest-news&Itemid=50</nowiki></tt>
* With SEF URLs on and mod_rewrite off, it's <tt><nowiki>http://www.example.com/index.php/the-news/1-latest-news/1-welcome-to-joomla</nowiki></tt>
* With both SEF URLs and mod_rewrite on, it's <tt><nowiki>http://www.example.com/the-news/1-latest-news/1-welcome-to-joomla</nowiki></tt>

Search engine friendly URLs can be activated by turning on the '''Search Engine Friendly URLs''' option in the ''Global Configuration''. This option is on by default since Joomla! 1.6. See [[Enabling Search Engine Friendly (SEF) URLs]] for more information.

= FAQs =

=== What do the numbers in the URL mean? ===
By comparing the old and the new URL we can see numbers in the old URL,

<tt><nowiki>http://www.example.com/index.php?option=com_content&view=article&id=1:welcome-to-joomla&catid=1:latest-news&Itemid=50</nowiki></tt>

but also in the new URL:

<tt><nowiki>http://www.example.com/the-news/1-latest-news/1-welcome-to-joomla</nowiki></tt>

These numbers are the parameters that are needed by Joomla! to get the internal URL and show the page you want to see. (In this case, the first numeral one is the ID of the category, the second numeral one is the ID of the article.)

=== There is no <tt>index.php</tt> in the URL anymore. Can I delete the file now? ===
No! The URL may doesn't contain the <tt>index.php</tt> anymore, but internally the mod_rewrite will only redirect to the original path without showing it to you.

=== What is the [[Alias]] value? And how does it get created? ===
Alias is listed beneath the Title field in Articles, Categories, Sections and Menu Items. Joomla! can automatically create the alias for you. An automatic alias begins with the title. All upper case letters are changed to lower case. Spaces and special characters not allowed in a URL; they are changed to dashes.

=== I want to specify my own value for Alias. ===
If you do not like the alias provided by Joomla!, you can enter a value of your choosing into that field. Many believe using good keywords in your URL helps search engine optimization. You can do so by including those keywords in your title, and allowing Joomla! to create the alias, or by creating the alias yourself.

=== How is Alias used in a URL? ===
For a menu item, Joomla! uses the alias as the URL plug. Assume that you use the first two SEF URL options and you create a menu item called Products. Your URL would be example.com/products.

Joomla! also uses the primary key values of data within the URL to help the router navigate to the correct page. Continuing with the previous example, if your products menu item was for an Article/Category Blog, the link for the Article Title and/or Read More link would have three parts:

* The menu item URL - example.com/products;

* Plus, the primary key for the Category and the Category alias - 32-fruit;

* Plus, the primary key for the Article and the Article alias - 1-apple;

The complete URL is: <tt><nowiki>http://example.com/products/32-fruit/1-apple</nowiki></tt>

=== How can I get rid of the numbers in the SEF URLs? ===
The numbers in the SEF URL are needed by Joomla!'s router to know how to direct site traffic. Once the router logic stabilizes, simple third party system plugins can be developed to augment the router capabilities by allowing more choice. At that time, numbers will likely be removed from the URL.

= Route Formats and the Routing Mechanism =

''This section describes Joomla!'s core (built-in) routing mechanism. Routing extensions may change the way routes are created on your system.''

=== Route Formats ===

To describe the Joomla! routing mechanism in more detail, we first need to pin down what we refer to as a '''route'''. Suppose that Joomla! has been installed in <tt><nowiki>http://example.com/sites/first/</nowiki></tt>. The installation path is generally referred to as the '''base URL'''. A possible example URL is <tt><nowiki>http://example.com/sites/first/products/32-fruit/1-apple</nowiki></tt>. The first part of this URL is the aforementioned base URL, and neither Joomla! nor any component router can create URLs with a different first part. The second part, <tt>products/32-fruit/1-apple</tt>, is a '''route''', consisting of three '''segment'''s.

The first segment of a route is, for regular URLs, the alias of a menu item. The SEF URL is said to be '''routed through''' that menu item. The other segments are determined entirely by the router of the component that provides the type of the menu item. The ''Category - Blog'' menu item type, for example, is provided by the [[Content]] component, and therefore that component's router is responsible for building and parsing the remaining segments.

It is also possible (for extensions) to ask the system to create a route without supplying a menu item to route through. In that case, the system will usually decide to create a special route that has the word <tt>component</tt> as the first segment. These routes are created using a fixed format: the name of the component (without the leading <tt>com_</tt>) is selected as the second segment and any parameters as the other segments.

=== Limitations ===

It is important to note creating a menu item is the ''only'' way for a Joomla! user to define a route that leads to a specific component. It is, however, possible to create a route without showing it on the site (in a menu). An often-applied method is to create a menu item in a menu that isn't displayed anywhere. Such a menu is usually called a [[Menu|hidden menu]].

The previous paragraph implies that it is not possible to make one component responsible for handling all routes. For example, it is not possible to specify that the URL <tt><nowiki>http://example.com/thealias</nowiki></tt> should display the Content item with the alias <tt>thealias</tt>, where <tt>thealias</tt> could be any word. If this needs to be done for a small number of articles, menu items can be created manually for these. Else a routing extension is necessary.

This routing mechanism is therefore not as flexible as users sometimes require. On the other hand, it has one large advantage: it reduces the chance of ambiguous routes (routes that could lead to two different pages). Since the first segment of a route is always a menu item alias, the system immediately knows which component's router must be used to parse it.

= Implementation Details =
=== Handling Routes ===

''This section describes the routing implementation. If you are a component developer, see [[Supporting SEF URLs in your component]].''

Joomla routes are created and resolved by [[JRouter|the JRouter class]]. This class looks in the component root of the currently active component (specified in the <code>option</code> parameter in the query string) and includes the <tt>router.php</tt> file in that component's root directory. It then calls one of two functions: one for creating the SEF URL and one for interpreting the SEF URL.

The JRouter class is overridden by the Joomla CMS in <tt>/includes/router.php</tt>. In this file the build and parse functions are overridden to properly build and parse the URLs for the Joomla CMS.

The <tt>router.php</tt> file in each component (for example, <tt>/components/com_content/router.php</tt>) should contain the following two functions:
* ContentBuildRoute - this builds the SEF URL
** Parameters
*** $query - this is a named array containing the querystring variables
** Returns: an array of segments where each segment is separated by a '/' when later combined to create the actual URL (the items in the array should not contain '/' characters)
* ContentParseRoute - this interprets an SEF URL
** Parameters
*** $segments - this is an array that contains the segments of the URL requested.
** Returns: a name => value array of the querystring variables that the link maps to

=== The SEF Plugin ===
The Joomla ''System - SEF'' plugin inherits <code>JPlugin</code> and implements the <code>onAfterRender()</code> function. In this function the body of the response that will be sent to the browser is retrieved using <code>JResponse::getBody()</code>. The body of the response is then searched for links containing <tt>/index.php...</tt> and replaces them with a correct SEF URL by calling <code>JRoute::_(''url'')</code>.

JRoute builds SEF URLs by instantiating a <code>JRouter</code> object and requesting that it build the correct link from the passed in URL.

=== Handling SEF URLs ===
By default the SEF URLs are handled by the <code>JRouterSite</code> object (from <tt>/includes/router.php</tt>) and is called by a call to <code>JApplication::route()</code> in index.php. This call is made on the <code>$app</code> variable which is actually an instance of <code>JSite</code> (from <tt>/includes/application.php</tt>).

<code>JApplication::route()</code> has a non-destructive result on the <code>$_GET</code> array. That is, <code>JApplication::route()</code> sets variables in <code>$_GET</code> by calling <code>JRequest::set()</code> with the overwrite flag set to false. Thus if a variable name is returned from <code>JRouter::route()</code> that is already in <code>$_GET</code>, it will not put that value into <code>$_GET</code>. This allows for custom routing.

=== Custom Routing ===
Joomla allows you to create your own routing mechanism. In order to create this mechanism you must have a plugin that overrides the <code>JPlugin::onAfterInitialise()</code> function. This function then parses the URL and creates the needed variables in <code>$_GET</code> before the standard Joomla routing is done.

''See [[Creating a System Plugin to augment JRouter]] for an example.''
<headertabs/>
[[Category:Search Engine Friendly URLs| ]]

Component Development/Reading list

2013-05-24T00:41:22Z

Hutchy68: version icon added

* [[Portal:Platform|Joomla Platform Portal]] {{JVer|platform}}
* [[File Structure and Naming Conventions]] {{JVer/multi|2.5,3.x}}
* [[Component Program Flow]]. {{JVer/multi|2.5,3.x}}
:(UML sequence diagrams showing the control flow for a component.)
* [[Developing a MVC Component|Developing a Model-View-Controller Component]] {{JVer/multi|2.5,3.x}}
* [[Manifest files]] {{JVer/multi|2.5,3.x}}
:(For the installation of extensions.)
* [[Adding sortable columns to a table in a component]] {{JVer/multi|1.5,2.5,3.x}}
* [[How to add custom filters to components]] {{JVer|2.5}}
* [[Supporting SEF URLs in your component]]
* [[Using the JHtmlTabs class in a component]] {{JVer/multi|2.5,3.x}}
* [[Adding AJAX to your component]]
* [[How to add breadcrumbs]]
* [[Sending email from extensions]]
* [[Using the JToolBar class in the frontend]]
* [[Creating a toolbar for your component]]
* [[Creating a file uploader in your component]]
* [[Creating Mootools accordion or simple slider/toggler]] {{JVer|2.5}}
* [[Using a custom image in the menu bar title]]
* [[How to implement XML-RPC in a component]]
* [[Using multiple models in an MVC component]]
* [[Adding ACL rules to your component]] {{JVer/multi|2.5,3.x}}
* [[JController and its subclass usage overview]] {{JVer/multi|2.5}}
* [[Managing Component Updates with Joomla!2.5 - Part 1]] {{JVer/multi|2.5}}
* [[Xml-rpc changes in Joomla! 2.5]] {{JVer/multi|2.5,3.x}}
* [[Creating PDF views]] {{JVer|2.5}}<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>
* [[J3.1:Using Tags in an Extension|Using Tags in an Extension]] {{JVer|3.x}}

Creating Mootools accordion or simple slider/toggler

2013-05-24T00:39:54Z

Hutchy68: Hutchy68 moved page Creating Mootools accordion or simple slider/toggler to J2.5:Creating Mootools accordion or simple slider/toggler: namespacing for version

#REDIRECT [[J2.5:Creating Mootools accordion or simple slider/toggler]]

J2.5:Creating Mootools accordion or simple slider/toggler

2013-05-24T00:39:54Z

Hutchy68: Hutchy68 moved page Creating Mootools accordion or simple slider/toggler to J2.5:Creating Mootools accordion or simple slider/toggler: namespacing for version

{{version/tutor|2.5|platform=11.1|target=from}}
{{review}}
Simple example to create a simple accordion. Can also be used to make a simple slide-toggler (just use 1 link).
In this example all the accordions (slider) are closed by default.

''The php code (e.g. inside template):''<source lang="php">
//Add Slide/toggle behavior
JHTML::_('behavior.framework',true);
$this->document->addScriptDeclaration('
window.addEvent("domready", function( ){
navAcc = new Accordion( $$( ".accordion .accT" ), $$( ".accordion .accE" ), {display: -1, alwaysHide: true} );
});
</source>
''Your html should look like this:''<source lang="html4strict">
<div class="accordion">
<a class="accT">Link 1</a>
<div class="accE">Container 1</div>
<a class="accT">Link 1</a>
<div class="accE">Container 2</div>
<a class="accT">Link 1</a>
<div class="accE">Container 3</div>
</div>
</source>

[[Category:Development‏‎]] [[Category:mootools]] [[Category:javascript]]

Component Development/Reading list

2013-05-23T19:09:01Z

Hutchy68: removing 1.5 only article, article has been archived

* [[Portal:Platform|Joomla Platform Portal]] {{JVer|platform}}
* [[File Structure and Naming Conventions]] {{JVer/multi|2.5,3.x}}
* [[Component Program Flow]]. {{JVer/multi|2.5,3.x}}
:(UML sequence diagrams showing the control flow for a component.)
* [[Developing a MVC Component|Developing a Model-View-Controller Component]] {{JVer/multi|2.5,3.x}}
* [[Manifest files]] {{JVer/multi|2.5,3.x}}
:(For the installation of extensions.)
* [[Adding sortable columns to a table in a component]] {{JVer/multi|1.5,2.5,3.x}}
* [[How to add custom filters to components]] {{JVer|2.5}}
* [[Supporting SEF URLs in your component]]
* [[Using the JHtmlTabs class in a component]] {{JVer/multi|2.5,3.x}}
* [[Adding AJAX to your component]]
* [[How to add breadcrumbs]]
* [[Sending email from extensions]]
* [[Using the JToolBar class in the frontend]]
* [[Creating a toolbar for your component]]
* [[Creating a file uploader in your component]]
* [[Creating Mootools accordion or simple slider/toggler]]
* [[Using a custom image in the menu bar title]]
* [[How to implement XML-RPC in a component]]
* [[Using multiple models in an MVC component]]
* [[Adding ACL rules to your component]] {{JVer/multi|2.5,3.x}}
* [[JController and its subclass usage overview]] {{JVer/multi|2.5}}
* [[Managing Component Updates with Joomla!2.5 - Part 1]] {{JVer/multi|2.5}}
* [[Xml-rpc changes in Joomla! 2.5]] {{JVer/multi|2.5,3.x}}
* [[Creating PDF views]] {{JVer|2.5}}<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>
* [[J3.1:Using Tags in an Extension|Using Tags in an Extension]] {{JVer|3.x}}

J1.5:Adding view layout configuration parameters

2013-05-23T19:08:17Z

Hutchy68: −Category:Component Development; −Category:Parameters; −Category:Tutorials; +Category:Archived version Joomla! 1.5 using HotCat

==Background==
When creating views for a custom component, you can create a series of .xml files that will both describe the view and allow administrators to configure the view as they require. The .xml files are used by the com_menu core component (ilink.php) to create the menu trees that are shown when an administrator creates a new menu item.

==View title and description==
First give a title and description to your view. This is done by including a metadata.xml file in the view directory:

<source lang="xml"><?xml version="1.0" encoding="utf-8"?>
<metadata>
<view title="CAST_VIEW">
<message><![CDATA[CAST_VIEW_DESC]]></message>
</view>
</metadata>
</source>

The 'title' element is shown as the 1st level entry under your component name when a new menu item is created. The 'message' element is the descriptive tool tip that is shown when the mouse hovers over the 'title' element. The example is using JText placeholders for the title and message. Just add the corresponding tags to your language definition files. You did create them didn't you?

====Hiding a view from the menu====
If you don't want this view to be selectable for a new menu item, then add the hidden="true" parameter to the view element (e.g. <view title="CAST_VIEW" hidden="true">). You can also hide a view by using an underscore '_' in the name. Be careful with naming your views or you can spend hours trying to figure out why it doesn't appear in the new menu item tree!

==Template names, description, parameters==
You can also create .xml files for the individual files in the tmpl folders. This is a cool way to have a name other than 'default' show up in the new menu item tree.
Make sure that the name of the .xml file is the same as the name of your template file. I.E. if your file name is default.php, then your xml file name is default.xml. Its probably more productive to name your template files something other than default. That way, when you have 10 of them open in your favorite IDE, you won't get totally confused as to which file you are editing. That also avoids the nightmare of uploading the wrong file to the wrong directory!

These will also be hidden by including an underscore '_' in their name. This is a bit of a gotcha. Also ensure the filenames for these and the layotus are in lower case. CamelCase does not work for these.

Note: To use a temp/layout file name other than 'default', pass a configuration array to the __construct function parent in the view.html file. EG:
<source lang="php">
function __construct() {
$config = array();
$config['layout'] = 'bookslayout';
parent::__construct($config);
}
</source>

The .xml file for the template can be very simple with just a title and message or very complex with basic and/or advanced parameters:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<metadata>
<layout title="STANDARD_CATEGORY_LAYOUT">
<message>
<![CDATA[STANDARD_CATEGORY_LAYOUT DESC]]>
</message>
</layout>
<state>
<name>STANDARD_CATEGORY_LAYOUT</name>
<description>STANDARD_CATEGORY_LAYOUT_DESC</description>
<url>
</url>
<params>
</params>
<advanced>
</advanced>
</state>
</metadata>
</source>

See components\com_content\views\frontpage\tmpl\default.xml, or components\com_content\views\section\tmpl\default.xml for examples of how to specify both basic and advanced parameters for your views. See also [[J1.5:Standard parameter types|J1.5:Standard parameter types]] for information on defining parameters.

You can also add the hidden="true" to the layout element if you don't want this particular template file to be selected as a new menu item.

==Final touches==
Remember to create JText language definitions for your titles and messages so they can be easily translated. Have fun giving your views cool names and descriptions for that final bit of polish on your custom component!

[[Category:Archived version Joomla! 1.5]]

J1.5:Adding view layout configuration parameters

2013-05-23T19:07:52Z

Hutchy68: /* See Also */ removing link to stub article

Adding view layout configuration parameters

2013-05-23T19:03:01Z

Hutchy68: Hutchy68 moved page Adding view layout configuration parameters to J1.5:Adding view layout configuration parameters: namespacing for archiving

#REDIRECT [[J1.5:Adding view layout configuration parameters]]

J1.5:Adding view layout configuration parameters

2013-05-23T19:03:01Z

Hutchy68: Hutchy68 moved page Adding view layout configuration parameters to J1.5:Adding view layout configuration parameters: namespacing for archiving

J1.5:Adding view layout configuration parameters

2013-05-23T19:02:32Z

Hutchy68: /* Template names, description, parameters */ preparing to archive

Component Development/Reading list

2013-05-23T18:59:57Z

Hutchy68: removing 1.5 only article

* [[Portal:Platform|Joomla Platform Portal]] {{JVer|platform}}
* [[File Structure and Naming Conventions]] {{JVer/multi|2.5,3.x}}
* [[Component Program Flow]]. {{JVer/multi|2.5,3.x}}
:(UML sequence diagrams showing the control flow for a component.)
* [[Developing a MVC Component|Developing a Model-View-Controller Component]] {{JVer/multi|2.5,3.x}}
* [[Manifest files]] {{JVer/multi|2.5,3.x}}
:(For the installation of extensions.)
* [[Adding sortable columns to a table in a component]] {{JVer/multi|1.5,2.5,3.x}}
* [[How to add custom filters to components]] {{JVer|2.5}}
* [[Supporting SEF URLs in your component]]
* [[Using the JHtmlTabs class in a component]] {{JVer/multi|2.5,3.x}}
* [[Adding AJAX to your component]]
* [[How to add breadcrumbs]]
* [[Sending email from extensions]]
* [[Using the JToolBar class in the frontend]]
* [[Creating a toolbar for your component]]
* [[Creating a file uploader in your component]]
* [[Creating Mootools accordion or simple slider/toggler]]
* [[Adding view layout configuration parameters]]
* [[Using a custom image in the menu bar title]]
* [[How to implement XML-RPC in a component]]
* [[Using multiple models in an MVC component]]
* [[Adding ACL rules to your component]] {{JVer/multi|2.5,3.x}}
* [[JController and its subclass usage overview]] {{JVer/multi|2.5}}
* [[Managing Component Updates with Joomla!2.5 - Part 1]] {{JVer/multi|2.5}}
* [[Xml-rpc changes in Joomla! 2.5]] {{JVer/multi|2.5,3.x}}
* [[Creating PDF views]] {{JVer|2.5}}<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>
* [[J3.1:Using Tags in an Extension|Using Tags in an Extension]] {{JVer|3.x}}

J1.5:Using the editor in a component

2013-05-23T18:59:22Z

Hutchy68: −Category:Development; −Category:Component Development; −Category:Tutorials; +Category:Archived version Joomla! 1.5 using HotCat

{{version/tutor|1.5}}
{{notice|This article applies to Joomla! 1.5 only as Joomla! 1.6 uses [[Form_field|Form Fields]].}}

== Introduction ==
To get some interaction with the visitors of your website your visitors need to be able to add some content.

This article will show you how visitors can add some data using a rich text editor.

Lets start with the component created in the article [[Developing_a_Model-View-Controller_Component/1.5/Creating_an_Administrator_Interface|Joomla 1.5 Component Development Tutorial: Part 4]] which lets the administrator add new entries to the database.
The component can be downloaded at: [http://joomlacode.org/gf/download/frsrelease/8111/29436/com_hello4_01.zip com_hello4_01]. If you haven't done already, install this component on your developing website and create a menu link to this component.

== Expand the data model ==

The model used in the tutorial can only hold a text of 25 characters. Lets add a new field which can be used to hold a lot more text, so we can save the editor contents.

Use your favorite tool to access the php database and open the jos_hello tabel in your joomla database. Add a new field to this table and add some intial text into it by running this SQL statement:

<source lang="sql">ALTER TABLE `jos_hello` ADD `content` TEXT NOT NULL ;
UPDATE jos_hello SET content = '<p>The A "hello world" program is a computer program that prints out "Hello, world!"
on a display device. It is used in many introductory tutorials for teaching a programming language. Such a program is typically one
of the simplest programs possible in a computer language. Some are surprisingly complex, especially in some graphical user interface (GUI)
contexts, but most are very simple, especially those which rely heavily on a particular command line interpreter ("shell") to perform the
actual output. In many embedded systems, the text may be sent to a one or two-line liquid crystal display (LCD), or some other appropriate
signal, such as a LED being turned on, may substitute for the message.<p>' WHERE `jos_hello`.`id` = 1</source>

We have to change the table definition accordingly. Open the table definition stored in the file administrator/components/com_hello/tables/hello.php and add the new field as a variable below the current ones:
<source lang="php">var $greeting = null;
var $content = null;
</source>

== Show the new field on the front end ==

To show the new content we must:
* Change the model to read the field from the database
* Change the view to pass the value of the field into the template
* Change the template to actually show the text

The model was stored in the file: components/com_hello/models/hello.php<br />
We must change the query to get the new field from the database. The loadResult method only retrieves the first field of the record, so we change this in loadObject to get the data into an object.
Our new getGreeting() method will therefore look like:

<source lang="php">function getGreeting()
{
$db = JFactory::getDBO();

$query = 'SELECT * FROM #__hello';
$db->setQuery( $query );
$greeting = $db->loadObject();

return $greeting;
}</source>

The view was stored in the file: components/com_hello/views/hello/view.html.php<br />
As a reminder: The view pulls the data from the model and fees the data into the template<br />
Because the output of the model is now an object instead of just text, we change the line which assigns the greeting to the template to only assign the greeting text of the object. We add similars line to assign the id and content to the template.
<source lang="php">function display($tpl = null)
{
$greeting = $this->get( 'Greeting' );
$this->assignRef( 'greeting', $greeting->greeting );
$this->assignRef( 'id', $greeting->id );
$this->assignRef( 'content', $greeting->content );

parent::display($tpl);
}</source>

Finally we will change the template in components/com_hello/views/hello/tmpl/default.php to become:
<source lang="php"><?php // no direct access
defined('_JEXEC') or die('Restricted access'); ?>
<h1><?php echo $this->greeting; ?></h1>
<?php echo $this->content; ?></source>

You can now refresh your frontend site and you should see the added content.

== Edit form ==

To edit the current record we must:
* Add a link to the edit form
* Add a new template to edit the data
* Save the data

Creating a link to the edit form can be done in the template directly. But to keep the template nice and simple we will build the link in the view and pass in onto the template for displaying. Add this line to the view:
<source lang="php">$this->assignRef( 'editlink', JRoute::_('index.php?option=com_hello&view=hello&task=edit') );</source>
And add these lines to the template:
<source lang="php"><br /><br />
<a href="<?php echo $this->editlink; ?>">Edit</a></source>

If your template doesn't already include a reference to the library includes/js/joomla.javascript.js it has to be included at this moment. This can be done by adding the following two lines to view.html.php.

<source lang="php">
$document = JFactory::getDocument();
$document->addScript('includes/js/joomla.javascript.js');
</source>

The ''task=edit'' in the url triggers the edit function in the controller. So let's add this method to our controller:
<source lang="php">/**
* Method to call the edit form
*/
function edit()
{
JRequest::setVar( 'layout', 'form' );
parent::display();
}</source>
Before adding the model to the view, we change the layout to our edit form.

Of course we have to provide this form. Create the file components/com_hello/views/hello/tmpl/form.php:
<source lang="php"><?php defined('_JEXEC') or die('Restricted access'); ?>

<form action="index.php" method="post" name="adminForm" id="adminForm">
<div class="col100">
<fieldset class="adminform">
<legend><?php echo JText::_( 'Details' ); ?></legend>

<table class="admintable">
<tr>
<td width="100" align="right" class="key">
<label for="greeting">
<?php echo JText::_( 'Greeting' ); ?>:
</label>
</td>
<td>
<input class="text_area" type="text" name="greeting" id="greeting" size="25" maxlength="25" value="<?php echo $this->greeting;?>" />
</td>
</tr>
<tr>
<td width="100" align="right" class="key">
<label for="content">
<?php echo JText::_( 'Content' ); ?>:
</label>
</td>
<td>
<?php
$editor = JFactory::getEditor();
echo $editor->display('content', $this->content, '550', '400', '60', '20', false);
?>
</td>
</tr>
</table>
</fieldset>
</div>
<div class="clr"></div>

<input type="hidden" name="option" value="com_hello" />
<input type="hidden" name="id" value="<?php echo $this->id; ?>" />
<input type="hidden" name="task" value="save" />
<input type="hidden" name="controller" value="" />
</form>
</source>
Most of this is just like the form of the backend. The important addition in this form is how we call the editor:
<source lang="php">$editor = JFactory::getEditor();
echo $editor->display('content', $this->content, '550', '400', '60', '20', false);
</source>
The parameters of the display method are:
* string $name: The control name
* string $html: The contents of the text area
* string $width: The width of the text area (px or %)
* string $height: The height of the text area (px or %)
* int $col: The number of columns for the textarea
* int $row: The number of rows for the textarea
* boolean $buttons: True and the editor buttons will be displayed
* array $params: Associative array of editor parameters

Refresh your browser and the edit link will show. Use the link to open the edit form including the editor.

== Save the data ==

Next we need to add the save and cancel buttons and for some extra security we add a token to the form.
<source lang="php"><?php echo JHTML::_( 'form.token' ); ?>
<button type="button" onclick="submitbutton('save')"><?php echo JText::_('Save') ?></button>
<button type="button" onclick="submitbutton('cancel')"><?php echo JText::_('Cancel') ?></button>
</source>

The buttons call some javascript which is added on the top of the form file after the first line:
<source lang="javascript"><script language="javascript" type="text/javascript">

</script>
</source>

On the form we added the hidden field task with a value of save. This will trigger the save method inside the controller. So lets create this method:
<source lang="php">function save()
{
// Check for request forgeries
JRequest::checkToken() or jexit( 'Invalid Token' );

// get the model
$model = $this->getModel();

//get data from request
$post = JRequest::get('post');
$post['content'] = JRequest::getVar('content', '', 'post', 'string', JREQUEST_ALLOWRAW);

// let the model save it
if ($model->store($post)) {
$message = JText::_('Success');
} else {
$message = JText::_('Error while saving');
$message .= ' ['.$model->getError().'] ';
}
$this->setRedirect('index.php?option=com_hello', $message);
}</source>
The standard way of getting the form data ''$post = JRequest::get('post');'' is not enough in the case of using a editor. This will filter the content, hence losing line breaks and paragraps. So we add an extra line to get the editor contents in a raw unfiltered way. This data will be passed to the model to save into the database.

The store method in the model is now straightforward:
<source lang="php">function store($data)
{
// get the table
$row = $this->getTable();

// Bind the form fields to the hello table
if (!$row->bind($data)) {
$this->setError($this->_db->getErrorMsg());
return false;
}

// Make sure the hello record is valid
if (!$row->check()) {
$this->setError($this->_db->getErrorMsg());
return false;
}

// Store the web link table to the database
if (!$row->store()) {
$this->setError( $row->getErrorMsg() );
return false;
}

return true;
}</source>

Now try this on your website. You should be able to change the greeting and the contents.

== Download ==
The component can be downloaded from: [http://help.joomla.org/files/com_hello5_01.zip]

<noinclude> </noinclude>

[[Category:Archived version Joomla! 1.5]]

Talk:Using the editor in a component

2013-05-23T18:58:36Z

Hutchy68: Hutchy68 moved page Talk:Using the editor in a component to J1.5 talk:Using the editor in a component: namespacing

#REDIRECT [[J1.5 talk:Using the editor in a component]]

J1.5 talk:Using the editor in a component

2013-05-23T18:58:36Z

Hutchy68: Hutchy68 moved page Talk:Using the editor in a component to J1.5 talk:Using the editor in a component: namespacing

I used a test site and implemented the editor in the frontend. The edit and display functions worked fine however the Save and Cancel do not execute anything. The Save and Cancel buttons that have been added to the form call a javascript function submitbutton. The submitbutton is executed however the documentation states that the editor's save method will trigger the save function in the controller which in turn calls the model's store method. This is not actually true. I am new to Joomla development so I thought maybe I typed it in wrong so I downloaded the completed example and it does not work either. The editor's save method does not trigger the controller which I believe is necessary. SO I think in order to make it work you need to trigger the controller directly from the button and bypass the javascript -submitbutton. I haven't tried it yet so if there any other suggestions. That would be great.

== The tutorial is not complete ==

Well what is happening is the following. The person who wrote the tutorial forgot one thing.

In order to use the proposed javascripts the library file /includes/js/joomla.javascript.js had to be included. This is standard in de Joomla backend but not in many frontend templates.

You have to manually add the following. This can for example be done view.html.php
$document =& JFactory::getDocument();
$document->addScript('includes/js/joomla.javascript.js');

I have modified the tutorial but I at this point I don't know how to replace the included download files.

== Possible Problems/Pitfalls ==
When following this HowTo, I encountered these problems:
* The string "description" for one reason or the other doesn't seem to work as editor name. In the javascript created by the editor component for saving the editor content, using "description" leads to a javascript error (tinymce.get('description') is undefined). Another, (shorter?) name (desc) worked fine. I didn't check whether it was the length, or if the string itself has some significance...
* The user I tried it with first had CodeMirror configured as its default editor; with that it didn't work, I wrote about what the result looks like here (http://forum.joomla.org/viewtopic.php?f=620&t=644689&p=2604202#p2604202)
* My component is running under Joomla 1.7, here the script (includes/js/joomla.javascript.js) include doesn't seem to be necessary anymore
* The input filtering stuff doesn't work the way I expected; when doing the following, the database afterwards still holds an encoded string (e.g. > for >), instead of the "raw" html string, meaning I have to convert it back when displaying it (funnily enough I can just pass that string to the editor and it will show it formatted again, so it seems to do the back-converting by itself)
$post['content'] = JRequest::getVar('content', '', 'post', 'string', JREQUEST_ALLOWRAW);
[[User:Munchkin|Munchkin]] 07:25, 2 September 2011 (CDT)

Using the editor in a component

2013-05-23T18:58:35Z

Hutchy68: Hutchy68 moved page Using the editor in a component to J1.5:Using the editor in a component: namespacing

#REDIRECT [[J1.5:Using the editor in a component]]

J1.5:Using the editor in a component

2013-05-23T18:58:35Z

Hutchy68: Hutchy68 moved page Using the editor in a component to J1.5:Using the editor in a component: namespacing

{{version/tutor|1.5}}
{{notice|This article applies to Joomla! 1.5 only as Joomla! 1.6 uses [[Form_field|Form Fields]].}}

== Introduction ==
To get some interaction with the visitors of your website your visitors need to be able to add some content.

This article will show you how visitors can add some data using a rich text editor.

Lets start with the component created in the article [[Developing_a_Model-View-Controller_Component/1.5/Creating_an_Administrator_Interface|Joomla 1.5 Component Development Tutorial: Part 4]] which lets the administrator add new entries to the database.
The component can be downloaded at: [http://joomlacode.org/gf/download/frsrelease/8111/29436/com_hello4_01.zip com_hello4_01]. If you haven't done already, install this component on your developing website and create a menu link to this component.

== Expand the data model ==

The model used in the tutorial can only hold a text of 25 characters. Lets add a new field which can be used to hold a lot more text, so we can save the editor contents.

Use your favorite tool to access the php database and open the jos_hello tabel in your joomla database. Add a new field to this table and add some intial text into it by running this SQL statement:

<source lang="sql">ALTER TABLE `jos_hello` ADD `content` TEXT NOT NULL ;
UPDATE jos_hello SET content = '<p>The A "hello world" program is a computer program that prints out "Hello, world!"
on a display device. It is used in many introductory tutorials for teaching a programming language. Such a program is typically one
of the simplest programs possible in a computer language. Some are surprisingly complex, especially in some graphical user interface (GUI)
contexts, but most are very simple, especially those which rely heavily on a particular command line interpreter ("shell") to perform the
actual output. In many embedded systems, the text may be sent to a one or two-line liquid crystal display (LCD), or some other appropriate
signal, such as a LED being turned on, may substitute for the message.<p>' WHERE `jos_hello`.`id` = 1</source>

We have to change the table definition accordingly. Open the table definition stored in the file administrator/components/com_hello/tables/hello.php and add the new field as a variable below the current ones:
<source lang="php">var $greeting = null;
var $content = null;
</source>

== Show the new field on the front end ==

To show the new content we must:
* Change the model to read the field from the database
* Change the view to pass the value of the field into the template
* Change the template to actually show the text

The model was stored in the file: components/com_hello/models/hello.php<br />
We must change the query to get the new field from the database. The loadResult method only retrieves the first field of the record, so we change this in loadObject to get the data into an object.
Our new getGreeting() method will therefore look like:

<source lang="php">function getGreeting()
{
$db = JFactory::getDBO();

$query = 'SELECT * FROM #__hello';
$db->setQuery( $query );
$greeting = $db->loadObject();

return $greeting;
}</source>

The view was stored in the file: components/com_hello/views/hello/view.html.php<br />
As a reminder: The view pulls the data from the model and fees the data into the template<br />
Because the output of the model is now an object instead of just text, we change the line which assigns the greeting to the template to only assign the greeting text of the object. We add similars line to assign the id and content to the template.
<source lang="php">function display($tpl = null)
{
$greeting = $this->get( 'Greeting' );
$this->assignRef( 'greeting', $greeting->greeting );
$this->assignRef( 'id', $greeting->id );
$this->assignRef( 'content', $greeting->content );

parent::display($tpl);
}</source>

Finally we will change the template in components/com_hello/views/hello/tmpl/default.php to become:
<source lang="php"><?php // no direct access
defined('_JEXEC') or die('Restricted access'); ?>
<h1><?php echo $this->greeting; ?></h1>
<?php echo $this->content; ?></source>

You can now refresh your frontend site and you should see the added content.

== Edit form ==

To edit the current record we must:
* Add a link to the edit form
* Add a new template to edit the data
* Save the data

Creating a link to the edit form can be done in the template directly. But to keep the template nice and simple we will build the link in the view and pass in onto the template for displaying. Add this line to the view:
<source lang="php">$this->assignRef( 'editlink', JRoute::_('index.php?option=com_hello&view=hello&task=edit') );</source>
And add these lines to the template:
<source lang="php"><br /><br />
<a href="<?php echo $this->editlink; ?>">Edit</a></source>

If your template doesn't already include a reference to the library includes/js/joomla.javascript.js it has to be included at this moment. This can be done by adding the following two lines to view.html.php.

<source lang="php">
$document = JFactory::getDocument();
$document->addScript('includes/js/joomla.javascript.js');
</source>

The ''task=edit'' in the url triggers the edit function in the controller. So let's add this method to our controller:
<source lang="php">/**
* Method to call the edit form
*/
function edit()
{
JRequest::setVar( 'layout', 'form' );
parent::display();
}</source>
Before adding the model to the view, we change the layout to our edit form.

Of course we have to provide this form. Create the file components/com_hello/views/hello/tmpl/form.php:
<source lang="php"><?php defined('_JEXEC') or die('Restricted access'); ?>

<form action="index.php" method="post" name="adminForm" id="adminForm">
<div class="col100">
<fieldset class="adminform">
<legend><?php echo JText::_( 'Details' ); ?></legend>

<table class="admintable">
<tr>
<td width="100" align="right" class="key">
<label for="greeting">
<?php echo JText::_( 'Greeting' ); ?>:
</label>
</td>
<td>
<input class="text_area" type="text" name="greeting" id="greeting" size="25" maxlength="25" value="<?php echo $this->greeting;?>" />
</td>
</tr>
<tr>
<td width="100" align="right" class="key">
<label for="content">
<?php echo JText::_( 'Content' ); ?>:
</label>
</td>
<td>
<?php
$editor = JFactory::getEditor();
echo $editor->display('content', $this->content, '550', '400', '60', '20', false);
?>
</td>
</tr>
</table>
</fieldset>
</div>
<div class="clr"></div>

<input type="hidden" name="option" value="com_hello" />
<input type="hidden" name="id" value="<?php echo $this->id; ?>" />
<input type="hidden" name="task" value="save" />
<input type="hidden" name="controller" value="" />
</form>
</source>
Most of this is just like the form of the backend. The important addition in this form is how we call the editor:
<source lang="php">$editor = JFactory::getEditor();
echo $editor->display('content', $this->content, '550', '400', '60', '20', false);
</source>
The parameters of the display method are:
* string $name: The control name
* string $html: The contents of the text area
* string $width: The width of the text area (px or %)
* string $height: The height of the text area (px or %)
* int $col: The number of columns for the textarea
* int $row: The number of rows for the textarea
* boolean $buttons: True and the editor buttons will be displayed
* array $params: Associative array of editor parameters

Refresh your browser and the edit link will show. Use the link to open the edit form including the editor.

== Save the data ==

Next we need to add the save and cancel buttons and for some extra security we add a token to the form.
<source lang="php"><?php echo JHTML::_( 'form.token' ); ?>
<button type="button" onclick="submitbutton('save')"><?php echo JText::_('Save') ?></button>
<button type="button" onclick="submitbutton('cancel')"><?php echo JText::_('Cancel') ?></button>
</source>

The buttons call some javascript which is added on the top of the form file after the first line:
<source lang="javascript"><script language="javascript" type="text/javascript">

</script>
</source>

On the form we added the hidden field task with a value of save. This will trigger the save method inside the controller. So lets create this method:
<source lang="php">function save()
{
// Check for request forgeries
JRequest::checkToken() or jexit( 'Invalid Token' );

// get the model
$model = $this->getModel();

//get data from request
$post = JRequest::get('post');
$post['content'] = JRequest::getVar('content', '', 'post', 'string', JREQUEST_ALLOWRAW);

// let the model save it
if ($model->store($post)) {
$message = JText::_('Success');
} else {
$message = JText::_('Error while saving');
$message .= ' ['.$model->getError().'] ';
}
$this->setRedirect('index.php?option=com_hello', $message);
}</source>
The standard way of getting the form data ''$post = JRequest::get('post');'' is not enough in the case of using a editor. This will filter the content, hence losing line breaks and paragraps. So we add an extra line to get the editor contents in a raw unfiltered way. This data will be passed to the model to save into the database.

The store method in the model is now straightforward:
<source lang="php">function store($data)
{
// get the table
$row = $this->getTable();

// Bind the form fields to the hello table
if (!$row->bind($data)) {
$this->setError($this->_db->getErrorMsg());
return false;
}

// Make sure the hello record is valid
if (!$row->check()) {
$this->setError($this->_db->getErrorMsg());
return false;
}

// Store the web link table to the database
if (!$row->store()) {
$this->setError( $row->getErrorMsg() );
return false;
}

return true;
}</source>

Now try this on your website. You should be able to change the greeting and the contents.

== Download ==
The component can be downloaded from: [http://help.joomla.org/files/com_hello5_01.zip]

<noinclude>[[Category:Development]][[Category:Component Development]][[Category:Tutorials]]</noinclude>

Joomla Ant build files

2013-05-23T12:10:48Z

Hutchy68: added Category:Development using HotCat

== Introduction ==

When software projects become large its is often helpful for developers to create build or make file that assists the developer to quickly "compile" new code. Although designed for Java the Apache Ant system can be used to create build files for Joomla developers, it is especially useful because it is installed by default in Eclipse, which is an IDE often used by Joomla! extension developers. Creating an Ant build file for your projects will greatly expedite the following frequent tasks.

==== Common tasks that can be scripted by an Ant build file ====
#Creating accurate xml manifest file lists
#Generating new Joomla install archives
#Updating development/debug server files
#Uploading new archives to release sites

== Installing Ant ==
Ant is high portable software and can be installed on most systems. Please follow the instructions on the Apache Ant homepage. As mentioned previously if you are working in Eclipse Ant is installed by default.

For those who have Eclipse PDT Ganymede without ANT, should download the Java Development Tools (JDT) plugin. The JDT plugin could be downloaded by clicking Help > Software Updates > Ganymede Update Site > Java Development > Eclipse Java Development Tool and then Install button at right hand. Once its downloaded, restart Eclipse and then verify if ANT is properly installed by clicking Window > Preferences. If you see ANT (under General), it means ANT is successfully installed over Eclipse.

If Eclipse complain something like "No grammar constraints (DTD or XML schema) detected for the document.", then you will need to add minimal DTD. For example; <!DOCTYPE project> [http://stackoverflow.com/questions/363768/disable-dtd-warning-for-ant-scripts-in-eclipse/483260#483260 reference]

== Example Build Files ==
=== Example 1 ===
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<project name="uncleocho" default="build" basedir=".">
<description>Ant Build File for Joomla by Evan Fillman (mole84)</description>


<property name="cfg.configFile" location="antconfig.txt" />
<loadproperties srcfile="${cfg.configFile}" />




<property name="cfg.comName" value="com_${cfg.name}" />
<property name="cfg.comDir" value="${basedir}/${cfg.versionDir}/${cfg.comName}" />
<property name="cfg.buildVersionDir" value="${cfg.buildDir}/${cfg.versionDir}" />
<property name="cfg.adminFilesDir" location="${cfg.comDir}/admin" />
<property name="cfg.siteFilesDir" location="${cfg.comDir}/site" />
<property name="cfg.extensionsDir" location="${cfg.adminFilesDir}/extensions" />

<target name="build" depends="clean, init, build_component, info" />

<target name="init" description="creates nessecary directory to build with">
<mkdir dir="${cfg.buildVersionDir}" />
<mkdir dir="${cfg.buildVersionDir}/plugins" />
<mkdir dir="${cfg.buildVersionDir}/modules" />
<mkdir dir="${cfg.buildVersionDir}/components" />
<mkdir dir="${cfg.extensionsDir}" />
</target>

<target name="build_component" depends="update_extensions" description="packages the finaly component file">
<zip destfile="${cfg.buildVersionDir}/components/${cfg.comName}.zip" basedir="${cfg.comDir}" />
</target>

<target name="build_plugins" description="packages any plugins">

<zip destfile="${cfg.buildVersionDir}/plugins/plg_uncleocho.zip" basedir="${cfg.versionDir}/plg_uncleocho" />
</target>

<target name="build_modules" description="packages any modules">

<zip destfile="${cfg.buildVersionDir}/modules/mod_uncleocho.zip" basedir="${cfg.versionDir}/mod_uncleocho" />
</target>

<target name="build_debug" description="builds any debug plugins or code">
<zip destfile="${cfg.buildVersionDir}/plugins/billets_plugin_toolbox.zip" basedir="${cfg.versionDir}/billets_plugin_toolbox" />
<zip destfile="${cfg.buildVersionDir}/plugins/billets_plugin_debug.zip" basedir="${cfg.versionDir}/billets_plugin_debug" />
</target>

<target name="update_extensions" depends="build_plugins, build_modules" description="copies fresh builds of plugins and extensions to the admin/extensions folder">
<copy todir="${cfg.extensionsDir}" overwrite="true">
<fileset dir="${cfg.buildVersionDir}/plugins" />
</copy>
<copy todir="${cfg.extensionsDir}" overwrite="true">
<fileset dir="${cfg.buildVersionDir}/modules" />
</copy>
</target>

<target name="info" description="prints information">
<echo message="Project: ${cfg.name}" />
<tstamp>
<format property="buildtime" pattern="yyyy-MM-dd'T'HH:mm:ss" />
</tstamp>
<echo message="Buildtime: ${buildtime}" />
</target>

<target name="clean" description="Destroys all generated files and dirs.">
<delete dir="${cfg.buildVersionDir}" />
<delete dir="packages" />
<delete dir="${cfg.extensionsDir}" />
<delete file="${cfg.xmlfile}" />
</target>

<target name="update_localhost" depends="info" description="attemps to update files on localhost server with files from working directory">
<copy todir="${cfg.localhostRoot}/administrator/components/${cfg.comName}" overwrite="true">
<fileset dir="${cfg.adminFilesDir}" />
</copy>
<copy todir="${cfg.localhostRoot}/components/${cfg.comName}" overwrite="true">
<fileset dir="${cfg.siteFilesDir}" />
</copy>
</target>

<target name="upload" description="attempts to upload build file to ftp server">
<fileset id="ftp.upload.fileset" dir="${cfg.buildVersionDir}/components">
<include name="*.zip" />
</fileset>

<echo>FTP target is ${ftp.server}</echo>
<ftp server="${ftp.server}" userid="${ftp.user}" password="${ftp.password}" action="put" remotedir="${ftp.dir}">
<fileset refid="ftp.upload.fileset" />
</ftp>
</target>

<target name="build_xml" description="builds an xml listing of all the files in the working copy">
<fileset id="site" dir="${cfg.siteFilesDir}" />
<echo message="${line.separator}<files folder="site">${line.separator}<filename>" file="${cfg.xmlfile}" append="false" />
<echo-fileset filesetref="site" />
<echo message="</filename>${line.separator}</files>${line.separator}" file="${cfg.xmlfile}" append="true" />

<fileset id="admin" dir="${cfg.adminFilesDir}" />
<echo message="${line.separator}<files folder="admin">${line.separator}<filename>" file="${cfg.xmlfile}" append="true" />
<echo-fileset filesetref="admin" />
<echo message="</filename>${line.separator}</files>${line.separator}" file="${cfg.xmlfile}" append="true" />

<replace file="${cfg.xmlfile}" token="${cfg.siteFilesDir}/" value="" />
<replace file="${cfg.xmlfile}" token="${cfg.adminFilesDir}/" value="" />
</target>

<macrodef name="echo-fileset" description="creates a printable directory listing">
<attribute name="filesetref" />
<sequential>
<pathconvert pathsep="</filename>${line.separator}<filename>" property="@{filesetref}.echopath">
<path>
<fileset refid="@{filesetref}" />
</path>
</pathconvert>
<echo message="${@{filesetref}.echopath}" file="${cfg.xmlfile}" append="true" />
</sequential>
</macrodef>
</project>
</source>

==== Config File to Accompany Build File ====
<source lang="text">
cfg.name=uncleocho
cfg.versionDir=v1_50
cfg.buildDir=packages
cfg.localhostRoot=../../www
cfg.xmlfile=files.txt

ftp.server=
ftp.user=
ftp.password=
ftp.dir=
</source>

=== Example 2 ===
Anohter one, a bit less and a bit more.
<source lang="xml">
<!DOCTYPE project> 
<project name="People Actions" default="update_local" basedir=".">
<description>Ant Build File for Joomla! extensions</description>


<property name="cfg.name" value="peopleactions" />

<property name="cfg.prefix" value="com_" />

<property name="cfg.dir" value="../trunk/component" />

<property name="cfg.packages" value="../packages" />

<property name="cfg.serverpath" value="C:\Users\Ruben\Documents\Dev\Projects\Joomla\joomla-base\2.5" />

<target name="init" >
<xmlproperty file="${cfg.dir}/${cfg.name}.xml" collapseAttributes="true" prefix="xml" keepRoot="false" />
<buildnumber/>
<tstamp>
<format property="TODAY" pattern="yyyy-MM-dd"/>
</tstamp>

<property name="str.version" value="_v${xml.version}.${build.number}" />
<property name="str.destfile" value="${cfg.packages}/${cfg.prefix}${cfg.name}${str.version}_${TODAY}" />
<property name="str.sitetrunkpath" value="${cfg.dir}/site" />
<property name="str.admintrunkpath" value="${cfg.dir}/admin" />
<property name="str.xmlfile" value="${cfg.dir}/${cfg.name}test.xml" />
</target>

<target name="info" depends="init" description="prints information">
<echo message="${cfg.name} - ${str.version} - ${ant.version}" />
</target>

<target name="update_local" depends="info, init" description="attemps to update files on localhost server">
<copy todir="${cfg.serverpath}/components/${cfg.prefix}${cfg.name}">
<fileset dir="${str.sitetrunkpath}" excludes="/language/" />
</copy>
<copy todir="${cfg.serverpath}/language/">
<fileset dir="${str.sitetrunkpath}/language/" />
</copy>
<copy todir="${cfg.serverpath}/administrator/components/${cfg.prefix}${cfg.name}">
<fileset file="${cfg.dir}/${cfg.name}.xml" />
<fileset dir="${str.admintrunkpath}" excludes="/language/" />
</copy>
<copy todir="${cfg.serverpath}/administrator/language/">
<fileset dir="${str.admintrunkpath}/language/" />
</copy>
<copy todir="${cfg.serverpath}/media/${cfg.prefix}${cfg.name}/">
<fileset dir="${cfg.dir}/media/" />
</copy>
</target>

<target name="zip" depends="info" description="Makes an uploadable zip package">
<mkdir dir="${cfg.packages}" />
<zip
destfile="${str.destfile}.zip"
basedir="${cfg.dir}" />
</target>

<target name="build_xml" depends="info" description="builds an xml listing of all the files in trunk">
<fileset id="site" dir="${str.sitetrunkpath}" />
<echo message="${line.separator}<files folder="site">${line.separator}<filename>" file="${str.xmlfile}" append="false" />
<echo-fileset filesetref="site" />
<echo message="</filename>${line.separator}</files>${line.separator}" file="${str.xmlfile}" append="true" />

<fileset id="admin" dir="${str.admintrunkpath}" />
<echo message="${line.separator}<files folder="admin">${line.separator}<filename>" file="${str.xmlfile}" append="true" />
<echo-fileset filesetref="admin" />
<echo message="</filename>${line.separator}</files>${line.separator}" file="${str.xmlfile}" append="true" />

<replace file="${str.xmlfile}" token="${str.sitetrunkpath}/" value="" />
<replace file="${str.xmlfile}" token="${str.admintrunkpath}/" value="" />
</target>

<macrodef name="echo-fileset" description="creates a printable directory listing">
<attribute name="filesetref" />
<sequential>
<pathconvert pathsep="</filename>${line.separator}<filename>" property="@{filesetref}.echopath">
<path>
<fileset refid="@{filesetref}" />
</path>
</pathconvert>
<echo message="${@{filesetref}.echopath}" file="${str.xmlfile}" append="true" />
</sequential>
</macrodef>

</project>
</source>

[[Category:Development]]

Configuring a XAMPP server for joomla development

2013-05-23T12:05:46Z

Hutchy68: added Category:Server setup local using HotCat

{{RightTOC}}

== Introduction ==
XAMPP is an easy-to-install package that bundles the Apache web server, PHP, XDEBUG, and the MySql database. This allows you to create the environment you need to run Joomla! on your local machine. The latest version of XAMPP is available at [http://www.apachefriends.org/en/xampp.html the XAMPP web site]. Downloads are available for Linux, Windows, Mac OS X and Solaris. Download the package for your platform.

''Important Note Regarding XAMPP and Skype:'' Apache and Skype both use port 80 as an alternative for incoming connections. If you use Skype, go into the Tools-Options-Advanced-Connection panel and deselect the "Use 80 and 443 as alternatives for incoming connections" option. If Apache starts as a service, it will take 80 before Skype starts and you will not see a problem. But, to be safe, disable the option in Skype.

'''Update'''

''As of August 5, 2010, XDebug has been updated (to version 2.1) which fixes some important bugs (for example, watching local variables for nesting functions). The latest XAMPP package (1.7.3) now includes this new version of XDebug. If you just want to update XDebug, you can download the latest module from [http://www.xdebug.org]. There is a handy website that tells you which XDebug binary you need, depending on your phpinfo() information [http://xdebug.org/find-binary.php here]. To use it, you just copy the output of your phpinfo() display and paste it into the form on the site.''

===Installation on Windows===

Installation for Windows is very simple. You can use the XAMPP installer executable (for example, "xampp-win32-1.7.3-installer.exe"). Detailed installation instructions for Windows are available [http://www.apachefriends.org/en/xampp-windows.html here].

For Windows, it is recommended to install XAMPP in "c:\xampp" (not in "c:\program files"). If you do this, your Joomla! (and any other local web site folders) will go into the folder "c:\xampp\htdocs". (By convention, all web content goes under the "htdocs" folder.)

If you have multiple http servers (like IIS) you can change the xampp listening port. In <xamppDir>\apache\conf\httpd.conf, modify the line Listen 80 to Listen [portnumber] (ex: "Listen 8080").

===Installation on Linux===

==== Install xammp ====
Open Terminal and enter:
sudo tar xvfz xampp-linux-1.7.7.tar.gz -C /opt
(replace ''xampp-linux-1.7.7.tar.gz'' with the version of xammp you downloaded).
It has been reported that the MYSQL database of xampp 1.7.4 does not work with Joomla 1.5.22

This installs ... Apache2, mysql and php5 as well as an ftp server.

''sudo /opt/lampp/lampp start''

and
''sudo /opt/lampp/lampp stop''

starts/stops all the services

==== Test your xammp localhost server ====
Open your Browser and point it to
http://localhost
The index.php will redirect to
http://localhost/xampp

There you will find instructions on how to change default usernames/passwords. On a PC that does not serve files to the Internet or LAN then changing the defaults is a personal decision.

==== Get Joomla ====
Download the latest Joomla instalation zip [http://www.joomla.org/download.html]

Unzip to your hard drive

Connect to localhost with an FTP client
Default
nobody
lampp

Create a folder for your Joomla on the localhost server

FTP the unpacked Joomla installation files to the newly created Joomla folder.

'''Important:'''
* The xammp installation sets the correct Ownership of the files and permissions.
* Using the '''CHOWN command''' will '''cause Ownership problems with xampp'''.
* '''Using nautilus''' to manipulate folders/files on localhost will '''cause Ownership problems with xampp'''.

'''Database info'''

Host
localhost

Default Database name
test

Default Database user
root

There is no default Password.

Administrator password is your choice.

Installing Sample Data is recommended for the novice user.

After installation delete the installation directory and point your Browser to:
http://localhost/yournewjoomlafolder
or
http://localhost/yournewjoomlafolder/administrator

==== Creating a link in the Ubuntu menu ====
'''To create a GUI for xammp connected to your Ubuntu menu'''

Open up the Terminal and type
sudo gedit /usr/share/applications/xampp-control-panel.desktop

Then copy the following into the gedit and save.

[Desktop Entry]
Encoding=UTF-8
Name=XAMPP Control Panel
Comment=Start and Stop XAMPP
Exec=gksudo "python /opt/lampp/share/xampp-control-panel/xampp-control-panel.py"
Icon=/usr/share/icons/Tango/scalable/devices/network-wired.svg
Terminal=false
Type=Application
Categories=GNOME;Application;Network;
StartupNotify=true

If the control panel fails to launch, try running the Exec command directly in the terminal:

gksudo "python /opt/lampp/share/xampp-control-panel/xampp-control-panel.py"

If you receive the error:

Error importing pygtk2 and pygtk2-libglade

Install the missing libraries:

sudo apt-get install python-glade2

==== XDebug PHP debugger ====

The XAMPP package for Linux does not includes the XDebug PHP debugger. To install XDebug on Debian or Ubuntu:

- Install the ''build-essential'' package:
<pre>sudo apt-get update
sudo apt-get install build-essential
sudo apt-get install autoconf</pre>
- Download the [http://www.apachefriends.org/en/xampp-linux.html development package] for your version of XAMPP and extract it over your existing installation:
<pre>sudo tar xvfz xampp-linux-devel-1.7.7.tar.gz -C /opt </pre>
- Build XDebug:
<pre>wget http://xdebug.org/files/xdebug-2.1.3.tgz
tar xzf xdebug-2.1.3.tgz
cd xdebug-2.1.3/
/opt/lampp/bin/phpize</pre>
After this you will have following output on your console…
<pre>Configuring for:
PHP Api Version: 20090626
Zend Module Api No: 20090626
Zend Extension Api No: 20090626 </pre>
<pre>./configure --with-php-config=/opt/lampp/bin/php-config
make
sudo make install </pre>
Then the output will be this.. please monitor the directory specified.
<pre>Installing shared extensions: /opt/lampp/lib/php/extensions/no-debug-non-zts-20090626/ </pre>

Create a folder in your temp folder that will holds the data file generated by XDebug:
<pre>sudo mkdir /opt/lampp/tmp/xdebug
sudo chmod a+rwx -R /opt/lampp/tmp/xdebug </pre>

Alternative installations:

Install using PHP extensions community library (PECL) bundled with xampp:
sudo /opt/lampp/bin/pecl install xdebug

On Ubuntu/Debian you can install using:
apt-get install php5-xdebug

(warning: this will also install Apache and PHP from apt repositories).

'''Warning for 64bit users'''

When compiling XDebug or installing via apt-get, you will receive an error when (re)starting xampp:

/opt/lampp/lib/php/extensions/no-debug-non-zts-20090626/xdebug.so: wrong ELF class: ELFCLASS64

This is because xampp runs 32bit but XDebug is 64bit. To overcome this problem, either make xdebug.so on a 32bit machine or download it from:

http://code.activestate.com/komodo/remotedebugging/

Download the file: "PHP Remote Debugging Client" for "Linux (x86)"
Extract the content of the file on your computer, this compressed file contains several folders with version numbers ex: 4.4, 5.0, 5.1 ... 5.3 and so forth, get in the folder with the higher version number or the one that works for you, then manually copy the file "xdebug.so" to the following location, overwrite if needed

/opt/lampp/lib/php/extensions/no-debug-non-zts-20090626/

Remember this location could be different on your computer

===Installation on Mac OS X===
Mac OS X actually includes an Apache server out-of-the-box, but most developers will prefer to use the integrated tools and configurability provided by XAMPP.

As with most programs on Mac, installation is a breeze. Visit [http://www.apachefriends.org/en/xampp-macosx.html Apache Friends - Mac OS X] for the universal binary download.

Once the file has finished downloading, just open the disk image, and drag the XAMPP folder to the "Applications" folder alias.

To start the server, open "XAMPP Control.app" and press the start button next to Apache.

=====A Little Troubleshooting=====
Many Mac users have a little difficulty at this stage when trying to set up another instance of Apache on their machine. If you cannot start XAMPP's Apache, you have two options:
<br />
'''You can change the listening port of XAMPP.''' In \Applications\XAMPP\xamppfiles\etc\httpd.conf, modify the line that says, "Listen 80" to Listen [portNumber]. E.g.:
<pre>Listen 8080</pre>

'''You can change the listening port of the pre-installed Apache server.''' In finder, go to "/etc" (CMD+SHIFT+G); from here you will be able to navigate through the normally hidden Apache files. Find the folder labeled Apache2, and edit the "http.conf" file. Modify the line that says, "Listen 80" to Listen [portNumber]. E.g.:
<pre>Listen 8080</pre>

''Note: If you choose to change the port of the pre-installed Apache server, you may need to restart your computer for changes to take effect. You will also have to authenticate as an administrator to change these files.''

===Test XAMPP Installation===

Once XAMPP is installed and you have started the Apache service with the XAMPP Control Panel tool, you can test it by opening your browser and navigating to "http://localhost". You should see the XAMPP welcome screen similar to the one below.

[[Image:xampp_phpinfo_screen.png]]

Select the link called "phpinfo()" in the left-hand menu. This will display a long screen of information about the PHP configuration, as shown below.

[[Image:xampp_phpinfo_conf_file.png]]

At this point, XAMPP is installed successfully. Notice the "Loaded Configuration File" which is highlighted in the screenshot above. We will be editing this file in the next section to configure XDebug.

[[Category:Server configurations]]
[[Category:Server setup local]]

Configuring a XAMPP server for joomla development

2013-05-23T12:05:35Z

Hutchy68: added Category:Server configurations using HotCat

User:Hutchy68/New main page/Explore the Joomla! Documentation Wiki

2013-05-19T22:08:00Z

Hutchy68: updates

{| style="width:100%;margin:0 0 .5em 0; border-collapse:collapsed;" cellspacing="0"
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla3x.png|40px|left]] <big>'''Joomla! CMS Version {{CurrentSTSVer|minor}}'''</big> - is the latest [[Release and support cycle|STS version]]. In the future, Joomla! 3.5 will replace Joomla 2.5. Support for Joomla {{CurrentSTSVer|minor}} is still active. For more information see the [[:Category:Joomla! {{CurrentSTSVer|minor}}|Joomla {{CurrentSTSVer|minor}} category page]].
</div>
|-
| style="width:49%; vertical-align:top;" |
;* [[Technical requirements]]
;* [[J{{CurrentSTSVer|minor}}:Installing Joomla!|Installation]]
| style="width:49%;" |
;* [[What's new in Joomla! {{CurrentSTSVer|minor}}|What's new]]
;* [[J{{CurrentSTSVer|minor}}:Access_Control_List|Joomla! {{CurrentSTSVer|minor}} Access control system]]
|-
| style="padding:.25em 0 |  
|-
| style="vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[Image:Joomla25.png|40px|left]] <big>'''Joomla! CMS Version {{CurrentLTSVer|minor}}'''</big> - is the [[Release and support cycle|current LTS version]]. The previous LTS version, Joomla 1.5, is still widely used but support ended as of September 2012. For more information see the [[:Category:Joomla! {{CurrentLTSVer|minor}}|Joomla {{CurrentLTSVer|minor}} category page]].
</div>
|-
| style="width:49%; vertical-align:top;" |
;* [[Migrating from Joomla 1.5 to Joomla 2.5]]
;* [[:Category:Version {{CurrentLTSVer}} FAQ|Version {{CurrentLTSVer}} FAQ]]
;* [[Technical_requirements|Joomla! 2.5 Requirements]]
| style="width:49%; vertical-align:top;" |
;* [[Installing Joomla!]]
;* [[Upgrading from Joomla 1.7 to Joomla 2.5]]
|-
| style="padding:.25em 0 |
|-
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla_Development.png|30px|left]] <big>'''[[Developers|Joomla! Development]]'''</big> - Information and links for Joomla! Extension developers, Bug Squad members, or the Joomla! Platform and Joomla! Framework maintainers.
</div>
|-
| style="width:49%; vertical-align:top;" |
;*[[Portal:Developers|Developers Portal]]
;*[[Portal:Bug_Squad|Joomal! Bug Squad members]]
;*[[Portal:Platform|Joomla! Platform Portal]]
;*Also see [http://developer.joomla.org developer.joomla.org]
;*[http://api.joomla.org/ API Documentation]
| style="width:49%;" |
;*[[Template Development|Templates]]
;*[[Component Development|Components]]
;*[[Module Development|Modules]]
;*[[Plugin Development|Plugins]]
;*[[Language Development|Languages]]
|}

What's new in Joomla! 3.1

2013-05-19T21:32:39Z

Hutchy68: redirect to J3.1:What's new in Joomla!

#REDIRECT [[J3.1:What's new in Joomla!]]

User:Hutchy68/New main page/Explore the Joomla! Documentation Wiki

2013-05-19T21:19:41Z

Hutchy68: updates

{| style="width:100%;margin:0 0 .5em 0; border-collapse:collapsed;" cellspacing="0"
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla3x.png|40px|left]] <big>'''Joomla! CMS Version {{CurrentSTSVer|minor}}'''</big> - is the latest [[Release and support cycle|STS version]]. In the future, Joomla! 3.5 will replace Joomla 2.5. Support for Joomla {{CurrentSTSVer|minor}} is still active. For more information see the [[:Category:Joomla! {{CurrentSTSVer|minor}}|Joomla {{CurrentSTSVer|minor}} category page]].
</div>
|-
| style="width:49%; vertical-align:top;" |
;* [[Technical requirements]]
;* [[{{NewestPageVer|Installing Joomla! }}|Installation]]
| style="width:49%;" |
;* [[What's new in Joomla! {{CurrentSTSVer|minor}}|What's new]]
;* [[ACL Tutorial for Joomla! {{CurrentSTSVer|minor}}|Access control system]]
|-
| style="padding:.25em 0 |  
|-
| style="vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[Image:Joomla25.png|40px|left]] <big>'''Joomla! CMS Version {{CurrentLTSVer|minor}}'''</big> - is the [[Release and support cycle|current LTS version]]. The previous LTS version, Joomla 1.5, is still widely used but support ended as of September 2012. For more information see the [[:Category:Joomla! {{CurrentLTSVer|minor}}|Joomla {{CurrentLTSVer|minor}} category page]].
</div>
|-
| style="width:49%; vertical-align:top;" |
;* [[Migrating from Joomla 1.5 to Joomla 2.5]]
;* [[:Category:Version {{CurrentLTSVer}} FAQ|Version {{CurrentLTSVer}} FAQ]]
;* [[Technical_requirements|Joomla! 2.5 Requirements]]
| style="width:49%; vertical-align:top;" |
;* [[Installing Joomla!]]
;* [[Upgrading from Joomla 1.7 to Joomla 2.5]]
|-
| style="padding:.25em 0 |
|-
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla_Development.png|30px|left]] <big>'''[[Developers|Joomla! Development]]'''</big> - Information and links for Joomla! Extension developers, Bug Squad members, or the Joomla! Platform and Joomla! Framework maintainers.
</div>
|-
| style="width:49%; vertical-align:top;" |
;*[[Portal:Developers|Developers Portal]]
;*[[Portal:Bug_Squad|Joomal! Bug Squad members]]
;*[[Portal:Platform|Joomla! Platform Portal]]
;*Also see [http://developer.joomla.org developer.joomla.org]
;*[http://api.joomla.org/ API Documentation]
| style="width:49%;" |
;*[[Template Development|Templates]]
;*[[Component Development|Components]]
;*[[Module Development|Modules]]
;*[[Plugin Development|Plugins]]
;*[[Language Development|Languages]]
|}

User:Hutchy68/New main page/Resources

2013-05-19T21:16:10Z

Hutchy68: moving developer

User:Hutchy68/New main page/Resources

2013-05-19T13:28:09Z

Hutchy68: updates

{| style="width:100%;margin:0 0 .5em 0; border-collapse:collapsed;" cellspacing="0"
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Icon tools.png|30px|left]] <big>'''[[Administrator]] Quick Links'''</big> - Common tasks, how-to's and other tasks for administrators.
</div>
|-
| style="width:49%; vertical-align:top;" |
;*[[Joomla Installation|Installation]]
;*[[Template Management]]
;*[[Article Management]]
;*[[Menu Management]]
;*[[Module Management]]
| style="width:49%;" |
;*[[Component Management]]
;*[[Category Management]]
;*[[Plugin Management]]
;*[[Global Configuration Management|Global Configuration]]
;*[[:Category:Tips and tricks|Tips and tricks]]
|-
| style="padding:.25em 0 |
|-
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla_Development.png|30px|left]] <big>'''[[Developers|Joomla! Development]]'''</big> - Information and links for Joomla! Extension developers, Bug Squad members, or the Joomla! Platform and Joomla! Framework maintainers.
</div>
|-
| style="width:49%; vertical-align:top;" |
;*[[Portal:Developers|Developers Portal]]
;*[[Portal:Bug_Squad|Joomal! Bug Squad members]]
;*[[Portal:Platform|Joomla! Platform Portal]]
;*Also see [http://developer.joomla.org developer.joomla.org]
;*[http://api.joomla.org/ API Documentation]
| style="width:49%;" |
;*[[Template Development|Templates]]
;*[[Component Development|Components]]
;*[[Module Development|Modules]]
;*[[Plugin Development|Plugins]]
;*[[Language Development|Languages]]
|-
| style="padding:.25em 0 |
|-
| style="vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[Image:Security_lock.png|30px|left]] <big>'''[[Security Checklist|Joomla! Security]]'''</big> - Questions about securing your Joomla! web site? What extensions are secure? Useful pages all Joomla! Administrators should read.
</div>
|-
| colspan="2" |
;*[[Security Checklist|Joomla! Security Checklist]]
;*[http://vel.joomla.org Vulnerable Extensions List]
;*[[User Management|User and Access Management]]
;*[[How_do_you_recover_your_admin_password%3F|Admin Password Recovery]]
</div>
|-
|}

User:Hutchy68/New main page/Resources

2013-05-19T13:23:08Z

Hutchy68: updates

{| style="width:100%;margin:0 0 .5em 0; border-collapse:collapsed;" cellspacing="0"
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Icon tools.png|30px|left]] <big>'''[[Administrator]] Quick Links'''</big> - Common tasks, how-to's and other tasks for administrators.
</div>
|-
| style="width:49%; vertical-align:top;" |
;[[Joomla Installation|Installation]]
;[[Template Management]]
;[[Article Management]]
;[[Menu Management]]
;[[Module Management]]
| style="width:49%;" |
;[[Component Management]]
;[[Category Management]]
;[[Plugin Management]]
;[[Global Configuration Management|Global Configuration]]
;[[:Category:Tips and tricks|Tips and tricks]]
|-
| style="padding:.25em 0 |
|-
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla_Development.png|30px|left]] <big>'''[[Developers|Joomla! Development]]'''</big> - Information and links for Joomla! Extension developers, Bug Squad members, or the Joomla! Platform and Joomla! Framework maintainers.
</div>
|-
| style="width:49%; vertical-align:top;" |
;[[Portal:Developers|Developers Portal]]
;[[Portal:Bug_Squad|Joomal! Bug Squad members]]
;[[Portal:Platform|Joomla! Platform Portal]]
;more @ [http://developer.joomla.org developer.joomla.org]
;[http://api.joomla.org/ API Documentation]
| style="width:49%;" |
;[[Template Development|Templates]]
;[[Component Development|Components]]
;[[Module Development|Modules]]
;[[Plugin Development|Plugins]]
;[[Language Development|Languages]]
|-
| style="vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[Image:Security_lock.png|30px|left]] <big>'''[[Security Checklist|Joomla! Security]]'''</big> - Questions about securing your Joomla! web site? What extensions are secure? Useful pages all Joomla! Administrators should read.
</div>
|-
| style="padding:.25em 0 |
|-
| colspan="2" |
<div style="display:inline-block; padding:.4em 2.0em;">
;[[Security Checklist|Joomla! Security Checklist]]
;[http://vel.joomla.org Vulnerable Extensions List]
;[[User Management|User and Access Management]]
;[[How_do_you_recover_your_admin_password%3F|Admin Password Recovery]]
</div>
|-
|}

User:Hutchy68/New main page/Resources

2013-05-19T13:20:53Z

Hutchy68: updates

{| style="width:100%;margin:0 0 .5em 0; border-collapse:collapsed;" cellspacing="0"
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Icon tools.png|30px|left]] <big>'''[[Administrator]] Quick Links'''</big> - Common tasks, how-to's and other tasks for administrators.
</div>
|-
| style="width:49%; vertical-align:top;" |
* [[Joomla Installation|Installation]]
* [[Template Management]]
* [[Article Management]]
* [[Menu Management]]
* [[Module Management]]
| style="width:49%;" |
* [[Component Management]]
* [[Category Management]]
* [[Plugin Management]]
* [[Global Configuration Management|Global Configuration]]
* [[:Category:Tips and tricks|Tips and tricks]]
|-
| style="padding:.25em 0 |
|-
| style="padding:.25em 0; vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[File:Joomla_Development.png|30px|left]] <big>'''[[Developers|Joomla! Development]]'''</big> - Information and links for Joomla! Extension developers, Bug Squad members, or the Joomla! Platform and Joomla! Framework maintainers.
</div>
|-
| style="width:49%; vertical-align:top;" |
* [[Portal:Developers|Developers Portal]]
* [[Portal:Bug_Squad|Joomal! Bug Squad members]]
* [[Portal:Platform|Joomla! Platform Portal]]
* more @ [http://developer.joomla.org developer.joomla.org]
* [http://api.joomla.org/ API Documentation]
| style="width:49%;" |
* [[Template Development|Templates]]
* [[Component Development|Components]]
* [[Module Development|Modules]]
* [[Plugin Development|Plugins]]
* [[Language Development|Languages]]
|-
| style="vertical-align:top;" colspan="2" |
<div style="padding:.4em .5em .4em .2em; vertical-align:top; text-align:justify; text-justify:inter-word; background-color:beige; min-height:50px;">
[[Image:Security_lock.png|30px|left]] <big>'''[[Security Checklist|Joomla! Security]]'''</big> - Questions about securing your Joomla! web site? What extensions are secure? Useful pages all Joomla! Administrators should read.
</div>
|-
| style="padding:.25em 0 |
|-
| colspan="2" |
<div style="display:inline-block; padding:.4em 2.0em;">
;[[Security Checklist|Joomla! Security Checklist]]
;[http://vel.joomla.org Vulnerable Extensions List]
;[[User Management|User and Access Management]]
;[[How_do_you_recover_your_admin_password%3F|Admin Password Recovery]]
</div>
|-
|}