HTMLPurifier_ConfigSchema_Builder_Xml Class Reference

Converts HTMLPurifier_ConfigSchema_Interchange to an XML format, which can be further processed to generate documentation. More...

Inheritance diagram for HTMLPurifier_ConfigSchema_Builder_Xml:

Collaboration diagram for HTMLPurifier_ConfigSchema_Builder_Xml:

Public Member Functions
	build ($interchange)
	buildDirective ($directive)

Protected Member Functions
	writeHTMLDiv ($html)
	export ($var)

Protected Attributes
	$interchange
	HTMLPurifier_ConfigSchema_Interchange More...

Private Attributes
	$namespace
	string More...

Detailed Description

Converts HTMLPurifier_ConfigSchema_Interchange to an XML format, which can be further processed to generate documentation.

Definition at line 7 of file Xml.php.

Member Function Documentation

build()

HTMLPurifier_ConfigSchema_Builder_Xml::build

(

$interchange

)

Parameters

HTMLPurifier_ConfigSchema_Interchange

$interchange

Definition at line 50 of file Xml.php.

References $interchange, and buildDirective().

    {
        // 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->directives as $directive) {
            $this->buildDirective($directive);
        }

        if ($this->namespace) {
            $this->endElement();
        } // namespace

        $this->endElement(); // configdoc
        $this->flush();
    }

Here is the call graph for this function:

buildDirective()

HTMLPurifier_ConfigSchema_Builder_Xml::buildDirective

(

$directive

)

Parameters

HTMLPurifier_ConfigSchema_Interchange_Directive

$directive

Definition at line 75 of file Xml.php.

References $x, export(), and writeHTMLDiv().

Referenced by build().

    {
        // Kludge, although I suppose having a notion of a "root namespace"
        // certainly makes things look nicer when documentation is built.
        // Depends on things being sorted.
        if (!$this->namespace || $this->namespace !== $directive->id->getRootNamespace()) {
            if ($this->namespace) {
                $this->endElement();
            } // namespace
            $this->namespace = $directive->id->getRootNamespace();
            $this->startElement('namespace');
            $this->writeAttribute('id', $this->namespace);
            $this->writeElement('name', $this->namespace);
        }

        $this->startElement('directive');
        $this->writeAttribute('id', $directive->id->toString());

        $this->writeElement('name', $directive->id->getDirective());

        $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->startElement('type');
        if ($directive->typeAllowsNull) {
            $this->writeAttribute('allow-null', 'yes');
        }
        $this->text($directive->type);
        $this->endElement(); // type
        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
    }

Here is the call graph for this function:

Here is the caller graph for this function:

export()

HTMLPurifier_ConfigSchema_Builder_Xml::export (   $var )

protected

Parameters

mixed

$var

Returns

string

Definition at line 39 of file Xml.php.

Referenced by buildDirective().

    {
        if ($var === array()) {
            return 'array()';
        }
        return var_export($var, true);
    }

Here is the caller graph for this function:

writeHTMLDiv()

HTMLPurifier_ConfigSchema_Builder_Xml::writeHTMLDiv (   $html )

protected

Parameters

string

$html

Definition at line 23 of file Xml.php.

References $html, and HTMLPurifier\getInstance().

Referenced by buildDirective().

    {
        $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
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$interchange

HTMLPurifier_ConfigSchema_Builder_Xml::$interchange

protected

HTMLPurifier_ConfigSchema_Interchange

Definition at line 13 of file Xml.php.

Referenced by build().

$namespace

HTMLPurifier_ConfigSchema_Builder_Xml::$namespace

private

string

Definition at line 18 of file Xml.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/ConfigSchema/Builder/Xml.php