Roxen.git
/
server
/
modules
/
examples
/
common_api.pike
version
»
Context lines:
10
20
40
80
file
none
3
Roxen.git/server/modules/examples/common_api.pike:2:
// All roxen modules must inherit module.pike #include <roxen.h> // include roxen.h for locale specific stuff // Some defines for the translation system // //<locale-token project="mod_common_api">LOCALE</locale-token> #define LOCALE(X,Y) _DEF_LOCALE("mod_common_api",X,Y) // end of the locale related stuff
-
constant cvs_version="$Id: common_api.pike,v 1.
5
2000/
11
/
27
06
:
17
:
12
per Exp $";
+
constant cvs_version="$Id: common_api.pike,v 1.
6
2000/
12
/
02
19
:
26
:
11
per Exp $";
//! This string (filtered to remove some ugly cvs id markup) shows up in //! the roxen administration interface when handling module parameters in //! developer mode (configured under "User Settings" below the Admin tab). //! It will also serve as the basis for extracting version information of //! the file in the inherit tree. Optional, but convenient, especially if //! you use cvs for version control of your code. LocaleString module_name_locale = LOCALE(1,"Tamaroxchi"); //! The name that will show up in the module listings when adding modules //! or viewing the modules of a virtual server. Keep it fairly informative
Roxen.git/server/modules/examples/common_api.pike:64:
//! virtual server the module was initialized in is always passed, //! except for the one occation when the file is compiled for the //! first time, when the `conf' argument passed is 0. Se also //! <ref>start</ref>. { //report_debug("tamaroxchi(%O)\n", conf); // Ends up in the debug log set_module_creator("Johan Sundström <jhs@roxen.com>"); set_module_url("https://jhs.user.roxen.com/examples/common_api.html"); }
-
mapping(
string
:function(RequestID:void)) query_action_buttons(
RequestID id
)
+
mapping(
LocaleString
:function(RequestID:void)) query_action_buttons(RequestID id)
//! Optional callback for adding action buttons to the module's //! administration settings page; convenient for triggering module //! actions like flushing caches and the like. //! //! The indices of the returned mapping are the action descriptions that will //! show up on each button (e g "flush cache"), and the corresponding values //! are the callbacks for each button respectively. These functions may take //! an optional RequestID argument, where this id object refers to the id //! object in the admin interface sent with the request used to invoke the //! action by the administrator.