home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / PHPDoc / xmlwriter / PhpdocXMLWriter.php
Encoding:
PHP Script  |  2001-02-18  |  5.0 KB  |  174 lines
  1. <?php
  2. /**
  3. * Creates XML documents.
  4. * 
  5. * PHPDoc uses this helper class to generate xml documents. It's 
  6. * not much what this class can do but it provides some simple
  7. * functions to handle attributes and hides file handling tasks.
  8. * 
  9. * @version    $Id: PhpdocXMLWriter.php,v 1.4 2001/02/18 16:59:52 uw Exp $
  10. */
  11. class PhpdocXMLWriter extends PhpdocObject {
  12.     
  13.     /**
  14.     * Generated XML document.
  15.     *
  16.     * @var  string  $xml
  17.     */
  18.     var $xml = "";
  19.     
  20.     /**
  21.     * PHPDoc Warning object
  22.     *
  23.     * @var  object  PhpdocWarning
  24.     */
  25.     var $warn;
  26.     
  27.     /**
  28.     * Filehandler used for IO operations
  29.     *
  30.     * @var  object  PhpdocFilehandler
  31.     * @see  PhpdocXMLWriter()
  32.     */
  33.     var $fileHandler;
  34.     
  35.     /**
  36.     * Creates a new PhpdocFileHandler
  37.     *
  38.     * @see  $filehandler
  39.     */
  40.     function PhpdocXMLWriter() {
  41.         $this->fileHandler = new PhpdocFileHandler;
  42.     } // end constructor
  43.     
  44.     /**
  45.     * Clears the internal xml data buffer so that a new document can be passed to the object.
  46.     * @access    public
  47.     */
  48.     function free() {
  49.         $this->xml = "";
  50.     } // end func free
  51.     
  52.     /**
  53.     * Adds xml to the generated xml.
  54.     *
  55.     * @param    string  xml to append
  56.     * @access   public
  57.     */
  58.     function addXML($xml) {
  59.     
  60.         $this->xml.= $xml;
  61.             
  62.     } // end func addXML
  63.  
  64.     /**
  65.     * Saves the xml to the specified file.
  66.     *
  67.     * @param    string  Name of the target file
  68.     * @access   public
  69.     */    
  70.     function export($filename) {
  71.         return $this->fileHandler->createFile($filename, $this->xml);
  72.     } // end func export
  73.     
  74.     /**
  75.     * Adds an open (or single) xml tag to the generated xml.
  76.     *
  77.     * Use this function to add new elements/tags to the xml document. 
  78.     * The tagname and all attributenames will be converted to lowercase.
  79.     *
  80.     * @param    string  elementname (tagname)
  81.     * @param    string  value of the container: <name>value
  82.     * @param    array   Array of attributes: $attribs[n][type] = boolean|cdata, $attribs[n][value] = value
  83.     * @param    boolean Flag indication that you want an empty tag like <name/>.
  84.     * @access   public
  85.     * @see      endElement()
  86.     */
  87.     function startElement($name, $value = "", $attribs = "", $close = false) {
  88.     
  89.         $xml = "<" . strtolower($name);
  90.         
  91.         if (is_array($attribs)) {
  92.             
  93.             reset($attribs);
  94.             while (list($attrib, $data) = each($attribs)) {
  95.             
  96.                 $attrib = strtolower($attrib);
  97.                 $type = strtolower($data["type"]);
  98.                 
  99.                 switch($type) {
  100.                     case "boolean":
  101.                         $xml.= sprintf(' %s="%s"', $attrib, ($data["value"]) ? "true" : "false");
  102.                         break;
  103.                         
  104.                     case "cdata":
  105.                         $xml.= sprintf(' %s="%s"', $attrib, $this->xmlencode($data["value"]) );
  106.                         break;
  107.                 }
  108.             }
  109.             
  110.         } 
  111.         
  112.         if ($close) {
  113.         
  114.             $xml .= "/>";
  115.             
  116.         } else {
  117.         
  118.             $xml .= ">";
  119.             if ("" != $value)
  120.                 $xml .= $this->xmlencode($value);
  121.                 
  122.         }
  123.         
  124.         $this->xml .= $xml;
  125.         
  126.     } // end func startElement
  127.     
  128.     /**
  129.     * Adds a closing xml tag to the generated xml document.
  130.     *
  131.     * @param    string    Elementname (tagname)
  132.     * @access   public
  133.     * @see      startElement()
  134.     */
  135.     function endElement($name) {
  136.         $this->xml .= sprintf("</%s>", strtolower($name));
  137.     } // end func endElement
  138.     
  139.     /**
  140.     * Adds a complete xml container to the generated xml document.
  141.     *
  142.     * @param    string  Elementname (tagname)
  143.     * @param    string  Value
  144.     * @param    array   Attributes
  145.     * @access   public
  146.     * @see      startElement(), endElement()
  147.     */
  148.     function addElement($name, $value = "", $attribs = "") {
  149.         
  150.         if ("" == $value) {
  151.         
  152.             $this->startElement($name, $value, $attribs, true);
  153.             
  154.         } else {
  155.         
  156.             $this->startElement($name, $value, $attribs, false);
  157.             $this->endElement($name);
  158.             
  159.         }
  160.             
  161.     } // end func addElement
  162.     
  163.     /**
  164.     * Encodes XML values.
  165.     * @param    string  $value
  166.     * @return   string  $value
  167.     */
  168.     function xmlencode($value) {
  169. #        return preg_replace( array("@<@", "@>@", "@'@", '@"@', "@&@", "@" . PHPDOC_LINEBREAK ."@", "@\n@", "@\r@"), array("<", ">", "'", """, "&", ' ', ' ', ' '), $value);
  170.         return utf8_encode(preg_replace( array("@<@", "@>@", "@'@", '@"@', "@&@", "@" . PHPDOC_LINEBREAK . "@", "@\n@", "@\r@"), array("<", ">", "'", """, "&", ' ', ' ', ' '), $value));
  171.     } // end func xmlencode
  172.     
  173. } // end class PhpdocXMLWriter
  174. ?>