Joomla! Documentation - User contributions [en]

Retrieving request data using JInput

2013-03-25T05:09:42Z

Goldenmean: /* Getting Values */

Deploying an Update Server

2013-01-07T15:25:45Z

Goldenmean:

{{RightTOC}}

This tutorial is for all Joomla! versions newer than {{JVer|1.6}}

= Introduction =
This tutorial is designed to teach developers how to create an update server for integration with the update system introduced in Joomla! 1.6. By adding an update server listing to your extension's manifest, developers enable users to update their extensions via the [[Help16:Extensions Extension Manager Update|Extension Manager's Update]] view with only a few clicks.

= Defining an update server =
In order to use this feature, an update server must be defined in your extension's manifest. This definition can be used in all Joomla! 1.6 and newer compatible extensions but is not available for templates. You can use two options for your server type; collection or extension. These will be explained in detail shortly. This code should be added to the extension manifest file, within the root "extension" element. The update server is defined as follows for each type:

<code>
<extension>
<...>
<updateservers>
<server type="collection">http://example.com/list.xml</server>
<server type="extension" priority="2" name="My Extension's Updates">http://example.com/extension.xml</server>
</updateservers>
</extension>
</code>

Multiple servers can be defined within the <updateservers> tag.

= Server types =
== Collection ==
The collection server type allows developers to define an extension's manifest to pull updates from a collection. This type of server can be used if the developer wants to define all of their extension's updates in a single file (not recommended) or if their extension has multiple sub-extensions which are not distributed or updated at the same time (such as a package extension type). The below example is the collection definition used by the updater when processing core Joomla! updates:

<code>
<extensionset name="Joomla Core" description="Joomla! Core">
<extension name="Joomla" element="joomla" type="file" version="1.7.0" detailsurl="http://update.joomla.org/core/extension.xml"/>
</extensionset>
</code>

All definitions must be defined between <extensionset> tags in your collection manifest. The <extensionset> tag has two optional parameters; name and description. For each extension that this collection references, a separate <extension> tag is required. The <extension> tag has the following parameters, all of which are required for updates to properly process:

* '''name''' - The name of the extension
* '''element''' - The untranslated extension name i.e. mod_custom
* '''type''' - The extension type (component, module, plugin, etc.)
* '''version''' - The latest version of the extension
* '''detailsurl''' - The URL of the XML file which contains that extension's individual update definitions

== Extension ==
The extension server type allows developers to define an extension's manifest to pull updates from a single extension's manifest. All collection manifests eventually point to this XML file. All updates in this file must be defined after an <updates> tag at the beginning of the file. The below example is the update definition for the Joomla! 1.7.0 release:

<code>
<update>
<name>Joomla! 1.7</name>
<description>Joomla! 1.7 CMS</description>
<element>joomla</element>
<type>file</type>
<version>1.7.0</version>
<infourl title="Joomla!">http://www.joomla.org/</infourl>
<downloads>
<downloadurl type="full" format="zip">http://joomlacode.org/gf/download/frsrelease/15279/66552/Joomla_1.6.5_to_1.7.0_Package.zip</downloadurl>
</downloads>
<tags>
<tag>stable</tag>
</tags>
<maintainer>Sam Moffatt</maintainer>
<maintainerurl>http://sammoffatt.com.au</maintainerurl>
<section>Testing</section>
<targetplatform name="joomla" version="1.6"/>
</update>
</code>

The following section describes the elements of a single update entity.

