Class Trees Index phpDocumentor Project Page

Class XoopsLogger

(line 45)

Located in File: Program_Root/class/logger.php


Collects information for a page request

Singelton: There can be only one instance of this class and it must be accessed through the instance() method!

records information about database queries, blocks, and execution time and can display it as HTML


Class Variable Summary

$blocks


Default Value: ->array()<-

$extra


Default Value: ->array()<-

$logend


Default Value: ->array()<-

$logstart


Default Value: ->array()<-

$queries


Default Value: ->array()<-

Inherited Class Variable Summary


Method Summary

void

addBlock ( $name, [$cached = false], [$cachetime = 0] )


log display of a block
void

addExtra ( $name, [$cachetime = 0] )


log extra information
void

addQuery ( $sql, [$error = null], [$errno = null] )


log a database query
string

dumpAll ( )


get all logged information formatted in HTML tables
string

dumpBlocks ( )


get the logged blocks in a HTML table
string

dumpExtra ( )


get extra information in a HTML table
string

dumpQueries ( )


get the logged queries in a HTML table
float

dumpTime ( [$name = 'XOOPS'] )


get the current execution time of a timer
XoopsLogger

&instance ( )


get a reference to the only instance of this class
void

startTime ( [$name = 'XOOPS'] )


start a timer
void

stopTime ( [$name = 'XOOPS'] )


stop a timer

Inherited Method Summary


Method Detail

addBlock (line 121)

void

addBlock( string $name, [bool $cached = false], int $cachetime)

log display of a block
Function Parameters:
- string $name: name of the block
- bool $cached: was the block cached?
- int $cachetime: cachetime of the block
Function Info:

[ Top ]


addExtra (line 132)

void

addExtra( string $name, int $cachetime)

log extra information
Function Parameters:
- string $name: name for the entry
- int $cachetime: cachetime for the entry
Function Info:

[ Top ]


addQuery (line 109)

void

addQuery( string $sql, [string $error = null], [int $errno = null])

log a database query
Function Parameters:
- string $sql: SQL string
- string $error: error message (if any)
- int $errno: error number (if any)
Function Info:

[ Top ]


dumpAll (line 220)

string

dumpAll( )

get all logged information formatted in HTML tables
Function Info:
return - HTML output

[ Top ]


dumpBlocks (line 163)

string

dumpBlocks( )

get the logged blocks in a HTML table
Function Info:
return - HTML table with blocks

[ Top ]


dumpExtra (line 203)

string

dumpExtra( )

get extra information in a HTML table
Function Info:
return - HTML table with extra information

[ Top ]


dumpQueries (line 142)

string

dumpQueries( )

get the logged queries in a HTML table
Function Info:
return - HTML table with queries

[ Top ]


dumpTime (line 185)

float

dumpTime( [string $name = 'XOOPS'])

get the current execution time of a timer
Function Parameters:
- string $name: name of the counter
Function Info:
return - current execution time of the counter

[ Top ]


instance (line 72)

XoopsLogger

&instance( )

get a reference to the only instance of this class
Function Info:
return - reference to the only instance

[ Top ]


startTime (line 87)

void

startTime( [string $name = 'XOOPS'])

start a timer
Function Parameters:
- string $name: name of the timer
Function Info:

[ Top ]


stopTime (line 97)

void

stopTime( [string $name = 'XOOPS'])

stop a timer
Function Parameters:
- string $name: name of the timer
Function Info:

[ Top ]



Variable Detail

$blocks

(line 51)
Data type: array


$extra

(line 52)
Data type: array


$logend

(line 54)
Data type: array


$logstart

(line 53)
Data type: array


$queries

(line 50)
Data type: array




Documention generated on Fri, 21 Feb 2003 02:07:40 +0100 by phpDocumentor 1.2.0rc1
proudly hosted at
SourceForge.net Logo