Class XmlReporter

Description

Creates the XML needed for remote communication by SimpleTest.

Located in /libraries/pear/simpletest/xml.php (line 21)

SimpleRunner
   |
   --SimpleReporter
      |
      --XmlReporter
Variable Summary
 mixed $_indent
 mixed $_namespace
Method Summary
 XmlReporter XmlReporter ([mixed $namespace = false], [mixed $indent = ' '])
 void paintCaseEnd (string $test_name)
 void paintCaseStart (string $test_name)
 void paintException (string $message)
 void paintFail (string $message)
 void paintFooter (string $test_name)
 void paintFormattedMessage (string $message)
 void paintGroupEnd (string $test_name)
 void paintGroupStart (string $test_name, integer $size)
 void paintHeader (string $test_name)
 void paintMessage (string $message)
 void paintMethodEnd (string $test_name, integer $progress)
 void paintMethodStart (string $test_name)
 void paintPass (string $message)
 void paintSignal (string $type, mixed &$payload)
 string toParsedXml (string $text)
 string _getIndent (integer $offset)
Variables
Methods
Constructor XmlReporter (line 29)

Does nothing yet.

  • access: public
XmlReporter XmlReporter ([mixed $namespace = false], [mixed $indent = ' '])
paintCaseEnd (line 109)

Paints the end of a test case.

  • access: public
void paintCaseEnd (string $test_name)
  • string $test_name: Name of test that is ending.

Redefinition of:
SimpleReporter::paintCaseEnd()
Paints the end of a test case. Will paint the page footer if the stack of tests has unwound.
paintCaseStart (line 94)

Paints the start of a test case.

  • access: public
void paintCaseStart (string $test_name)
  • string $test_name: Name of test that is starting.

Redefinition of:
SimpleReporter::paintCaseStart()
Paints the start of a test case. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.
paintException (line 174)

Paints a PHP error or exception.

  • abstract:
  • access: public
void paintException (string $message)
  • string $message: Message is ignored.

Redefinition of:
SimpleRunner::paintException()
Deals with PHP 5 throwing an exception This isn't really implemented yet.
paintFail (line 160)

Increments the fail count.

  • access: public
void paintFail (string $message)
  • string $message: Message is ignored.

Redefinition of:
SimpleRunner::paintFail()
Increments the fail count.
paintFooter (line 249)

Paints the test document footer.

  • abstract:
  • access: public
void paintFooter (string $test_name)
  • string $test_name: The top level test.

Redefinition of:
SimpleReporter::paintFooter()
Paints the test document footer.
paintFormattedMessage (line 201)

Paints a formatted ASCII message such as a variable dump.

  • access: public
void paintFormattedMessage (string $message)
  • string $message: Text to display.

Redefinition of:
SimpleRunner::paintFormattedMessage()
Paints a formatted ASCII message such as a variable dump.
paintGroupEnd (line 83)

Paints the end of a group test.

  • access: public
void paintGroupEnd (string $test_name)
  • string $test_name: Name of test that is ending.

Redefinition of:
SimpleReporter::paintGroupEnd()
Paints the end of a group test. Will paint the page footer if the stack of tests has unwound.
paintGroupStart (line 68)

Paints the start of a group test.

  • access: public
void paintGroupStart (string $test_name, integer $size)
  • string $test_name: Name of test that is starting.
  • integer $size: Number of test cases starting.

Redefinition of:
SimpleReporter::paintGroupStart()
Paints the start of a group test. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.
paintHeader (line 230)

Paints the test document header.

  • abstract:
  • access: public
void paintHeader (string $test_name)
  • string $test_name: First test top level to start.

Redefinition of:
SimpleReporter::paintHeader()
Paints the test document header.
paintMessage (line 187)

Paints a simple supplementary message.

  • access: public
void paintMessage (string $message)
  • string $message: Text to display.

Redefinition of:
SimpleRunner::paintMessage()
Paints a simple supplementary message.
paintMethodEnd (line 136)

Paints the end of a test method.

  • access: public
void paintMethodEnd (string $test_name, integer $progress)
  • string $test_name: Name of test that is ending.
  • integer $progress: Number of test cases ending.

Redefinition of:
SimpleReporter::paintMethodEnd()
Paints the end of a test method. Will paint the page footer if the stack of tests has unwound.
paintMethodStart (line 120)

Paints the start of a test method.

  • access: public
void paintMethodStart (string $test_name)
  • string $test_name: Name of test that is starting.

Redefinition of:
SimpleReporter::paintMethodStart()
Paints the start of a test method.
paintPass (line 147)

Increments the pass count.

  • access: public
void paintPass (string $message)
  • string $message: Message is ignored.

Redefinition of:
SimpleRunner::paintPass()
Increments the pass count.
paintSignal (line 215)

Serialises the event object.

  • access: public
void paintSignal (string $type, mixed &$payload)
  • string $type: Event type as text.
  • mixed $payload: Message or object.

Redefinition of:
SimpleRunner::paintSignal()
By default just ignores user generated events.
toParsedXml (line 55)

Converts character string to parsed XML entities string.

  • return: Parsed character data.
  • access: public
string toParsedXml (string $text)
  • string $text: text Unparsed character data.
_getIndent (line 42)

Calculates the pretty printing indent level from the current level of nesting.

  • return: Leading space.
  • access: protected
string _getIndent (integer $offset)
  • integer $offset: Extra indenting level.

Inherited Methods

Inherited From SimpleReporter

 SimpleReporter::SimpleReporter()
 SimpleReporter::getTestCaseCount()
 SimpleReporter::getTestCaseProgress()
 SimpleReporter::getTestList()
 SimpleReporter::inCli()
 SimpleReporter::paintCaseEnd()
 SimpleReporter::paintCaseStart()
 SimpleReporter::paintFooter()
 SimpleReporter::paintGroupEnd()
 SimpleReporter::paintGroupStart()
 SimpleReporter::paintHeader()
 SimpleReporter::paintMethodEnd()
 SimpleReporter::paintMethodStart()

Inherited From SimpleRunner

 SimpleRunner::SimpleRunner()
 SimpleRunner::getExceptionCount()
 SimpleRunner::getFailCount()
 SimpleRunner::getPassCount()
 SimpleRunner::getStatus()
 SimpleRunner::invoke()
 SimpleRunner::makeDry()
 SimpleRunner::paintCaseEnd()
 SimpleRunner::paintCaseStart()
 SimpleRunner::paintError()
 SimpleRunner::paintException()
 SimpleRunner::paintFail()
 SimpleRunner::paintFormattedMessage()
 SimpleRunner::paintGroupEnd()
 SimpleRunner::paintGroupStart()
 SimpleRunner::paintMessage()
 SimpleRunner::paintMethodEnd()
 SimpleRunner::paintMethodStart()
 SimpleRunner::paintPass()
 SimpleRunner::paintSignal()

Documentation generated on Fri, 10 Dec 2004 18:27:01 +0000 by phpDocumentor 1.3.0RC3