htmlpurifier/library/HTMLPurifier/ConfigSchema/Builder/Xml.php

<?php

/**
 * Converts HTMLPurifier_ConfigSchema_Interchange to an XML format,
 * which can be further processed to generate documentation.
 */
class HTMLPurifier_ConfigSchema_Builder_Xml extends XMLWriter
{
    
    protected $interchange;
    
    protected function writeHTMLDiv($html) {
        $this->startElement('div');
        
        $purifier = HTMLPurifier::getInstance();
        $html = $purifier->purify($html);
        $this->writeAttribute('xmlns', 'http://www.w3.org/1999/xhtml');
        $this->writeRaw($html);
        
        $this->endElement(); // div
    }
    
    protected function export($var) {
        if ($var === array()) return 'array()';
        return var_export($var, true);
    }
    
    public function build($interchange) {
        // global access, only use as last resort
        $this->interchange = $interchange;
        
        $this->setIndent(true);
        $this->startDocument('1.0', 'UTF-8');
        $this->startElement('configdoc');
        $this->writeElement('title', $interchange->name);
        
        foreach ($interchange->namespaces as $namespace) {
            $this->buildNamespace($namespace);
        }
        
        $this->endElement(); // configdoc
        $this->flush();
    }
    
    public function buildNamespace($namespace) {
        $this->startElement('namespace');
        $this->writeAttribute('id', $namespace->namespace);
        
        $this->writeElement('name', $namespace->namespace);
        $this->startElement('description');
            $this->writeHTMLDiv($namespace->description);
        $this->endElement(); // description
        
        foreach ($this->interchange->directives as $directive) {
            if ($directive->id->namespace !== $namespace->namespace) continue;
            $this->buildDirective($directive);
        }
        
        $this->endElement(); // namespace
    }
    
    public function buildDirective($directive) {
        $this->startElement('directive');
        $this->writeAttribute('id', $directive->id->toString());
        
        $this->writeElement('name', $directive->id->directive);
        
        $this->startElement('aliases');
            foreach ($directive->aliases as $alias) $this->writeElement('alias', $alias->toString());
        $this->endElement(); // aliases
        
        $this->startElement('constraints');
            if ($directive->version) $this->writeElement('version', $directive->version);
            $this->writeElement('type', $directive->type);
            if ($directive->typeAllowsNull) $this->writeAttribute('allow-null', 'yes');
            if ($directive->allowed) {
                $this->startElement('allowed');
                    foreach ($directive->allowed as $value => $x) $this->writeElement('value', $value);
                $this->endElement(); // allowed
            }
            $this->writeElement('default', $this->export($directive->default));
            $this->writeAttribute('xml:space', 'preserve');
            if ($directive->external) {
                $this->startElement('external');
                    foreach ($directive->external as $project) $this->writeElement('project', $project);
                $this->endElement();
            }
        $this->endElement(); // constraints
        
        if ($directive->deprecatedVersion) {
            $this->startElement('deprecated');
                $this->writeElement('version', $directive->deprecatedVersion);
                $this->writeElement('use', $directive->deprecatedUse->toString());
            $this->endElement(); // deprecated
        }
        
        $this->startElement('description');
            $this->writeHTMLDiv($directive->description);
        $this->endElement(); // description
        
        $this->endElement(); // directive
    }
    
}