register_module()
array register_module()
The register_module() returns an array describing
the module. The array shall have the following contents:
({ module_type, name, description, 0, only_one_copy })
- module_type
-
is an integer with a bitfield of the module's type. The type is
obtained either by using one type constant or by using the bitwise or
operator ('|') on several. The module type constants are; MODULE_EXTENSION,
MODULE_LOCATION, MODULE_URL, MODULE_FILE_EXTENSION, MODULE_PARSER,
MODULE_LAST, MODULE_FIRST, MODULE_AUTH,
MODULE_DIRECTORIES, MODULE_LOGGER and MODULE_FILTER.
ditem>name
is a string containing the name of the module. This can later be
overridden by implementing a name() method.
- description
-
is a string containing a longer description of the module, that will
be shown in the configuration interface. It can later be overridden by
implementing an info() method.
- only_one_copy
-
determines if it should be possible to have more than one copy of the
module per virtual server. If zero it will be possible to have several
copies. If set to another value it will only be possible to have one
copy per virtual server.
|