Installdef Definition

The following section outlines the parameters specified in the $installdef array contained in the manifest file (manifest.php). An example manifest file is included later for your reference.

$installdef array elements are used by the Module Loader to determine the actual installation steps that need to be taken to install the extension.

•	id - A unique name for your module, i.e. “Songs”

•	copy - An array detailing files to be copied to the Sugar directory. A source path and destination path must be specified for each file or directory. See the example manifest file below for details.

•	language - An array detailing individual language files for your module. The source path, destination file, and language pack name must be specified for each language file. See the example manifest file below for details.

•	layoutdefs - An array detailing individual layoutdef files, which are used primarily for setting up subpanels in other modules. The source path and destination module must be specified for each layoutdef file. See the example manifest file below for details.

•	vardefs - An array detailing individual vardef files, which are used primarily for defining fields and non many-to-many relationships in other modules. The source path and destination module must be specified for each vardef file. See the example manifest file below for details.

•	menu - An array detailing the menu file for your new module. A source path and destination module must be specified for each menu file. See the example manifest file below for details.

•	beans - An array specifying the bean files for your new module. The following subdirectives must be specified for each bean:

o	module: Your module’s name, e.g. “Songs”

o	class: Your module’s primary class name, e.g. “Song”

o	path: The path to your bean file where the above class is defined.

o	tab: Controls whether or not your new module appears as a tab.

o	relationships - An array detailing relationship files, used to link your new modules to existing modules. A module name, meta_data path, and module_vardefs path must be specified for each relationship. See the example manifest file below for details.

o	custom_fields - An array detailing custom fields to be installed for your new module. The following subdirectives must be specified for each custom field:

	name: The internal name of your custom field. Note that your custom field will be referred to as <name>_c, as “_c” indicates a custom field.

	label: The visible label of your custom field

	type: The type of custom field. Accepted values include text, textarea, double, float, int, date, bool, enum, and relate.

	max_size: The custom field’s maximum character storage size

	require_option: Used to mark custom fields are either required or option. Accepted values include optional and required.

	default_value: Used to specify a default value for your custom field

	ext1: Used to specify a dropdown name (only applicable to enum type custom fields)

	ext2: Unused

	ext3: Unused

	audited: Used to denote whether or not the custom field should be audited. Accepted values include 0 and 1.

	module: Used to specify the module where the custom field will be added.

Sugar Developer Guide