* '''name''' - The name of the extension, this name will appear in the Name column of the Extension Manager's Update view (required)
* '''description''' - A short description of the extension (optional) -- if you choose to use <![CDATA[]]>, double-quotes will break the HTML formatting. Use single quotes with your HTML entities.
* '''element''' - The installed name of the extension (required)
* '''type''' - The type of extension (component, module, plugin, etc.) (required)
* '''folder''' - Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)
* '''client''' (usually optional, required for J! 1.7.3 due to a regression; but highly encouraged regardless) - The client ID of the extension, which can be found by looking inside the #__extensions table. To date, use 0 for "site" and 1 for "administrator". Plugins and front-end modules are automatically installed with a client of 0 (site), but you will need to specify the client in an update or it will default to 1 (administrator) and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of 1, which is currently the default.
** ''Warning'': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.
* '''version''' - The version of the release (required)
* '''infourl''' - A URL to point users to containing information about the update (optional) (In CMS 2.5, if set, this URL will be displayed in the update view)
* '''downloads''' - The section which lists all download locations
** '''downloadurl''' - The URL to download the extension from; the <downloadurl> tag has two required parameters:
*** '''type''' - The type of package (full or upgrade)
*** '''format''' - The format of the package (zip, tar, etc.)
* '''tags''' - Optional (unknown use)
* '''maintainer''' - The name of the extension maintainer (similar to the <author> tag in a manifest) (optional)
* '''maintainerurl''' - The website of the extension maintainer (similar to the <authorUrl> tag in a manifest) (optional)
* '''section''' - Optional (unknown use)
* '''targetplatform''' - A tag to define platform requirements, requires the following elements
** '''name''' - The name of the platform dependency; as of this writing, it should ONLY be "joomla"
** '''version''' - The version of Joomla! the extension supports
** '''min_dev_level''' and '''max_dev_level''' - These attributes were added in 3.0.1 to allow you to select a target platform based on the developer level ("z" in x.y.z). They are optional. You can specifiy either one or both. If omitted, all developer levels are matched. For example, the following matches versions 4.0.0 and 4.0.1. <code><targetplatform name="joomla" version="4.0" min_dev_level="0" max_dev_level="1"/></code>
*** '''Note:''' If your extension is Joomla! 1.6, 1.7, and/or 2.5 compatible, you will be required to have separate <update> definitions for each version due to the manner in which the updater checks the version

A separate <update> definition will be required for each version of your extension you release.

The values of '''element''', '''type''', '''client_id''' and '''folder''' should match those in the table #__extensions.

= Troubleshooting =
* '''SQL update script is not executed during update.'''
:If the SQL update script (for example, in the folder <code>sql/updates/mysql</code>) does not get executed during the update process, it could be because there is no version number in the <code>#__schemas</code> table for this extension ''prior to the update''. This value is determined by the last script name in the SQL updates folder. If this value is blank, no SQL scripts will be executed during that update cycle. To make sure this value is set correctly, make sure you have a SQL script in this folder with its name as the version number (for example, 1.2.3.sql if the version is 1.2.3). The file can be empty or just have a SQL comment line. This should be done in the old version -- the one before the update. Alternatively, you can add this value to the <code>#__schemas</code> using a SQL query.

= Supporting Tools =
Maintaining your update server files can be difficult depending on the manner in which you set up your files. An extension which can help you to maintain this is the Akeeba Release System, available free of charge from https://www.akeebabackup.com

= Contributors =
*[[User:mbabker|Michael Babker]]
[[Category:Development]]

Deploying an Update Server

2013-01-07T15:23:56Z

Goldenmean:

{{RightTOC}}

This tutorial is for all Joomla! versions newer than {{JVer|1.6}}

= Introduction =
This tutorial is designed to teach developers how to create an update server for integration with the update system introduced in Joomla! 1.6. By adding an update server listing to your extension's manifest, developers enable users to update their extensions via the [[Help16:Extensions Extension Manager Update|Extension Manager's Update]] view with only a few clicks.

= Defining an update server =
In order to use this feature, an update server must be defined in your extension's manifest. This definition can be used in all Joomla! 1.6 and newer compatible extensions but is not available for templates. You can use two options for your server type; collection or extension. These will be explained in detail shortly. The update server is defined as follows for each type:

<code>
<extension>
<...>
<updateservers>
<server type="collection">http://example.com/list.xml</server>
<server type="extension" priority="2" name="My Extension's Updates">http://example.com/extension.xml</server>
</updateservers>
</extension>
</code>

Multiple servers can be defined within the <updateservers> tag.

= Server types =
== Collection ==
The collection server type allows developers to define an extension's manifest to pull updates from a collection. This type of server can be used if the developer wants to define all of their extension's updates in a single file (not recommended) or if their extension has multiple sub-extensions which are not distributed or updated at the same time (such as a package extension type). The below example is the collection definition used by the updater when processing core Joomla! updates:

