Class: PHP_UML_Output_ExporterAPI

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

Class Overview

PHP_UML_Output_Exporter
   |
   --PHP_UML_Output_ExporterAPI

This is the exportation class relying on the API (= on the full hierarchy of metaclasses stored in the model). Note that another way to export a model would be to use ExporterXSL, which is based on an XSL transformation of XMI.

Author(s):

Baptiste Autin <ohlesbeauxjours at yahoo.fr>

Variables

$ctx

Methods

Child classes:

PHP_UML_Output_Php_Exporter: This class generates a HTML website from a UML model (a PHP_UML_Metamodel)

PHP_UML_Output_Xmi_Exporter: This class generates the XMI from a UML model (PHP_UML_Metamodel)

PHP_UML_Output_HtmlNew_Exporter: This class generates an HTML website from a UML model (a PHP_UML_Metamodel)

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 30]
This is the exportation class relying on the API (= on the full hierarchy of metaclasses stored in the model). Note that another way to export a model would be to use ExporterXSL, which is based on an XSL transformation of XMI.

A class implementing ExporterAPI must reside in a subfolder containing a class named PHP_UML_<name of the output format>_Exporter. This class must also have a public method "generate", which is used to start the serialization process.

Author: Baptiste Autin <ohlesbeauxjours@yahoo.fr>
Abstract:
License: LGPL License 3

[ Top ]

Class Variables

$ctx =

[line 37]

Object storing some contextual data

Access: protected

Type:

PHP_UML_Output_ApiContextPackage

[ Top ]

Method Detail

export [line 39]

void export(

$outDir)

Access: public

Overridden in child classes as:

PHP_UML_Output_Php_Exporter::export()

PHP_UML_Output_Xmi_Exporter::export()

PHP_UML_Output_HtmlNew_Exporter::export()

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

Parameters:

$outDir —

[ Top ]

getContextPackage [line 53]

PHP_UML_Output_ApiContextPackage getContextPackage(
)

Return the ApiContextPackage currently associated to the rendering

Access: public

[ Top ]

initContextPackage [line 120]

void initContextPackage(
PHP_UML_Metamodel_Package
$pkg, 
$dir, 
$rpt)

Access: protected

Parameters:

PHP_UML_Metamodel_Package	`$pkg`	—
	`$dir`	—
	`$rpt`	—

[ Top ]

setAllImplemented [line 82]

void setAllImplemented(
PHP_UML_Metamodel_Class
$s, PHP_UML_Metamodel_Classifier
$t)

Sets the allImplemented/-ing arrays with all the interfaces that a given class implements (including those of the inherited classes)

Access: protected

Parameters:

PHP_UML_Metamodel_Class	`$s`	—	The initial reference class
PHP_UML_Metamodel_Classifier	`$t`	—	The current classifier to check

[ Top ]

setAllInherited [line 65]

void setAllInherited(
PHP_UML_Metamodel_Classifier
$s, PHP_UML_Metamodel_Classifier
$t)

Sets the allInherited/-ing arrays with all the classifiers that a given classifier inherits from

Access: protected

Parameters:

PHP_UML_Metamodel_Classifier	`$s`	—	The initial reference classifier
PHP_UML_Metamodel_Classifier	`$t`	—	The current classifier to check

[ Top ]

setAllSuperClassifiers [line 105]

void setAllSuperClassifiers(
PHP_UML_Metamodel_Package
$pkg)

Recurses into all the packages to build a list of all the generalizations and realizations between elements.

We normally do this before creating the detailed files.

Access: protected

Parameters:

PHP_UML_Metamodel_Package $pkg — Starting package

[ Top ]