Commit 3f478fac authored by Chris Graham's avatar Chris Graham
Browse files

Fixed MANTIS-3997 (addon_registry hooks install/uninstall functionality not documented)

parent 7d0b770b
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -170,7 +170,7 @@ There is one important rule when it comes to programmatic alteration: you are no
You will only be able to export files into an addon from directories that are 'allowed' to contain new or modified files. For example, the [tt]sources[/tt] directory should not be modified, but the [tt]sources_custom[/tt] directory may. This is part of the file override system Composr employs: modified versions of old files or entirely new files should be placed in the custom version of a directory so that it is clear they are non-original, and will not be automatically overwritten during upgrade. There are a few directories that have no [tt]_custom[/tt] equivalent, and therefore you may export files to a mod from these.
Overridden PHP files may override on a per-function/per-class level. In other words, if you overrode a PHP file then you could make your [tt]sources_custom[/tt] file such that the only functions/classes it contains are the ones that you changed.

Addon TAR files contain an [tt]addon.inf[/tt] file that specifies the metadata for an addon. Addons bundled in the Composr git repository use [tt]addon_registry[/tt] files instead, which is a bit cleaner. If you want to manage your addon using a registry file then when you choose to export your addon select only that registry file: the metadata will be taken from that file, as well as auto-selecting all the files of the addon. Once an addon is installed the registry file takes precedence of any metadata stored in the database.
Addon TAR files contain an [tt]addon.inf[/tt] file that specifies the metadata for an addon. Addons bundled in the Composr git repository use [tt]addon_registry[/tt] files instead, which is a bit cleaner, and also presents the possibility of install/uninstall code directly attached to an addon rather than an addon's blocks or modules (if it even has any). If you want to manage your addon using a registry file then when you choose to export your addon select only that registry file: the metadata will be taken from that file, as well as auto-selecting all the files of the addon. Once an addon is installed the registry file takes precedence of any metadata stored in the database.

The date/time of the exported addon TAR file will be the date/time of the most recent file within it.
[/surround]