Docs For Class PHP_UML_XMI

getArtifact [line 129]

string getArtifact(
PHP_UML_Metamodel_File
$file, [array
&$mf = array()])

Generates the XMI code for an artifact

Return: XMI code

Parameters:

PHP_UML_Metamodel_File	`$file`	—	File to add as an artifact
array	`&$mf`	—	Manifested elements (array of PHP_UML_Metamodel_Class)

[ Top ]

getClass [line 91]

string getClass(
PHP_UML_Metamodel_Class
&$class)

Generates the XMI code for a class

Return: XMI code

Parameters:

PHP_UML_Metamodel_Class &$class — Class

[ Top ]

getComment [line 180]

string getComment(
string
$body, [string
$annotatedElement = ''])

Adds a comment to a model element

Return: XMI code

Parameters:

string	`$body`	—	Content
string	`$annotatedElement`	—	The commented element

[ Top ]

getComponent [line 139]

string getComponent(
PHP_UML_Metamodel_File
$file, [string
$stereotype = ''])

Generates the XMI for a component

Return: XMI code

Parameters:

PHP_UML_Metamodel_File	`$file`	—	File to add as a component
string	`$stereotype`	—	Stereotype of the file

[ Top ]

getDatatype [line 82]

string getDatatype(
PHP_UML_Metamodel_Type
$type)

Generates the XMI declarations of the main PHP types (official and unofficial)

Return: XMI code

Parameters:

PHP_UML_Type $type — Datatype

[ Top ]

getGeneralizations [line 170]

mixed getGeneralizations(
PHP_UML_Metamodel_Type
&$client)

Generates the XMI code for all the inherited classes of a given element

Return: In XMI 1.x, this returns an array, because XMI 1 needs two declarations: the child element must be defined as "generalizable", in addition to the generalization relationship. In XMI 2, only the relationship is necessary, which is returned as a string.

Parameters:

PHP_UML_Metamodel_Type &$client — Child element

[ Top ]

getInterface [line 100]

string getInterface(
PHP_UML_Metamodel_Interface
&$interface)

Generates the XMI code for an interface

Return: XMI code

Parameters:

PHP_UML_Metamodel_Interface &$interface — Class

[ Top ]

getModelClose [line 41]

string getModelClose(
)

Generates the closing tag of a model

Return: XMI code

[ Top ]

getModelOpen [line 34]

string getModelOpen(
PHP_UML_Metamodel_Package
&$model)

Generates the XMI header

Return: XMI code

Parameters:

string &$model — Name of the model (root package)

[ Top ]

getOperation [line 109]

string getOperation(
PHP_UML_Metamodel_Operation
&$operation)

Generates the XMI code for an operation

Return: XMI code

Parameters:

PHP_UML_Metamodel_Operation &$operation — Operation

[ Top ]

getPackageClose [line 57]

string getPackageClose(
)

Generates the closing tag of a package

Return: XMI code

[ Top ]

getPackageOpen [line 50]

string getPackageOpen(
PHP_UML_Metamodel_Package
$package)

Generates the opening tag for a package

Return: XMI code

Parameters:

PHP_UML_Metamodel_Package $package — Package to insert

[ Top ]

getParameter [line 118]

string getParameter(
PHP_UML_Metamodel_Parameter
&$parameter)

Generates the XMI code for the paramater of an operation

Return: XMI code

Parameters:

PHP_UML_Metamodel_Parameter &$parameter — Parameter

[ Top ]

getParameterType [line 149]

string getParameterType(
PHP_UML_Metamodel_TypedElement
&$parameter)

Generates the XMI code for a typed element (datatype, class, interface).

Required by getParameter(). Adds the default value (if any)

Return: XMI code

Parameters:

PHP_UML_Metamodel_TypedElement &$parameter — Element (a datatype, a class or an interface)

[ Top ]

getProfile [line 187]

string getProfile(
)

Generates the XMI code for a UML2 profile.

Return: XMI code

[ Top ]

getRealizations [line 158]

string getRealizations(
PHP_UML_Metamodel_Class
&$client)

Generates the XMI code for all the realization (interface implementations) of a given element

Return: XMI code

Parameters:

PHP_UML_Metamodel_Class &$client — Child element

[ Top ]

getSubsystemClose [line 73]

string getSubsystemClose(
)

Generates the closing tag for a subsystem / component

Return: XMI code

[ Top ]

getSubsystemOpen [line 66]

string getSubsystemOpen(
PHP_UML_Metamodel_Package
$package)

Generates the opening tag for a sub-system (XMI 1), or a component (XMI 2)

Return: XMI code
Access: public

Parameters:

PHP_UML_Metamodel_Package $package — Package to code as a subsystem

[ Top ]

Class: PHP_UML_XMI_Builder

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

getArtifact [line 129]

Parameters:

getClass [line 91]

Parameters:

getComment [line 180]

Parameters:

getComponent [line 139]

Parameters:

getDatatype [line 82]

Parameters:

getGeneralizations [line 170]

Parameters:

getInterface [line 100]

Parameters:

getModelClose [line 41]

getModelOpen [line 34]

Parameters:

getOperation [line 109]

Parameters:

getPackageClose [line 57]

getPackageOpen [line 50]

Parameters:

getParameter [line 118]

Parameters:

getParameterType [line 149]

Parameters:

getProfile [line 187]

getRealizations [line 158]

Parameters:

getSubsystemClose [line 73]

getSubsystemOpen [line 66]

Parameters: