Actions

Difference between revisions of "Package"

From Joomla! Documentation

(Added library and system plugin examples. Fix bad ids that cause issues uninstalling package. Also added author and creation date that will be shown in extension manager)
(How do I create a package?)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
== Note on component dependant modules==
 +
Sometimes modules (or plugins etc.) use a component's models and helpers and such. In these occasions it would be nice to be able to package your module in this way that it gets uninstalled when the component itself gets uninstalled.  This is called dependency management which has been desired in joomla but hasn't been done yet.
 +
It is suggested to follow the standards and just using a package as is described below.
 +
 +
 
== What is a package? ==
 
== What is a package? ==
  
A package is a extension that is used to install multiple extensions in one go. This is used if you have for example a component and a module that are depending on each other. Combining them in a package will let the user install and uninstall both extensions in one go. Package extensions can be used with Joomla [[File:Compat icon 1 6.png]] and higher.
+
A package is a extension that is used to install multiple extensions in one go. This is used if you have for example a component and a module that are depending on each other. Combining them in a package will let the user install and uninstall both extensions in one go. Package extensions can be used with Joomla {{JVer|2.5}} and higher.
  
 
== How do I create a package? ==
 
== How do I create a package? ==
Line 11: Line 16:
 
* '''library''' helloworld  
 
* '''library''' helloworld  
 
* '''system plugin''' helloworld  
 
* '''system plugin''' helloworld  
 +
* '''template''' helloworld
  
 
The package should have the following tree in your zipfile:
 
The package should have the following tree in your zipfile:
Line 20: Line 26:
 
       |-- lib_helloworld.zip
 
       |-- lib_helloworld.zip
 
       |-- plg_sys_helloworld.zip
 
       |-- plg_sys_helloworld.zip
 +
      |-- tpl_helloworld.zip
  
 
The pkg_helloworld.xml could have the following contents:
 
The pkg_helloworld.xml could have the following contents:
Line 41: Line 48:
 
   <file type="library" id="helloworld">lib_helloworld.zip</file>
 
   <file type="library" id="helloworld">lib_helloworld.zip</file>
 
   <file type="plugin" id="helloworld" group="system">plg_sys_helloworld.zip</file>
 
   <file type="plugin" id="helloworld" group="system">plg_sys_helloworld.zip</file>
 +
  <file type="template" id="helloworld" client="site">tpl_helloworld.zip</file>
 
  </files>
 
  </files>
 
  </extension>
 
  </extension>
Line 48: Line 56:
  
 
Remember to use the package uninstaller instead of individual subpackage uninstallers to avoid orphan extension entries in the extension manager.
 
Remember to use the package uninstaller instead of individual subpackage uninstallers to avoid orphan extension entries in the extension manager.
 +
 +
=== Id= <file id="not_arbitrary"> ===
 +
The id element in <file ..> tag are NOT arbitrary!. The "id=" should be set to the value of of the "element" comlumn in the "#__extensions" table. If they are not set correctly, upon uninstalling of the package the children ( <file> ) will NOT be found and uninstalled.
 +
 +
=== Manifest filename and packagename ===
 +
The naming of the manifest file and the ability to uninstall the package file itself are closely related.
 +
The manifest file must have a "pkg_" prefix, he remainder of the manifest name ( without .xml extension ) is to be used as <packagename>. Or, the other way around, a package you want to identify as "blurpblurp_J3" get that as its <packagename> and should be in a manifest file named "pkg_blurpblurp_J3.xml". Failure to do so will make it impossible to uninstall the package itself.
  
 
[[Category:Extensions| Package]]
 
[[Category:Extensions| Package]]

Latest revision as of 06:42, 28 December 2013

Contents

Note on component dependant modules

Sometimes modules (or plugins etc.) use a component's models and helpers and such. In these occasions it would be nice to be able to package your module in this way that it gets uninstalled when the component itself gets uninstalled. This is called dependency management which has been desired in joomla but hasn't been done yet. It is suggested to follow the standards and just using a package as is described below.


What is a package?

A package is a extension that is used to install multiple extensions in one go. This is used if you have for example a component and a module that are depending on each other. Combining them in a package will let the user install and uninstall both extensions in one go. Package extensions can be used with Joomla Joomla 2.5 and higher.

How do I create a package?

A package extension is created by zipping all zip files of the extensions together with a xml manifest file. For example if you have a package composed by:

  • component helloworld
  • module helloworld
  • library helloworld
  • system plugin helloworld
  • template helloworld

The package should have the following tree in your zipfile:

 -- pkg_helloworld.xml
 -- packages <dir>
     |-- com_helloworld.zip
     |-- mod_helloworld.zip
     |-- lib_helloworld.zip
     |-- plg_sys_helloworld.zip
     |-- tpl_helloworld.zip

The pkg_helloworld.xml could have the following contents:

 <?xml version="1.0" encoding="UTF-8" ?>
 <extension type="package" version="1.6">
 <name>Hello World Package</name>
 <author>Hello World Package Team</author>
 <creationDate>May 2012</creationDate>
 <packagename>helloworld</packagename>
 <version>1.0.0</version>
 <url>http://www.yoururl.com/</url>
 <packager>Hello World Package Team</packager>
 <packagerurl>http://www.yoururl.com/</packagerurl>
 <description>Example package to combine multiple extensions</description>
 <update>http://www.updateurl.com/update</update>
 <files folder="packages">
   <file type="component" id="helloworld" >com_helloworld.zip</file>
   <file type="module" id="helloworld" client="site">mod_helloworld.zip</file>
   <file type="library" id="helloworld">lib_helloworld.zip</file>
   <file type="plugin" id="helloworld" group="system">plg_sys_helloworld.zip</file>
   <file type="template" id="helloworld" client="site">tpl_helloworld.zip</file>
 </files>
 </extension>

When you zip this and try to install it, you will see that every extension will be installed. Also the package will be visible in the extension list to uninstall all the extension of this package.

Remember to use the package uninstaller instead of individual subpackage uninstallers to avoid orphan extension entries in the extension manager.

Id= <file id="not_arbitrary">

The id element in <file ..> tag are NOT arbitrary!. The "id=" should be set to the value of of the "element" comlumn in the "#__extensions" table. If they are not set correctly, upon uninstalling of the package the children ( <file> ) will NOT be found and uninstalled.

Manifest filename and packagename

The naming of the manifest file and the ability to uninstall the package file itself are closely related. The manifest file must have a "pkg_" prefix, he remainder of the manifest name ( without .xml extension ) is to be used as <packagename>. Or, the other way around, a package you want to identify as "blurpblurp_J3" get that as its <packagename> and should be in a manifest file named "pkg_blurpblurp_J3.xml". Failure to do so will make it impossible to uninstall the package itself.