PHP_UML
[ class tree: PHP_UML ] [ index: PHP_UML ] [ all elements ]

Class: PHP_UML_Output_Exporter

Source Location: /PHP_UML-0.5.2/UML/Output/Exporter.php

Class Overview


Exportation class.


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 35]
Exportation class.

Currently, this class reads XMI data, and applies an XSL transformation. Two formats are available: html and php.



[ Top ]


Method Detail

copyResources   [line 231]

void copyResources( string $path)

Copy the "resources" folder
  • Access: public

Parameters:

string   $path   —  Path to the folder that contains the XSL templates

[ Top ]

createFolder   [line 192]

void createFolder( string $path)

Creates a folder
  • Access: public

Parameters:

string   $path   —  Folder name

[ Top ]

generate   [line 110]

string generate( string $outputDir, string $xslFile, DomDocument $xmlDom)

Generates output data by applying a transformation on a Dom Document
  • Return: (possible) messages raised during XSLT
  • Access: public

Parameters:

string   $outputDir   —  Output folder
string   $xslFile   —  XSL file (template file)
DomDocument   $xmlDom   —  XMI data (Dom)

[ Top ]

generateFromFile   [line 48]

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

Generates output data by applying a transformation on a given XMI file
  • Access: public

Parameters:

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

[ Top ]

generateFromFormat   [line 86]

void generateFromFormat( string $outputDir, string $format, string $xmlData)

Generates output data by applying a transformation on some provided XMI
  • Access: public

Parameters:

string   $outputDir   —  Output folder
string   $format   —  Desired format (html, php...)
string   $xmlData   —  XMI code

[ Top ]

generateFromXml   [line 68]

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

Generates ouput data by applying a transformation on some provided XMI
  • Access: public

Parameters:

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

[ Top ]

saveToFile   [line 210]

void saveToFile( string $name, mixed $content)

Saves a content to a file. Callback function for the XSL templates.
  • Access: public

Parameters:

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

[ Top ]

transform   [line 162]

string transform( string $transformationName, string $xmi)

Applies a simple transformation on XML data
  • Return: XML
  • Access: public

Parameters:

string   $transformationName   —  Template name
string   $xmi   —  XML data

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:29:01 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.