WACS: Application Programming Interface
Contents
API definition
Below is a single line summary of each of the exported functions
from the WACS support perl module. Much more detailed information
and comments can be found in the source code to the perl module
itself.
read_conf() - locate and read the XML based configuration file
conf_get_attr() - get the requested configuration attribute
check_auth() - check that this is an authorised access
auth_user() - return the registered username for this IP
auth_get_attr() - get the requested access control list attribute
describeher() - tries to make a sensible sentance out of model data
whatshedoes() - describes the kind of sets this model appears in
geticonlist() - gets the icon array for the specified object type
addkeyicons() - makes a little HTML table with the attribute icons
gettypecolour() - return background to use for this media type
divideup() - make directory name more readable
iconlink() - build a link around the icon for this set
alsofeaturing() - find and list any other models featured in this set
checkexclude() - check for this file name being one to ignore/hide
addlinks() - add standard navigation links
Next Section: Database
Back to WACS Documentation Index