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

Class: PHP_UML_Metamodel_Superstructure

Source Location: /PHP_UML-1.6.2/UML/Metamodel/Superstructure.php

Class Overview


A superstructure is a set composed of a UML model, a physical model, and some stereotypes associated to the UML model.


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 29]
A superstructure is a set composed of a UML model, a physical model, and some stereotypes associated to the UML model.


[ Top ]


Class Variables

$deploymentPackages =

[line 52]

The root package for a deployment (physical) model
  • Access: public



[ Top ]

$packages =

[line 45]

The root package for a logical UML model
  • Access: public



[ Top ]

$stereotypes = array()

[line 61]

Stack of all stereotypes TODO: when real stereotypes will be implemented, deleting that array, and reading the stereotypes from the $packages instead
  • Access: public

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 67]

PHP_UML_Metamodel_Superstructure __construct( )

Constructor
  • Access: public

[ Top ]

addDocTags   [line 116]

void addDocTags( PHP_UML_Metamodel_NamedElement &$element, string $desc, [array $docs = array()])

Creates a stereotype and the necessary Tag objects for a given element
  • Access: public

Parameters:

PHP_UML_Metamodel_NamedElement   &$element   —  The element to document
string   $desc   —  A textual description
array   $docs   —  An array containing docblocks

[ Top ]

addInternalPhpTypes   [line 75]

void addInternalPhpTypes( )

Adds the internal PHP metatypes, metaclasses, metainterfaces...
  • Access: public

[ Top ]

createStereotype   [line 228]

PHP_UML_Metamodel_Stereotype createStereotype( PHP_UML_Metamodel_NamedElement &$element, string $profileName, string $stereotypeName)

Creates a stereotype in a given profile, and binds it to a given element Returns the stereotype that was created
  • Access: public

Parameters:

PHP_UML_Metamodel_NamedElement   &$element   —  The element
string   $profileName   —  The profile name
string   $stereotypeName   —  The stereotype name

[ Top ]

finalizeAll   [line 253]

void finalizeAll( [bool $noEmptyPkg = true], [array $defPkg = array()])

Finalizes the main object structure that the Parser has built.

Launches the resolution of the references for all stacks from the root pkg

Every reference (a temporary string) is replaced by a PHP reference to the corresponding type (that is, a class or a datatype) Must be run once the model is complete (= once PHP parsing is done)

  • Access: public

Parameters:

bool   $noEmptyPkg   —  True to force removal of empty packages
array   $defPkg   —  Array of PHP_UML_Metamodel_Package where to look into, in order to resolve the orphaned elements. By default, it will look in the root package. This is, by the way, where the PHP datatypes are.

[ Top ]

getStereotype   [line 208]

PHP_UML_Metamodel_Stereotype getStereotype( PHP_UML_Metamodel_NamedElement $element, string $profileName, string $stereotypeName)

Retrieves the stereotype (named $name) associated to the element $element If not found, returns null.
  • Access: public

Parameters:

PHP_UML_Metamodel_NamedElement   $element   —  Related object
string   $profileName   —  Profile name
string   $stereotypeName   —  Stereotype name

[ Top ]

initModel   [line 275]

void initModel( [string $modelName = 'default'])

Initialize the structure before use (we just instantiate the top objects in the logical and deployment models)
  • Access: public

Parameters:

string   $modelName   —  Model name

[ Top ]


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