Archived:Managing Component Updates (How to use this example)

This page has been archived. This page contains information for an unsupported Joomla! version or is no longer relevant. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

<sidebar>

• Joomla!
  • http://www.joomla.org | Main
  • http://community.joomla.org | Community
  • http://forum.joomla.org | Forum
  • http://extensions.joomla.org | Extensions
  • http://shop.joomla.org | Shop
  • http://developer.joomla.org | Developers
  • http://api.joomla.org | API

• Managing Component Updates
  • 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
• Help
  • JDOC:How to Contribute to Joomla! Documentation|Contribute to Joomla! Docs
  • JDOC:Documentation_Translators|Translate Joomla! Docs
  • Help:Cheatsheet|Editing Help
  • Sandbox|Play in the Sandbox
  • JDOC:Wiki_policy|JDOC's Policies
  • JEDL|Documentation License
  • helppage|More Help

</sidebar>

This Page Needs Your Help

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

• Kim Eckert