Moodle  2.2.1
http://www.collinsharper.com
xml_output Class Reference
Inheritance diagram for xml_output:

Public Member Functions

 __construct ($usebuffer=true)
 set_buffersize ($buffersize)
 start ()
 stop ()
 write ($content)
 debug_info ()

Data Fields

const DEFAULT_BUFFER_SIZE = 4096

Protected Member Functions

 init ()
 finish ()
 send ($content)

Protected Attributes

 $inittime
 $sentbytes
 $usebuffer
 $buffersize
 $currentbuffer
 $currentbuffersize
 $running

Detailed Description

This abstract class outputs XML contents provided by

Contains the common functionalities for all the xml_output_xxx classes and the interface for them. Mainly it's in charge of:

  • Initialize the corresponding stream/handler (file, DB connection...)
  • Finalize the stream/handler
  • Provide one common buffer for all output implementations
  • Receive XML contents from the and output them
  • Some basic throughtput stats

TODO: Finish phpdocs

Definition at line 38 of file xml_output.class.php.


Constructor & Destructor Documentation

__construct ( usebuffer = true)

Definition at line 52 of file xml_output.class.php.


Member Function Documentation

Definition at line 135 of file xml_output.class.php.

finish ( ) [abstract, protected]

Reimplemented in file_xml_output, and memory_xml_output.

Here is the caller graph for this function:

init ( ) [abstract, protected]

Reimplemented in memory_xml_output, and file_xml_output.

Here is the caller graph for this function:

send ( content) [abstract, protected]

Reimplemented in file_xml_output, and memory_xml_output.

Here is the caller graph for this function:

set_buffersize ( buffersize)

Definition at line 63 of file xml_output.class.php.

start ( )

Definition at line 74 of file xml_output.class.php.

Here is the call graph for this function:

stop ( )

Definition at line 89 of file xml_output.class.php.

Here is the call graph for this function:

write ( content)

Get contents from and buffer/output them

Definition at line 106 of file xml_output.class.php.

Here is the call graph for this function:


Field Documentation

$buffersize [protected]

Definition at line 46 of file xml_output.class.php.

$currentbuffer [protected]

Definition at line 47 of file xml_output.class.php.

$currentbuffersize [protected]

Definition at line 48 of file xml_output.class.php.

$inittime [protected]

Definition at line 42 of file xml_output.class.php.

$running [protected]

Definition at line 50 of file xml_output.class.php.

$sentbytes [protected]

Definition at line 43 of file xml_output.class.php.

$usebuffer [protected]

Definition at line 45 of file xml_output.class.php.

const DEFAULT_BUFFER_SIZE = 4096

Definition at line 40 of file xml_output.class.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations