report_performance Class Reference

This contains functions to get list of issues and there results. More...

Public Member Functions
	add_issue_to_table (&$table, $issueresult, $detailed=false)
	Helper function to add issue details to table. More...
	doc_link ($issue, $name)
	Returns document link for performance issue. More...
	get_issue_list ()
	Return list of performance check function list. More...

Static Public Member Functions
static	report_performance_check_automatic_backup ()
	Checks automatic backup config. More...
static	report_performance_check_cachejs ()
	Checks if javascript is cached. More...
static	report_performance_check_debugmsg ()
	Checks debug config. More...
static	report_performance_check_enablestats ()
	Checks if stats are enabled.
static	report_performance_check_themedesignermode ()
	Verifies if theme designer mode is enabled. More...

Public Attributes
const	REPORT_PERFORMANCE_CRITICAL = 'critical'
	This is used to notify if issue is critical and will significantly impact performance.
const	REPORT_PERFORMANCE_OK = 'ok'
	This is used when issue is ok and there is no impact on performance.
const	REPORT_PERFORMANCE_SERIOUS = 'serious'
	This is used to notify if issue is serious and will impact performance.
const	REPORT_PERFORMANCE_WARNING = 'warning'
	This is used to notify that issue might impact performance.

Detailed Description

This contains functions to get list of issues and there results.

Copyright

2013 Rajesh Taneja

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

add_issue_to_table()

report_performance::add_issue_to_table	(	&	$table,
			$issueresult,
			$detailed = false
	)

Helper function to add issue details to table.

Parameters

html_table	$table	table in which issue details should be added
report_performance_issues	$issueresult	issue result to be added
bool	$detail	true if issue if displayed in detail.

doc_link()

report_performance::doc_link	(		$issue,
			$name
	)

Returns document link for performance issue.

Parameters

string	$issue	string describing issue
string	$name	name of issue

Return values

string

issue link pointing to docs page.

get_issue_list()

report_performance::get_issue_list

(

)

Return list of performance check function list.

Return values

array

list of performance issues.

report_performance_check_automatic_backup()

static report_performance::report_performance_check_automatic_backup ( )

static

Checks automatic backup config.

Return values

report_performance_issue

result of automatic backup issue.

report_performance_check_cachejs()

static report_performance::report_performance_check_cachejs ( )

static

Checks if javascript is cached.

Return values

report_performance_issue

result of cachejs issue.

report_performance_check_debugmsg()

static report_performance::report_performance_check_debugmsg ( )

static

Checks debug config.

Return values

report_performance_issue

result of debugmsg issue.

report_performance_check_themedesignermode()

static report_performance::report_performance_check_themedesignermode ( )

static

Verifies if theme designer mode is enabled.

Return values

report_performance_issue

result of themedesigner issue.

---

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

• report/performance/locallib.php