304
edits
Module development: Difference between revisions
Jump to navigation
Jump to search
m
→Create your module descriptor
| Line 30: | Line 30: | ||
=== Create your module descriptor === | === Create your module descriptor === | ||
The first step is to create a file descriptor for the module. | The first step is to create a file descriptor for the module. | ||
* Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php | * Create directory '''/htdocs/''mymodule''/core/modules'''. Then copy the file modMyModule.class.php from the directory dev/skeletons into this directory '''htdocs/''mymodule''/core/modules'''. Change the name of the file modMyModule.class.php to the name corresponding to the purpose of your module. Name of the file must start with initial 'mod' and end with .class.php (for example if you want to give the name 'NewName' to your file, then the name should be 'modNewName.class.php'). | ||
Next modify the contents of this file as follows: | Next modify the contents of this file as follows: | ||
* Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters. | * Replace all "modMyModule" with a value which corresponds to the purpose of your module. This value must always start with 'mod' and contain only alpha characters (again, if the name given to the file was 'NewName', then replace all "modMyModule" with "modNewName"). | ||
* Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]]. | * Change the number in: $this->numero = 100000 by a number that designates your module id. To avoid conflicts with other modules, you can consult tha page that lists already reserved id numbers: [[List of modules id|List of modules id]]. | ||
* Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning). | * Modify any other variables defined in the constructor (see comment in the code skeleton for their meaning). | ||