O Instalador de Módulos

$manifest

The $manifest array provides information on the package itself such as it’s name, readme etc. (it also defines the copy array for patch packages). A sample definition of the manifest array will appear something like this:

name

The name of the package. This is how the package will appear to the user during installation and in the Module Loader package list. The package name is required.

description

A brief description of the package.

version

The version of this package. This can be any string but is usually a traditional version number (such as 3.1.4).

author

The author of the package.

readme

A brief readme string. Note that if a README.txt is found in the root of the package this will be used instead.

acceptable_sugar_flavors

A remnant of the SugarCRM packages. This should always be an array with (at least) a CE entry. If you would like the installer to target both HelloCloud and SugarCRM editions then this can contain one of the other SugarCRM flavours (PRO, CORP , ULT or ENT).

acceptable_sugar_versions

An array detailing the matching SugarCRM versions. Note that the SugarCRM version is distinct from the HelloCloud version. This array has two keys. exact_matches is simply an array of the allowed versions. regex_matches allows specifying regexes to match versions. For HelloCloud you only need to worry about supporting the 6.5.* versions which can be matched with the regex 6\.5\.[0-9]$. At the time of writing the current SugarCRM version for HelloCloud is 6.5.20.

copy_files

This is only used for patch installers and will copy files in the from_dir key to those in the to_dir key. Finally the force_copy key can be used to specify files that should be forcibly copied over.

dependencies

An array of other packages that are relied on by this package. Each entry is an array with id_name - the id of the package and version the required version of the package.

icon

The path (within the installer) to an icon to be displayed during installation.

is_uninstallable

Whether or not uninstalls should be allowed.

published_date

The date that the package was published. There is no fixed format for the date, it is simply a string.

key

Specifies a key to ensure that modules do not clash. This will prefix the installed modules and tables with key. This is used by the module builder when creating packages but can be specified if you wish.

remove_tables

A string specifying whether module tables should be removed when uninstalling this package. Accepted values are true, false and prompt. The default is true.

type

The type of the installer, one of langpack, module, patch or theme. See the types section.

$manifest = array(
   'name' => 'Example manifest',
   'description' => 'A basic manifest example',
   'version' => '1.2.3',
   'author' => 'Jim Mackin',
   'readme' => 'This is a manifest example for the HelloCloud for Developers book',
   'acceptable_sugar_flavors' => array('CE'),
   'acceptable_sugar_versions' => array(
       'exact_matches' => array('6.5.20',),
   ),
   'dependencies' => array(
     array(
       'id_name' => 'hello_world',
       'version' => '3.2.1'
     ),
   ),
   'icon' => 'ManifestExample.png',
   'is_uninstallable' => true,
   'published_date' => '2015-05-05',
   'type' => 'module',
   'remove_tables' => 'prompt',
 );
 $installdefs = array(
   'id' => 'hellocloudfordevelopers_example_manifest',
   'image_dir' => '/images/',
   'copy' => array(
     array(
       'from' => '/modules/ExampleModule',
       'to' => 'modules/ExampleModule',
     ),
   ),
   'dashlets' => array(
     array(
       'from' => '/modules/ExampleModule/Dashlets/',
       'name' => 'ExampleModuleDashlet'
     )
   ),
   'language' => array(
     array(
       'from' => 'application/language/en_us.examplemoduleadmin.php',
       'to_module' => 'application',
       'language' => 'en_us'
     ),
     array(
       'from' => '/modules/Accounts/language/en_us.examplemodule.php',
       'to_module' => 'Accounts',
       'language' => 'en_us'
     ),
     array(
       'from' => '/application/language/es_es.examplemoduleadmin.php',
       'to_module' => 'application',
       'language' => 'es_es'
     ),
     array(
       'from' => '/modules/Accounts/language/es_es.examplemodule.php',
       'to_module' => 'Accounts',
       'language' => 'es_es'
     ),
   ),
   'custom_fields' => array(
     array(
       'name' => 'example_field',
       'label' => 'Example Field',
       'type' => 'varchar',
       'max_size' =>  100,
       'module' => 'Accounts',
     ),
   ),
   'vardefs' => array(
     array(
       'from' => 'modules/Accounts/vardefs/examplemodule_vardefs.php',
       'to_module' => 'Accounts',
     ),
   ),
   'beans' => array(
     array(
       'module' => 'ExampleModule',
       'class' => 'ExampleModule',
       'path' => 'modules/ExampleModule/ExampleModule.php',
     ),
   ),
   'logic_hooks' => array(
     array(
       'module' => 'Accounts',
       'hook' => 'before_save',
       'order' => 100,
       'description'  => 'Example module before save hook',
       'file' => 'modules/ExampleModule/ExampleModuleHook.php',
       'class' => 'ExampleModuleLogicHooks',
       'function' => 'accounts_before_save',
     ),
   ),
   'administration' => array(
     array(
       'from' => 'modules/administration/examplemodule_admin.php',
     ),
   ),
 );
 $upgrade_manifest = array(
);