Docs For Class PHP_UML_XMI

getArtifact [line 171]

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

Retrieves 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 133]

string getClass(
PHP_UML_Metamodel_Class
&$class)

Retrieves the XMI code for a class

Return: XMI code

Parameters:

PHP_UML_Metamodel_Class &$class — Class

[ Top ]

getComment [line 232]

string getComment(
PHP_UML_Metamodel_Stereotype
&$s, [string
$annotatedElement = ''])

Adds a description/comment to a model element The description is given through a stereotype instance

Return: XMI code

Parameters:

PHP_UML_Metamodel_Stereotype	`&$s`	—	A stereotype object
string	`$annotatedElement`	—	The commented element

[ Top ]

getComponentClose [line 189]

string getComponentClose(
)

Retieves the closing tag for a component

Return: XMI code

[ Top ]

getComponentOpen [line 182]

string getComponentOpen(
PHP_UML_Metamodel_Package
$package, array
$provided, array
$required)

Retrieves the XMI code for a component

Return: XMI code

Parameters:

PHP_UML_Metamodel_Package	`$package`	—	Package to add as a component
array	`$provided`	—	Set of providing classes
array	`$required`	—	Set of required classes (TODO)

[ Top ]

getDatatype [line 124]

string getDatatype(
PHP_UML_Metamodel_Type
$type)

Retrieves the XMI declarations of the main PHP types

Return: XMI code

Parameters:

PHP_UML_Type $type — Datatype

[ Top ]

getGeneralizations [line 221]

mixed getGeneralizations(
PHP_UML_Metamodel_Type
&$client)

Retrieves 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 142]

string getInterface(
PHP_UML_Metamodel_Interface
&$interface)

Retrieves the XMI code for an interface

Return: XMI code

Parameters:

PHP_UML_Metamodel_Interface &$interface — Class

[ Top ]

getMetadata [line 248]

string getMetadata(
PHP_UML_Metamodel_Tag
$tag)

Retrieves the metadata related to a given tag

Return: XMI code
Access: public

Parameters:

PHP_UML_Metamodel_Tag $tag — Tag

[ Top ]

getModelClose [line 55]

string getModelClose(
)

Retrieves the closing tag of a model

Return: XMI code

[ Top ]

getModelOpen [line 48]

string getModelOpen(
PHP_UML_Metamodel_Package
&$model)

Retrieves the opening tag for a model

Return: XMI code

Parameters:

string &$model — Root package

[ Top ]

getNamespaceClose [line 85]

string getNamespaceClose(
)

Retrieves the closing namespace tag (XMI 1 only)

Return: XMI code

[ Top ]

getNamespaceOpen [line 78]

string getNamespaceOpen(
)

Retrieves the opening namespace tag (XMI 1 only)

Return: XMI code

[ Top ]

getOperation [line 151]

string getOperation(
PHP_UML_Metamodel_Operation
&$operation)

Retrieves the XMI code for an operation

Return: XMI code

Parameters:

PHP_UML_Metamodel_Operation &$operation — Operation

[ Top ]

getPackageClose [line 71]

string getPackageClose(
)

Retrieves the closing tag of a package

Return: XMI code

[ Top ]

getPackageOpen [line 64]

string getPackageOpen(
PHP_UML_Metamodel_Package
$package)

Retrieves the opening tag for a package

Return: XMI code

Parameters:

PHP_UML_Metamodel_Package $package — Package to insert

[ Top ]

getParameter [line 160]

string getParameter(
PHP_UML_Metamodel_Parameter
&$parameter)

Retrieves the XMI code for the paramater of an operation

Return: XMI code

Parameters:

PHP_UML_Metamodel_Parameter &$parameter — Parameter

[ Top ]

getParameterType [line 199]

string getParameterType(
PHP_UML_Metamodel_TypedElement
&$parameter)

Retrieves 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 (datatype, class..)

[ Top ]

getProfile [line 239]

string getProfile(
)

Retrieves the XMI code for a UML2 profile.

Return: XMI code

[ Top ]

getRealizations [line 209]

string getRealizations(
PHP_UML_Metamodel_Class
&$client)

Retrieves 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 ]

getStereotypeInstance [line 115]

void getStereotypeInstance(
PHP_UML_Metamodel_Stereotype
$s)

Retrieves the XMI code for a given stereotype

Parameters:

PHP_UML_Metamodel_Stereotype $s — Stereotype

[ Top ]

getStereotypes [line 108]

string getStereotypes(
)

Retrieves the necessary stereotypes

Return: XMI code

[ Top ]

getSubsystemClose [line 101]

string getSubsystemClose(
)

Retrieves the closing tag for a subsystem / component

Return: XMI code

[ Top ]

getSubsystemOpen [line 94]

string getSubsystemOpen(
PHP_UML_Metamodel_Package
$package)

Retrieves 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 ]

getXmiHeaderClose [line 39]

string getXmiHeaderClose(
)

Closing tag for the XMI header

Return: XMI code

[ Top ]

getXmiHeaderOpen [line 32]

string getXmiHeaderOpen(
)

Retrievesthe XMI header

Return: XMI code

[ Top ]

Class: PHP_UML_XMI_Builder

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

getArtifact [line 171]

Parameters:

getClass [line 133]

Parameters:

getComment [line 232]

Parameters:

getComponentClose [line 189]

getComponentOpen [line 182]

Parameters:

getDatatype [line 124]

Parameters:

getGeneralizations [line 221]

Parameters:

getInterface [line 142]

Parameters:

getMetadata [line 248]

Parameters:

getModelClose [line 55]

getModelOpen [line 48]

Parameters:

getNamespaceClose [line 85]

getNamespaceOpen [line 78]

getOperation [line 151]

Parameters:

getPackageClose [line 71]

getPackageOpen [line 64]

Parameters:

getParameter [line 160]

Parameters:

getParameterType [line 199]

Parameters:

getProfile [line 239]

getRealizations [line 209]

Parameters:

getStereotypeInstance [line 115]

Parameters:

getStereotypes [line 108]

getSubsystemClose [line 101]

getSubsystemOpen [line 94]

Parameters:

getXmiHeaderClose [line 39]

getXmiHeaderOpen [line 32]