Docs For Class atkDebugger

static bool	addQuery()	Add a query string to the debugger
static bool	addStatement()	Add a debug statement
static string	elapsed()	Gets the elapsed time
static atkDebugger	getInstance()	Get an instance of this class
static int	getMicroTime()	Gets the microtime
atkDebugger	__construct()	Constructor
string	arrToTable()	Convert an array to a table
string	consoleControls()	Get the HTML code for the console controls
string	consoleLink()	Create the console link
array	&getDebuggerData()	Get debugger data
string	highlightQuery()	Highlight a query
string	queryDetails()	Get details for the query
string	renderConsole()	Render the console
string	renderDebugAndErrorMessages()	Renders the debug and error messages to a nice HTML string.
string	renderDebugBlock()	Render debug block for the current debug information.
string	renderPlainErrorMessages()	Renders error messages for the user.
string	renderQueryList()	Render query list
void	renderRedirectLink()	Renders the redirect link if applicable.
string	renderStatementList()	Render statement list
void	setRedirectUrl()	Set redirect URL.
string	statementDetails()	Get the statement details
string	urlParams()	Convert a params array to a querystring to add to the url
bool	_addQuery()	Add a query string to the debugger
bool	_addStatement()	Add a debug statement

[ Top ]

Properties

static mixed $s_queryCount = 0 [line 33]

API Tags:

Access:

private

[ Top ]

static mixed $s_systemQueryCount = 0 [line 34]

API Tags:

Access:

private

[ Top ]

mixed $m_isconsole = true [line 30]

[ Top ]

mixed $m_redirectUrl = null [line 31]

[ Top ]

Methods

static method addQuery [line 96]

static bool addQuery(
string
$query, [
$isSystemQuery = false], boolean
$system 
)

Add a query string to the debugger

Parameters:

string	$query:
boolean	$system:	is system query? (e.g. for retrieving metadata, warnings, setting locks etc.)
	$isSystemQuery:

API Tags:

Return:	Indication if query is added
Access:	public

[ Top ]

static method addStatement [line 75]

static bool addStatement(
string
$txt 
)

Add a debug statement

Parameters:

string

$txt:

The debug statement

API Tags:

Return:	Indication if statement is added
Access:	public

[ Top ]

static method elapsed [line 618]

static string elapsed(
)

Gets the elapsed time

API Tags:

Return:	The elapsed time
Access:	public

[ Top ]

static method getInstance [line 41]

static atkDebugger getInstance(
)

Get an instance of this class

API Tags:

Return:	Instance of atkDebugger
Access:	public

[ Top ]

static method getMicroTime [line 607]

static int getMicroTime(
)

Gets the microtime

API Tags:

Return:	the microtime
Access:	public

[ Top ]

Constructor __construct [line 56]

atkDebugger __construct(
)

Constructor

API Tags:

Access:

public

[ Top ]

arrToTable [line 321]

string arrToTable(
array
$result, [bool
$full = true], [int
$id = ""] 
)

Convert an array to a table

Parameters:

array	$result:	The array to convert
bool	$full:	All results?
int	$id:

API Tags:

Return:	HTML table
Access:	public

[ Top ]

consoleControls [line 250]

string consoleControls(
)

Get the HTML code for the console controls

API Tags:

Return:	The HTML code
Access:	public

[ Top ]

consoleLink [line 172]

string consoleLink(
string
$text, [string
$action = ""], [array
$params = array()], [bool
$popup = false], [int
$stackId = NULL] 
)

Create the console link

Parameters:

string	$text:	The name of the link
string	$action:	The action
array	$params:	Array with parameters to add to the url
bool	$popup:	IS this a popup link?
int	$stackId:	The stack id

API Tags:

Return:	HTML code with the console link
Access:	public

[ Top ]

getDebuggerData [line 376]

array &getDebuggerData(
[bool
$clean = false], [int
$stackId = NULL] 
)

Get debugger data

Parameters:

bool	$clean:
int	$stackId:

API Tags:

Return:	Array with data
Access:	public

[ Top ]

highlightQuery [line 352]

string highlightQuery(
string
$query 
)

Highlight a query

Parameters:

string

$query:

The query to highlight

API Tags:

Return:	The highlighted query
Access:	public

[ Top ]

queryDetails [line 262]

string queryDetails(
array
$queries, int
$id 
)

Get details for the query

Parameters:

array	$queries:	Array with queries
int	$id:	The index in the queries array we want the details from

API Tags:

Return:	The query details
Access:	public

[ Top ]

renderConsole [line 224]

string renderConsole(
)

Render the console

API Tags:

Return:	The HTML code
Access:	public

[ Top ]

renderDebugAndErrorMessages [line 543]

string renderDebugAndErrorMessages(
)

Renders the debug and error messages to a nice HTML string.

API Tags:

Return:	html string
Access:	public

[ Top ]

renderDebugBlock [line 481]

string renderDebugBlock(
bool
$expanded 
)

Render debug block for the current debug information.

Parameters:

bool

$expanded:

Display debugblock expanded?

API Tags:

Return:	debug block string
Access:	public

Information Tags:

Private:

[ Top ]

renderPlainErrorMessages [line 458]

string renderPlainErrorMessages(
)

Renders error messages for the user.

API Tags:

Return:	error messages string
Access:	public

Information Tags:

Private:

[ Top ]

renderQueryList [line 401]

string renderQueryList(
array
$queries 
)

Render query list

Parameters:

array

$queries:

API Tags:

Return:	HTML code with the query list
Access:	public

[ Top ]

renderRedirectLink [line 526]

void renderRedirectLink(
)

Renders the redirect link if applicable.

API Tags:

Access:

public

[ Top ]

renderStatementList [line 433]

string renderStatementList(
array
$statements 
)

Render statement list

Parameters:

array

$statements:

API Tags:

Return:	HTML code with the statement list
Access:	public

[ Top ]

setRedirectUrl [line 513]

void setRedirectUrl(
string
$url, [bool
$force = false] 
)

Set redirect URL.

Parameters:

string	$url:	The redirect url
bool	$force:	Force to set this redirect url

API Tags:

Access:

public

[ Top ]

statementDetails [line 299]

string statementDetails(
array
$stmts, int
$id 
)

Get the statement details

Parameters:

array	$stmts:	Array with statements
int	$id:	The index in the statements array we want the details from

API Tags:

Return:	The statement details
Access:	public

[ Top ]

urlParams [line 205]

string urlParams(
array
$params 
)

Convert a params array to a querystring to add to the url

Parameters:

array

$params:

API Tags:

Access:

public

[ Top ]

_addQuery [line 147]

bool _addQuery(
string
$query 
)

Add a query string to the debugger

Parameters:

string

$query:

API Tags:

Return:	Indication if query is added
Access:	protected

[ Top ]

_addStatement [line 126]

bool _addStatement(
string
$txt 
)

Add a debug statement

Parameters:

string

$txt:

The debug statement

API Tags:

Return:	Indication if statement is added
Access:	protected

[ Top ]