<code>
<extensionset name="Joomla Core" description="Joomla! Core">
<extension name="Joomla" element="joomla" type="file" version="1.7.0" detailsurl="http://update.joomla.org/core/extension.xml"/>
</extensionset>
</code>

All definitions must be defined between <extensionset> tags in your collection manifest. The <extensionset> tag has two optional parameters; name and description. For each extension that this collection references, a separate <extension> tag is required. The <extension> tag has the following parameters, all of which are required for updates to properly process:

* '''name''' - The name of the extension
* '''element''' - The untranslated extension name i.e. mod_custom
* '''type''' - The extension type (component, module, plugin, etc.)
* '''version''' - The latest version of the extension
* '''detailsurl''' - The URL of the XML file which contains that extension's individual update definitions

== Extension ==
The extension server type allows developers to define an extension's manifest to pull updates from a single extension's manifest. All collection manifests eventually point to this XML file. All updates in this file must be defined after an <updates> tag at the beginning of the file. The below example is the update definition for the Joomla! 1.7.0 release:

<code>
<update>
<name>Joomla! 1.7</name>
<description>Joomla! 1.7 CMS</description>
<element>joomla</element>
<type>file</type>
<version>1.7.0</version>
<infourl title="Joomla!">http://www.joomla.org/</infourl>
<downloads>
<downloadurl type="full" format="zip">http://joomlacode.org/gf/download/frsrelease/15279/66552/Joomla_1.6.5_to_1.7.0_Package.zip</downloadurl>
</downloads>
<tags>
<tag>stable</tag>
</tags>
<maintainer>Sam Moffatt</maintainer>
<maintainerurl>http://sammoffatt.com.au</maintainerurl>
<section>Testing</section>
<targetplatform name="joomla" version="1.6"/>
</update>
</code>

The following section describes the elements of a single update entity.

* '''name''' - The name of the extension, this name will appear in the Name column of the Extension Manager's Update view (required)
* '''description''' - A short description of the extension (optional) -- if you choose to use <![CDATA[]]>, double-quotes will break the HTML formatting. Use single quotes with your HTML entities.
* '''element''' - The installed name of the extension (required)
* '''type''' - The type of extension (component, module, plugin, etc.) (required)
* '''folder''' - Specific to plugins, this tag describes the type of plugin being updated (content, system, etc.) (required for plugins)
* '''client''' (usually optional, required for J! 1.7.3 due to a regression; but highly encouraged regardless) - The client ID of the extension, which can be found by looking inside the #__extensions table. To date, use 0 for "site" and 1 for "administrator". Plugins and front-end modules are automatically installed with a client of 0 (site), but you will need to specify the client in an update or it will default to 1 (administrator) and then found update would not be shown because it would not match any extension. Components are automatically installed with a client of 1, which is currently the default.
** ''Warning'': The tag name is <'''client'''> for Joomla! 2.5 and <'''client_id'''> for 1.6 and 1.7. If you use <client_id> (rather than <client>) on a 2.5 site, it will be ignored.
* '''version''' - The version of the release (required)
* '''infourl''' - A URL to point users to containing information about the update (optional) (In CMS 2.5, if set, this URL will be displayed in the update view)
* '''downloads''' - The section which lists all download locations
** '''downloadurl''' - The URL to download the extension from; the <downloadurl> tag has two required parameters:
*** '''type''' - The type of package (full or upgrade)
*** '''format''' - The format of the package (zip, tar, etc.)
* '''tags''' - Optional (unknown use)
* '''maintainer''' - The name of the extension maintainer (similar to the <author> tag in a manifest) (optional)
* '''maintainerurl''' - The website of the extension maintainer (similar to the <authorUrl> tag in a manifest) (optional)
* '''section''' - Optional (unknown use)
* '''targetplatform''' - A tag to define platform requirements, requires the following elements
** '''name''' - The name of the platform dependency; as of this writing, it should ONLY be "joomla"
** '''version''' - The version of Joomla! the extension supports
** '''min_dev_level''' and '''max_dev_level''' - These attributes were added in 3.0.1 to allow you to select a target platform based on the developer level ("z" in x.y.z). They are optional. You can specifiy either one or both. If omitted, all developer levels are matched. For example, the following matches versions 4.0.0 and 4.0.1. <code><targetplatform name="joomla" version="4.0" min_dev_level="0" max_dev_level="1"/></code>
*** '''Note:''' If your extension is Joomla! 1.6, 1.7, and/or 2.5 compatible, you will be required to have separate <update> definitions for each version due to the manner in which the updater checks the version

