mthibaut-hbc / staruml-php

PHP extension for StarUML

PHP Extension for StarUML

This extension for StarUML(http://staruml.io) support to generate PHP code from UML model. Install this extension from Extension Manager of StarUML.

Based on https://github.com/staruml/staruml-java

PHP Code Generation

1. Click the menu (Tools > PHP > Generate Code...)
2. Select a base model (or package) that will be generated to PHP.
3. Select a folder where generated PHP source files will be placed.

Belows are the rules to convert from UML model elements to PHP source codes.

UMLPackage

• converted to PHP Namespace (as a folder).

UMLClass

• converted to PHP Class. (as a separate .php file)
• visibility to one of modifiers public, protected, private and none.
• isAbstract property to abstract modifier.
• Default constructor is generated.
• All contained types (UMLClass, UMLInterface, UMLEnumeration) are generated as inner type definition.
• Documentation property to PHPDoc comment.

UMLAttribute

• converted to PHP Field.
• visibility property to one of modifiers public, protected, private and none.
• name property to field identifier.
• multiplicity property to array type.
• isStatic property to static modifier.
• defaultValue property to initial value.
• Documentation property to PHPDoc comment.

UMLOperation

• converted to PHP Methods.
• visibility property to one of modifiers public, protected, private and none.
• name property to method identifier.
• isAbstract property to abstract modifier.
• isStatic property to static modifier.
• UMLParameter to PHP Method Parameters.
• UMLParameter's name property to parameter identifier.
• Documentation property to PHPDoc comment.

UMLInterface

• converted to PHP Interface. (as a separate .php file)
• visibility property to one of modifiers public, protected, private and none.
• Documentation property to PHPDoc comment.

UMLEnumeration

• converted to PHP Class. (as a separate .php file)
• visibility property to one of modifiers public, protected, private and none.
• UMLEnumerationLiteral to literals of enum.

UMLAssociationEnd

• converted to PHP Field.
• visibility property to one of modifiers public, protected, private and none.
• name property to field identifier.
• defaultValue property to initial value.
• Documentation property to PHPDoc comment.

UMLGeneralization

• converted to PHP Extends (extends).
• Allowed only for UMLClass to UMLClass, and UMLInterface to UMLInterface.

UMLInterfaceRealization

• converted to PHP Implements (implements).
• Allowed only for UMLClass to UMLInterface.

---

Licensed under the MIT license (see LICENSE file).