Changes between Version 3 and Version 4 of adeiNewModule
- Timestamp:
- 07/16/09 16:49:21 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
adeiNewModule
v3 v4 4 4 * ''Control'' module provides access to the control information 5 5 6 It is possible to register new modules providing additional system-specific information. For this, it is necessary to create module file in ADEI ''modules/'' subdirectory. This file should include 3 mandatory methods (the ''module'' prefix should be replaced with actual module name. For example, for alarms module instead of ''$module_title'', the ''$alarms_tittle'' should be used):6 It is possible to register new modules providing additional system-specific information. For this, it is necessary to create module file in ADEI ''modules/'' subdirectory. This file should include 3 mandatory methods (the ''module'' prefix should be replaced with actual file name without php extension, called the module name. For example, for alarms module instead of ''$module_title'', the ''$alarms_tittle'' should be used): 7 7 * The variable ''module_title'' contains the module name (as it should be shown to the users in menu): 8 8 {{{$module_title = _("Title of the Module")}}} 15 15 When the module is ready it should be enabled in the configuration file ''config.php'' (or in the appropriate ''setup'' if it should be used optionally). 16 16 17 18 17 The ADEI includes several JavaScript classes providing standard use-cases. They are described bellow. 19 18 20 19 == XML Module == 21 This module uses an ''ADEI service'' generating XML content and XSLT stylesheet to update information on the page. The ''modulePage'' function should just define a single ''div'' element: 20 This module uses an ''ADEI service'' generating XML content and XSLT stylesheet to update information on the page. 21 The ''modulePage'' function should just define a single ''div'' element: 22 22 {{{<div id="module_div" class="xml_module">Loading...</div>}}} 23 23 The ''moduleJS'' function initializes new XMLMODULE object supplying the id of div created in ''modulePage'' function: 26 26 {{{ return "module_object"; }}} 27 27 28 Complete example (alarms module):28 Complete example of a module (alarms module): 29 29 {{{ 30 30 $alarms_title = _("Alarms"); 37 37 } 38 38 }}} 39 40 By default, the service ''module_name'' is used to obtain XML document and stylesheet ''module_name'' 41 is used to covert XML into the HTML. The service should reside in the ''services/'' subdirectory (read about creating services [wiki:adeiNewService here]). The XSLT stylesheet should be placed in the ''xslt'' folder. However, it is possible to have more elaborated service configuration. For that it is necessary to define special ''update'' service. This service should be created in ''services/update'' directory and be named ''module_name.php''. It should contain a single function, called ''ADEIServiceGetUpdateInfo'', which accept a ''REQUEST'' object as a parameter and return associative array with two elements: 42 * ''xml'' - specifying the full URL of update service along with all properties (the current options could be obtained and modified using ''GetQueryString'' method of ''REQUEST'' object, see example bellow) 43 * ''xslt'' - specifying the name of XSLT stylesheet (without extension) 44 45 The function is executed on each update and, therefore, can dinamically select the appropriate service depending on some of request parameters. 46 47 Example, the ''alarams'' update service (it uses ''control.php'' service to get XML data and adds two additional parameters to the REQUEST properties): 48 {{{ 49 function ADEIServiceGetUpdateInfo(REQUEST $req) { 50 if ($req->CheckData()) { 51 $query = $req->GetQueryString($extra = array( 52 "target" => "alarms_summary", 53 "time_format" => "text" 54 )); 55 56 return array( 57 "xml" => "services/control.php?$query", 58 "xslt" => "alarms" 59 ); 60 } 61 return false; 62 } 63 }}}