A separate <update> definition will be required for each version of your extension you release.

The values of '''element''', '''type''', '''client_id''' and '''folder''' should match those in the table #__extensions.

= Troubleshooting =
* '''SQL update script is not executed during update.'''
:If the SQL update script (for example, in the folder <code>sql/updates/mysql</code>) does not get executed during the update process, it could be because there is no version number in the <code>#__schemas</code> table for this extension ''prior to the update''. This value is determined by the last script name in the SQL updates folder. If this value is blank, no SQL scripts will be executed during that update cycle. To make sure this value is set correctly, make sure you have a SQL script in this folder with its name as the version number (for example, 1.2.3.sql if the version is 1.2.3). The file can be empty or just have a SQL comment line. This should be done in the old version -- the one before the update. Alternatively, you can add this value to the <code>#__schemas</code> using a SQL query.

= Supporting Tools =
Maintaining your update server files can be difficult depending on the manner in which you set up your files. An extension which can help you to maintain this is the Akeeba Release System, available free of charge from https://www.akeebabackup.com

= Contributors =
*[[User:mbabker|Michael Babker]]
[[Category:Development]]

Portal:Developers

2012-05-29T19:49:31Z

Goldenmean: /* Parameters */

{{RightTOC}}
{{Chunk:Developer profile}}

A complete contents list of all pages of interest to developers can be found in the [[:Category:Development|development category]].

== Reference Material ==

