Package trac :: Package ticket :: Module report :: Class ReportModule

Class ReportModule

    object --+    
             |    
core.Component --+
                 |
                ReportModule

Nested Classes
Inherited from `core.Component`: `__metaclass__`

Instance Methods

get_active_navigation_item(self, req)

source code

get_navigation_items(self, req)

source code

get_permission_actions(self)

source code

match_request(self, req)

source code

process_request(self, req)

source code

execute_paginated_report(self, req, id, sql, args, limit=0, offset=0)

source code

get_var_args(self, req)

source code

get_default_var_args(self, report_args, sql)

source code

sql_sub_vars(self, sql, args)
Extract $XYZ-style variables from the sql query. source code

get_link_resolvers(self)

source code

get_wiki_syntax(self)

source code

Inherited from core.Component: __repr__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods
Inherited from `core.Component`: `implements`

Class Variables
	realm = `'report'`
	items_per_page = `<IntOption [report] 'items_per_page'>`
	items_per_page_rss = `<IntOption [report] 'items_per_page_rss'>`
	REPORT_LIST_ID = `-1`
	arg_default_re = `re.compile(r'(?mu)^\s--\s(\w) = *([^\r\n]...`

Properties
Inherited from `object`: `__class__`

Method Details

execute_paginated_report(self, req, id, sql, args, limit=0, offset=0)

source code

Parameters:

req - Request object.
id - Integer id of the report.
sql - SQL query that generates the report.
args - SQL query arguments.
limit - Maximum number of results to return (optional).
offset - Offset to start of results (optional).

Class Variable Details

arg_default_re

Value:

re.compile(r'(?mu)^\s*--\s*(\w*) *= *([^\r\n]*)\r?$')