Common libraries for our extension installer scripts
A special <alledia>
tag is recognized in the manifest for control of various aspects
of installation. Note that boolean attribute values can be specified using true/false or 1/0.
<alledia>
<element publish="bool">elementname</element>
<namespace>ExtensionName</namespace>
<name>CustomName</name>
<license>free | pro</license>
<targetplatform>.*</targetplatform>
<phpminimum>.*</phpminimum>
<previousminimum>.*</previousminimum>
<relatedExtensions downgrade="bool"
publish="bool"
uninstall="bool">
<extension type="string"
element="string"
group="string"
publish="bool"
ordering="string"
uninstall="bool">
ExtensionFolder
</extension>
</relatedExtensions>
<obsolete>
<extension
type="string"
group="string"
element="fullName"/>
<folder>/components/com_mycomponent/oldfolder</folder>
<file>/components/com_mycomponent/oldfile.php</file>
<file>/administrator/components/com_mycomponent/oldfile.php</file>
</obsolete>
</alledia>
This is the Joomla extension name.e.g. com_mycomponent
.
related extensions can be installed as part of a main package. the attributes publish
, downgrade
and uninstall
can be used as defaults for the enclosed <extension>
items. All three default to false
if not used.
Obsolete items will be unistalled or deleted before installing any related extension. You can set 3 types of obsolete items: extension, file and folder. For file and folder, use relative paths to the site root.
The following attributes are recognized in the <extension>
tag.
Atributes available under
<relatedExtensions>
are marked 'R'. Those available under <obsolete>
with 'O'.
Tag | Valid | Values |
---|---|---|
type | RO | plugin, module, component, etc. |
group | RO | For plugins, the plugin folder. Otherwise ignored. |
element | RO | extension element name (without prefix, e.g. 'com_' |
downgrade | R | true | false -- okay to downgrade on a reinstall |
publish | R | true | false -- used for plugins only |
ordering | R | # | first | last | before:pluginelement | after:pluginelement Applies only for new installations |
uninstall | R | true | false -- uninstall during uninstall of the current extension |
Joomla 3.9+ php 7.2+