OMQ::QorusExtensionHandler Class Reference

this class is used to define a Qorus UI extension in a Qorus service More...

Inheritance diagram for OMQ::QorusExtensionHandler:

Public Member Functions
	constructor (string $group, string $menuname, string $desc)
	creates the extension handler object from the arguments More...
string	getGroup ()
	returns the group name
string	getMenuName ()
	returns the menu name
string	getDesc ()
	returns the description

Private Attributes
string	group
	menu group
string	menuname
	extension description
string	desc
	extension description
Private Attributes inherited from OMQ::AbstractServiceHttpHandler
string	url
	The path string or regex to match incoming requests.
*softlist	content_type
	the content-type to check
*softlist	special_headers
	list of special headers; if a request has any of these HTTP headers, then the requests will match this handler
list	listeners = ()
	list of listener info; do not write to this list directly, use AbstractServiceHttpHandler::addListener() instead (the internal format may change)
hash	tld
	thread-local data to add before calling handleRequest()
code	svcc
	a closure that allows specific Service methods to be called
*string	utype
	the type/heading for user HTTP services
*string	utitle
	the title for user HTTP services
*string	uurl
	the URL for user HTTP services
bool	isregex
	if the path is a regex or a string
*string	default_resource
	the default resource to serve
hash	svcinfo
	service info hash

Additional Inherited Members
Private Member Functions inherited from OMQ::AbstractServiceHttpHandler
	constructor (string $path, *softlist $content_type, *softlist $special_headers, HttpServer::AbstractAuthenticator $auth=new DefaultQorusRBACAuthenticator(), bool $isregex=True)
	creates the object with the given arguments More...
hash	getServiceInfo ()
	returns a hash with info about the linked service
	addListener (softstring $bind, *string $cert_path, *string $key_path)
	adds a listener from a bind string in the format: "address:port" (ex: "192.168.20.1:8011") More...
	addListener (softstring $bind, *Qore::SSLCertificate $cert, *Qore::SSLPrivateKey $key)
	adds a listener from a bind string in the format: "address:port" (ex: "192.168.20.1:8011") More...
	addListeners (softlist $l)
	adds a list of listeners; each element should be either a bind string in the format: "address:port" (ex: "192.168.20.1:8011") or an integer port, meaning to bind on all interfaces on that port More...
*hash	saveThreadLocalData ()
	called before handleRequest() any data returned here will be given to restoreThreadLocalData() after the handleRequest() call
	restoreThreadLocalData (*hash $data)
	called after handleRequest() with any data returned from saveThreadLocalData()
	log (int $ll, string $fmt)
	logs to the service log file
	setUserIndexInfo (string $heading, string $title, string $url)
	sets heading and title for user HTTP services
hash	handleRequest (hash $cx, hash $hdr, *data $body)
	this method calls handleRequestImpl() to service the request, if handleRequestImpl() returns NOTHING, then it tries to automatically serve service file resources or serve the default resource if no resource can be matched More...
string	getRequestPath (string $hpath)
	returns the request path with the common leading part of the URL stripped off and also any URI query argument stripped off
*hash	handleRequestImpl (reference $cx, hash $hdr, *data $body)
	this method is called by this class's handleRequest() before trying to service the request automatically based on service file resources More...
	setDefaultResource (string $name)
	sets the default service file resource to be rendered when the request is not matched to a resource and handleRequestImpl() does not return a response

Detailed Description

this class is used to define a Qorus UI extension in a Qorus service

See also

ui_extension_register()

Member Function Documentation

OMQ::QorusExtensionHandler::constructor ( string  $group, string  $menuname, string  $desc  )

inline

creates the extension handler object from the arguments

Parameters

group	the menu group name; extensions with the same group name will be grouped together in the extension menu
menuname	the menu name for this extension
desc	a descriptive string for the UI extension

---

The documentation for this class was generated from the following file:

• AbstractServiceHttpHandler.qc