Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
xml_output Class Reference

This abstract class outputs XML contents provided by @xml_writer. More...

Inheritance diagram for xml_output:
file_xml_output memory_xml_output

Public Member Functions

 __construct ($usebuffer=true)
 
 debug_info ()
 
 set_buffersize ($buffersize)
 
 start ()
 
 stop ()
 
 write ($content)
 Get contents from @xml_writer and buffer/output them.
 

Public Attributes

const DEFAULT_BUFFER_SIZE = 4096
 

Protected Member Functions

 finish ()
 
 init ()
 
 send ($content)
 

Protected Attributes

 $buffersize
 
 $currentbuffer
 
 $currentbuffersize
 
string float $finishtime
 finish microtime.
 
 $inittime
 
 $running
 
 $sentbytes
 
 $usebuffer
 

Detailed Description

This abstract class outputs XML contents provided by @xml_writer.

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 @xml_writer and output them
  • Some basic throughtput stats

TODO: Finish phpdocs


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