* [[Framework|Joomla Framework]].
* [http://api.joomla.org API documentation] automatically generated using phpDocumentor.

== Joomla Magazine Articles ==
* [http://magazine.joomla.org/issues/Issue-Apr-2012/item/709-Check-username-availability-with-Ajax Check username availability with Ajax]
* [http://magazine.joomla.org/issues/issue-feb-2012/item/671-Developing-a-Smart-Search-Plugin Developing a Smart Search plugin]
* [http://magazine.joomla.org/issues/issue-feb-2012/item/667-Customizing-an-Extensions-Edit-Screen Customising an extension's edit screen]
* [http://magazine.joomla.org/issues/Issue-Jan-2012/item/652-Integrating-WebSocket-to-Joomla Integrating WebSocket to Joomla]
* [http://magazine.joomla.org/issues/Issue-Jan-2012/item/648-Customising-Joomla-Help Customising Joomla help]
* [http://magazine.joomla.org/issues/Issue-Dec-2011/item/616-Write-your-own-App-using-Joomla-Platform Write you own app using the Joomla Platform]
* [http://magazine.joomla.org/issues/Issue-Nov-2011/item/591-Sorting-Articles-by-Recently-Touched-Date Sorting articles by recently touched date]
* [http://magazine.joomla.org/topics/item/447-using-doctrine-ORM-in-joomla Using Doctrine ORM in Joomla]
* [http://magazine.joomla.org/topics/item/429-templates-within-templates Rapid development techniques - Templates within templates]
* [http://magazine.joomla.org/topics/item/349-removing-mootools Rapid development techniques - Removing MooTools]
* [http://magazine.joomla.org/topics/item/325-Rapid-Development-Techniques-Preventing-Code-Fragmentation Rapid development techniques - Preventing code fragmentation]
* [http://magazine.joomla.org/topics/item/145-extending-joomla-mvc-architecture Extending Joomla's MVC architecture]

== Articles and Tutorials ==

{{underconstruction}}

=== General ===
* [[Setting up your workstation for PHP development]]. A step-by-step guide to configure a PHP development environment.
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [[Setting up your workstation for extension development]] A guide to Joomla Extension development
* [http://community.joomla.org/blogs/community/828-webinar-using-eclipse-for-joomla-development.html Using Eclipse for Joomla! Development] Video webinar demonstrating overview of Eclipse features for Joomla! development
* [[Extension development using eclipse and phing]] This article explains one way in which you can set up your workstation for writing Joomla! extensions. It assumes that you are using Eclipse and that you are familiar with using Eclipse for working with Joomla! and Subversion. For more information about the basics of getting started with Eclipse for Joomla! development.
* [[Tortoise SVN]]
* [[Running Automated Tests for Version 1.6]] {{JVer|1.6}}
* [[How to debug your code]] ([[Do not use die to debug]]!)
* [[Joomla Beginning Developer Course]]
* [[Secure coding guidelines]]
* [[Development Best Practices]]

=== Migration ===
* [[Adapting a Joomla 1.0 extension to Joomla 1.5]]
* [[Adapting a Joomla 1.5 extension to Joomla 1.6]]
* [[Version 1.6 Developer Notes]]
* [[Making single installation packages for Joomla! 1.5, 1.6 and 1.7]]

=== Components ===
{{RecReading|Component|dev|topic}}
=== Modules ===
{{RecReading|Module|dev|topic}}
=== Plugins ===
{{RecReading|Plugin|dev|topic}}
=== Templates ===
{{RecReading|Template|dev|topic}}
===Parameters===
* [[Standard parameter types]]
* [[Custom parameter types]]
* [[Component parameters]]
* [[Creating custom template parameter types]]
* See also: [[:Category:Parameters]]
* See also: [[:Form field]]

=== Core extensions summary ===
* [[Banner component]] {{JVer|1.6}}

=== Security ===
* [[How to add CSRF anti-spoofing to forms]]
* [http://developer.joomla.org/tutorials/181-preventing-sql-injections.html Preventing SQL Injections]
* [[Securing Joomla extensions]]

=== Database ===
* [[Accessing the database using JDatabase]]
* [[Using the JTable class]]
* [[Connecting to an external database]]
* [[Using nested sets]]

=== Localisation ===
* [http://community.joomla.org/magazine/article/508-developer-localization-advancements-in-joomla-15.html Localization Advancements in Joomla! 1.5]
* [[Adding multi-language support]]
* [[Language Guidelines for 3rd Party Extensions]]
* [[Adding Joomfish functionality to custom components]]
* [[Specification of language files]] {{JVer|1.6}}
* [[Language Metadata]] {{JVer|1.6}}
* [[Loading extra language files]]

=== Access Control ===
* [[Access Control System In Joomla 1.6]] {{JVer|1.6}}

=== Miscellaneous ===
* [[How to use the filesystem package]]
* [[API Execution Order]]
* [[Accessing the current user object]]
* [[Adding JavaScript and CSS to the page]]
* [[Constants]] used in the Joomla [[Framework]].
* [[Client-side form validation]]
* [[How to create a custom button]]
* [[How to create a stand-alone application using the Joomla! Framework]]
* [[How to use user state variables]]
* [[Adding template overridable images in your extension]]
* [[Retrieving data from GET and POST requests]]
* [[Cache]] and [[Using caching to speed up your code]]
* [[Using the installer API to support package installation]]
* [[How to add tooltips to your Joomla! website]]
* [[Display error messages and notices]].
* [[Errors]]
* [[Creating a custom form field type]] {{JVer|1.6}}

== Contributing to Joomla Development ==
The development of Joomla itself is carried out by the [[Development Working Group]] and third party developers.

* [[Participating in the community]]: a brief description of how people can get involved.
* [[Developer Email lists]]: a list of email lists for developers, including third party developers.
* [[Coding style and standards]] (To be reviewed).
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [http://docs.joomla.org/Setting_up_your_workstation_for_Joomla!_development_--_Part_2#Check_Out_Joomla.21_Source_Code How to check out SVN Code]
* [[Patch submission guidelines]].
* [[Filing bugs and issues]].
* [[How to release a distribution tarball]].
* [[How to create a continuous integration]].

== Contributing to Joomla Developer Documentation ==
The development of Joomla developer documentation is carried out primarily by the [[Documentation Working Group]]. There are currently two sub-projects of interest to developers:
* [[Joomla! 1.5 Template Tutorials Project]]
* [[API Reference Project]]

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

<pre><nowiki>[[Category:Development]]
</nowiki></pre>

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

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

* [[Adding configuration objects to modules and plugins]].
* [[Storing data in the session between page loads]].
* [[Suppressing output of extra HTML]].
* [[How to use the filter package]].
*: Describe how and when to use the Filter package and explain what needs to be filtered for various situations (for queries, for URLs, etc)
* [[How to use the registry package]]
* [[How to use JSimpleXML]].
*: How to load and store XML files and how to work with them
* [[How to create component feeds]] (RSS/ATOM)
* [[How to create PDF views]]
* [[How to generate paths for client side and server side]]
* [[How to access information from the request]]
*: This focuses on using the JBrowser class to retrieve information about the features available in the user's browser.
* [[How to create an editor plugin]]
* [[What can be done with a user plugin]]
* [[How to work with parameters]]
* [[How to cloak email addresses]]
* [[Using the caching system in your component]]. This might be enough (for now?) -> [[Cache]]
* [[Extending Joomla's MVC Architecture]]

==Joomla Security Guide==
Developers should also be aware of security issues.
{{Security Guide}}

[[Category:Development]]
[[Category:JED]]
[[Category:Joomla! user profiles]]

Archived:Upgrading a Joomla 1.5 template to Joomla 2.5

2012-05-10T23:03:08Z

Goldenmean: /* Template Parameters */

{{RightTOC}}
This page provides feedback on the process of upgrading or converting a Joomla 1.5 template for use with Joomla 1.6 and later versions from those who have already attempted it. This is intended to be a living document that can be added to as more experience is gained and is likely to be reorganised periodically. If you have encountered a problem when upgrading a template, or if you have any information that you think will help smooth the way for others who will follow then please add your comments initially on the Talk page. We will then collate the information and incorporate it into this page.

[[User:Chris Davenport|Chris Davenport]] prepared [http://www.slideshare.net/chrisdavenport/template-changes-for-joomla-16 slides for a presentation at the JoomlaDay UK 2010 event] which explain the changes in templates for Joomla! 1.6.

== Template Manifest File ==
There are important changes to the ''templateDetails.xml'' file:
# Add the new 1.6 Doctype
# Change the ''<install>'' tag to ''<extension>'' as shown below.
<pre>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 1.6//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.6/template-install.dtd">
<extension version="1.7" type="template" client="site">
</pre>
Notice the additional new ''client'' attribute which is set to ''site'' for a front-facing template and ''administrator'' for an back-end template.

Be sure to change the closing tag from ''</install>'' to ''</extension>''.

=== Template Parameters ===
In Joomla! 1.5, 1.6 and later versions, the template parameters are defined in templateDetails.xml.

Whereas in 1.5 parameters are defined as part of the <code><params></code> section, and each parameter is defined as a <code><param></code>, in 1.6 and later template parameters are contained in the <code><config></code> section and treated as a <code><field></code> nested within the <code><fieldset></code> and <code><fields></code> tags, as illustrated below.

<pre>
<config>
<fields name="params">
<fieldset name="basic">
<field name="" type=" default="" label="" description="">
<option value="1">On</option>
<option value="0">Off</option>
</field>
<field name="" type="" default="" label="e" description="" />
</fieldset>
</fields>
</config>
</pre>

<code><fieldset name="basic"></code> wraps the parameters in a grouping element. Using ''name="basic"'' labels that element as "Basic Options" and ''name="advanced"'' labels it as "Advanced Options".

The ''name'', ''type'', ''default'', ''label'' and ''description'' attributes still apply.

Outside of the main template files, you can access these parameters using the JApplication class. Previously, the values of the template parameters were stored in a plain text .ini file. In order to access those values outside of the template you needed to read the ini file and load the data into a JRegistry or JParameters object. Now, the values are stored in the database with other template information. We can load the params by passing the true variable to the getTemplate method of the JApplication object. It can be accessed like this:

<pre>
$app =& JFactory::getApplication();
$template = $app->getTemplate(true);
$params = $template->params;
$variable = $params->get('variable');
</pre>

This will allow you to access the template params in your layout overrides for other components, and modules.

== Objects and Methods ==
=== Sitename ===
* <code><?php echo $mainframe->getCfg('sitename');?></code> is now <code>$app->getCfg('sitename');</code> Where <code>$app = JFactory::getApplication();</code>

=== Error Codes ===
* <code>$this->error->code</code> is replaced by <code>$this->error->getCode();</code>
* <code>$this->error->message</code> is replaced by <code>$this->error->getMessage();</code>

== Discovery ==
In some cases your converted template may not be shown in the Template Manager even though all coding appears to be correct. Verify that your template files are installed in the ''/templates'' directory. Then run the Discover process as follows.
# Go to Administrator > Extensions > Extension Manager > Discover
# Click the Discover icon.
# If your template appears on the list, select it and then click the Install icon.

== Layout Overrides ==
=== com_content ===
If you have used the Beez overrides, or code derived from the Beez overrides, in your 1.5 template, you may encounter a ''JHtml::icon not supported. File not found.'' error when migrating the template to Joomla 1.6 and later. To fix this, simply add the following statement near the top of the template html/com_content/article/default.php file:
<source lang="php">
JHtml::addIncludePath( JPATH_COMPONENT . '/helpers' );
</source>

==Alternate Method Using a Version 2.5 Template==
Start with a basic template that works with a current version of Joomla. For this example, use the Atomic template that is supplied with Joomla 2.5.

# Copy the entire ''/templates/atomic'' folder to a new folder in the ''/templates'' directory.
# Rename this new folder. For instance, you might call it ''mysitename-atomic'' to designate it as the custom template for this site and adding the reminder that it was derived from the ''atomic'' template.
# In the new template's ''index.php'' file, delete everything between the ''<body> </body>'' tags.
# Copy and paste everything within the ''<body> </body>'' tags from your version 1.5 template to the body of the new template's ''index.php'' file.
# Delete or rename the ''template.css'' file copied from the Atomic template.
# Copy the ''template.css'' file from the old version 1.5 template.
# Update the ''templateDetails.xml'' file in the revised template.
## Change the ''<name>'' entry to match the name of the template folder. It is case-sensitive. If the folder is ''/templates/mysitename-atomic'', the entry in the ''templateDetails.xml'' file will be ''<name>mysitename-atomic</name>''.
## Replace the ''<positions>'' section of the file so that they match the positions used in the ''index.php'' file.
## Change the other elements as necessary. For instance, you might want to modify the creation date and version number.
# Delete images in the ''/template/image'' file and add your images.
# Delete the lines in the ''<head>'' section of the ''index.php'' file that load CSS and Javascript files that are not needed.

[[Category:Joomla! 1.6]]
[[Category:Template Development]]
[[Category:Tutorials]]

Archived:Upgrading a Joomla 1.5 template to Joomla 2.5

2012-05-10T22:14:01Z

Goldenmean: /* Template Parameters */

{{RightTOC}}
This page provides feedback on the process of upgrading or converting a Joomla 1.5 template for use with Joomla 1.6 and later versions from those who have already attempted it. This is intended to be a living document that can be added to as more experience is gained and is likely to be reorganised periodically. If you have encountered a problem when upgrading a template, or if you have any information that you think will help smooth the way for others who will follow then please add your comments initially on the Talk page. We will then collate the information and incorporate it into this page.

[[User:Chris Davenport|Chris Davenport]] prepared [http://www.slideshare.net/chrisdavenport/template-changes-for-joomla-16 slides for a presentation at the JoomlaDay UK 2010 event] which explain the changes in templates for Joomla! 1.6.

== Template Manifest File ==
There are important changes to the ''templateDetails.xml'' file:
# Add the new 1.6 Doctype
# Change the ''<install>'' tag to ''<extension>'' as shown below.
<pre>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC "-//Joomla! 1.6//DTD template 1.0//EN" "http://www.joomla.org/xml/dtd/1.6/template-install.dtd">
<extension version="1.7" type="template" client="site">
</pre>
Notice the additional new ''client'' attribute which is set to ''site'' for a front-facing template and ''administrator'' for an back-end template.

Be sure to change the closing tag from ''</install>'' to ''</extension>''.

=== Template Parameters ===
In Joomla! 1.5, 1.6 and later versions, the template parameters are defined in templateDetails.xml.

Whereas in 1.5 parameters are defined as part of the <code><params></code> section, and each parameter is defined as a <code><param></code>, in 1.6 and later template parameters are contained in the <code><config></code> section and treated as a <code><field></code> nested within the <code><fieldset></code> and <code><fields></code> tags, as illustrated below.

<pre>
<config>
<fields name="params">
<fieldset name="basic">
<field name="" type=" default="" label="" description="">
<option value="1">On</option>
<option value="0">Off</option>
</field>
<field name="" type="" default="" label="e" description="" />
</fieldset>
</fields>
</config>
</pre>

<code><fieldset name="basic"></code> wraps the parameters in a grouping element. Using ''name="basic"'' labels that element as "Basic Options" and ''name="advanced"'' labels it as "Advanced Options".

The ''name'', ''type'', ''default'', ''label'' and ''description'' attributes still apply.

Outside of the main template files, you can access these parameters using the JDocument class. Previously, the values of the template parameters were stored in a plain text .ini file. In order to access those values outside of the template you needed to read the ini file and load the data into a JRegistry or JParameters object. Now, the values are stored in the params variable of the JDocumentHTML object. It can be accessed like this:

<pre>
$document =& JFactory::getDocument();
$params = $document->get('params');
$google = $params->get('analytics_id');
</pre>

This will allow you to access the template params in your layout overrides for other components.

== Objects and Methods ==
=== Sitename ===
* <code><?php echo $mainframe->getCfg('sitename');?></code> is now <code>$app->getCfg('sitename');</code> Where <code>$app = JFactory::getApplication();</code>

=== Error Codes ===
* <code>$this->error->code</code> is replaced by <code>$this->error->getCode();</code>
* <code>$this->error->message</code> is replaced by <code>$this->error->getMessage();</code>

== Discovery ==
In some cases your converted template may not be shown in the Template Manager even though all coding appears to be correct. Verify that your template files are installed in the ''/templates'' directory. Then run the Discover process as follows.
# Go to Administrator > Extensions > Extension Manager > Discover
# Click the Discover icon.
# If your template appears on the list, select it and then click the Install icon.

== Layout Overrides ==
=== com_content ===
If you have used the Beez overrides, or code derived from the Beez overrides, in your 1.5 template, you may encounter a ''JHtml::icon not supported. File not found.'' error when migrating the template to Joomla 1.6 and later. To fix this, simply add the following statement near the top of the template html/com_content/article/default.php file:
<source lang="php">
JHtml::addIncludePath( JPATH_COMPONENT . '/helpers' );
</source>

==Alternate Method Using a Version 2.5 Template==
Start with a basic template that works with a current version of Joomla. For this example, use the Atomic template that is supplied with Joomla 2.5.

# Copy the entire ''/templates/atomic'' folder to a new folder in the ''/templates'' directory.
# Rename this new folder. For instance, you might call it ''mysitename-atomic'' to designate it as the custom template for this site and adding the reminder that it was derived from the ''atomic'' template.
# In the new template's ''index.php'' file, delete everything between the ''<body> </body>'' tags.
# Copy and paste everything within the ''<body> </body>'' tags from your version 1.5 template to the body of the new template's ''index.php'' file.
# Delete or rename the ''template.css'' file copied from the Atomic template.
# Copy the ''template.css'' file from the old version 1.5 template.
# Update the ''templateDetails.xml'' file in the revised template.
## Change the ''<name>'' entry to match the name of the template folder. It is case-sensitive. If the folder is ''/templates/mysitename-atomic'', the entry in the ''templateDetails.xml'' file will be ''<name>mysitename-atomic</name>''.
## Replace the ''<positions>'' section of the file so that they match the positions used in the ''index.php'' file.
## Change the other elements as necessary. For instance, you might want to modify the creation date and version number.
# Delete images in the ''/template/image'' file and add your images.
# Delete the lines in the ''<head>'' section of the ''index.php'' file that load CSS and Javascript files that are not needed.

[[Category:Joomla! 1.6]]
[[Category:Template Development]]
[[Category:Tutorials]]