ConfigDoc_HTMLXSLTProcessor Class Reference

Decorator/extender XSLT processor specifically for HTML documents. More...

Collaboration diagram for ConfigDoc_HTMLXSLTProcessor:

Public Member Functions
	__construct ($proc=false)
	importStylesheet ($xsl)
	transformToHTML ($xml)
	Transforms an XML file into compatible XHTML based on the stylesheet. More...
	setParameters ($options)
	Bulk sets parameters for the XSL stylesheet. More...
	__call ($name, $arguments)
	Forward any other calls to the XSLT processor. More...

Protected Attributes
	$xsltProcessor
	Instance of XSLTProcessor. More...

Detailed Description

Decorator/extender XSLT processor specifically for HTML documents.

Definition at line 6 of file HTMLXSLTProcessor.php.

Constructor & Destructor Documentation

__construct()

ConfigDoc_HTMLXSLTProcessor::__construct

(

$proc = false

)

Definition at line 14 of file HTMLXSLTProcessor.php.

    {
        if ($proc === false) $proc = new XSLTProcessor();
        $this->xsltProcessor = $proc;
    }

Member Function Documentation

__call()

ConfigDoc_HTMLXSLTProcessor::__call	(		$name,
			$arguments
	)

Forward any other calls to the XSLT processor.

Definition at line 84 of file HTMLXSLTProcessor.php.

    {
        call_user_func_array(array($this->xsltProcessor, $name), $arguments);
    }

importStylesheet()

ConfigDoc_HTMLXSLTProcessor::importStylesheet

(

$xsl

)

Note

Allows a string $xsl filename to be passed

Definition at line 23 of file HTMLXSLTProcessor.php.

    {
        if (is_string($xsl)) {
            $xsl_file = $xsl;
            $xsl = new DOMDocument();
            $xsl->load($xsl_file);
        }
        return $this->xsltProcessor->importStylesheet($xsl);
    }

setParameters()

ConfigDoc_HTMLXSLTProcessor::setParameters

(

$options

)

Bulk sets parameters for the XSL stylesheet.

Parameters

array

$options

Associative array of options to set

Definition at line 74 of file HTMLXSLTProcessor.php.

    {
        foreach ($options as $name => $value) {
            $this->xsltProcessor->setParameter('', $name, $value);
        }
    }

References $options.

transformToHTML()

ConfigDoc_HTMLXSLTProcessor::transformToHTML

(

$xml

)

Transforms an XML file into compatible XHTML based on the stylesheet.

Parameters

$xml	XML DOM tree, or string filename

Returns

string HTML output

Todo:

Rename to transformToXHTML, as transformToHTML is misleading

Definition at line 39 of file HTMLXSLTProcessor.php.

    {
        if (is_string($xml)) {
            $dom = new DOMDocument();
            $dom->load($xml);
        } else {
            $dom = $xml;
        }
        $out = $this->xsltProcessor->transformToXML($dom);
 
        // fudges for HTML backwards compatibility
        // assumes that document is XHTML
        $out = str_replace('/>', ' />', $out); // <br /> not <br/>
        $out = str_replace(' xmlns=""', '', $out); // rm unnecessary xmlns
 
        if (class_exists('Tidy')) {
            // cleanup output
            $config = array(
                'indent'        => true,
                'output-xhtml'  => true,
                'wrap'          => 80
            );
            $tidy = new Tidy;
            $tidy->parseString($out, $config, 'utf8');
            $tidy->cleanRepair();
            $out = (string) $tidy;
        }
 
        return $out;
    }

References $config, and $out.

Field Documentation

$xsltProcessor

ConfigDoc_HTMLXSLTProcessor::$xsltProcessor

protected

Instance of XSLTProcessor.

Definition at line 12 of file HTMLXSLTProcessor.php.

---

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

• libs/composer/vendor/ezyang/htmlpurifier/extras/ConfigDoc/HTMLXSLTProcessor.php