Class: PHP_UML_Output_ExporterXSL

Source Location: /PHP_UML-1.6.1/UML/Output/ExporterXSL.php

Class Overview

PHP_UML_Output_Exporter
   |
   --PHP_UML_Output_ExporterXSL

An exportation class, that relies on XSL transformations.

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Child classes:

PHP_UML_Output_Html_Exporter: Implementation of an exporter to generate an HTML website (Javadoc look and feel)

Inherited Variables

Class: PHP_UML_Output_Exporter

PHP_UML_Output_Exporter::$structure

Inherited Methods

Class: PHP_UML_Output_Exporter

PHP_UML_Output_Exporter::__construct(): Constructor
PHP_UML_Output_Exporter::export(): Export the current model to a particular output format.
PHP_UML_Output_Exporter::getInstance(): Factory method to retrieve an implementation of an exporter, given the "common name" of a format.
PHP_UML_Output_Exporter::setModel(): Setter for the model.

Class Details

[line 34]
An exportation class, that relies on XSL transformations.

It does its export by transforming the XMI data contained in the object $xmiDocument. Various transformations are available: they are all stored in separate subfolders (php, html). To get an ExporterXSL for a given format, call the constructor with the name of the format as first parameter: new PHP_UML_Output_ExporterXSL("php") This format name must be equal to the folder name where the desired XSL files are.

Author: Baptiste Autin <ohlesbeauxjours@yahoo.fr>
Link: http://pear.php.net/package/PHP_UML
Abstract:
License: LGPL License 3

[ Top ]

Class Variables

$createFolderCallback =

[line 41]

Access: protected

Type:

mixed

[ Top ]

$saveToFileCallback =

[line 39]

Access: protected

Type:

mixed

[ Top ]

$xmiDocument =

[line 48]

XmiDocument object containing the XMI to transform

Access: protected

Type:

PHP_UML_Output_XmiDocument

[ Top ]

Method Detail

__construct (Constructor) [line 51]

PHP_UML_Output_ExporterXSL __construct(
)

Access: public

Overrides PHP_UML_Output_Exporter::__construct() (Constructor)

[ Top ]

convertTo2 [line 217]

string convertTo2(
string
$xmi)

XMI converter

Return: XMI (in version 2)
Access: public

Parameters:

string $xmi — XMI (in version 1)

[ Top ]

createFolder [line 281]

void createFolder(
string
$path)

Create a folder. This is a callback function for the XSL templates (that's why it is public), and you should not have to use it.

Access: public

Parameters:

string $path — Folder name

[ Top ]

export [line 121]

DOMDocument export(
string
$outputDir)

Generates output data by applying a transformation on the XMI stored in the property $xmi

Return: A DOM document containing the result of the XSLT
Access: public

Overrides PHP_UML_Output_Exporter::export() (Export the current model to a particular output format.)

Parameters:

string $outputDir — Output folder

[ Top ]

exportFromFile [line 75]

void exportFromFile(
string
$outputDir, string
$xslFile, string
$xmlFile)

Generates output data by applying a transformation on a given XMI file

Access: protected

Parameters:

string	`$outputDir`	—	Output directory
string	`$xslFile`	—	XSL file (template file)
string	`$xmlFile`	—	XMI file

[ Top ]

exportFromXml [line 95]

void exportFromXml(
string
$outputDir, string
$xslFile, string
$xmlData)

Generates ouput data by applying a transformation on some provided XMI

Access: protected

Parameters:

string	`$outputDir`	—	Output directory
string	`$xslFile`	—	XSL file (template file)
string	`$xmlData`	—	The XMI data

[ Top ]

getXslFilepath [line 111]

string getXslFilepath(
)

Return the absolute location of the XSL file

Return: Filepath
Abstract:

Overridden in child classes as:

PHP_UML_Output_Html_Exporter::getXslFilepath()

[ Top ]

saveToFile [line 300]

void saveToFile(
string
$name, mixed
$content)

Save a content to a file. This is a callback function for the XSL templates (that's why it is public), and you should not have to use it.

Access: public

Parameters:

string	`$name`	—	File name
mixed	`$content`	—	Content (can be either a string, or a node-set)

[ Top ]

setCreateFolderCallback [line 63]

void setCreateFolderCallback(

$function)

Access: public

Parameters:

$function —

[ Top ]

setSaveToFileCallback [line 58]

void setSaveToFileCallback(

$function)

Access: public

Parameters:

$function —

[ Top ]