nahakiole / staruml-php Goto Github PK

View Code? Open in Web Editor NEW

18.0 2.0 8.0 567 KB

PHP extension for StarUML

Home Page: https://staruml.io/extensions

License: MIT License

JavaScript 100.00%

code-generator extension php staruml uml uml-diagram

staruml-php's Introduction

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

Click the menu (Tools > PHP > Generate Code...)
Select a base model (or package) that will be generated to PHP.
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).

staruml-php's People

Contributors

Stargazers

Watchers

Forkers

mthibaut-hbc ricardopedias mandisma espiat hanjoyo firofa rootsnase toddwolaver

staruml-php's Issues

Default value for parameter is not set

Default value for operation parameters are not set after code generation
Operation parameters can't have a default value, as it'll not be set after code generation

Attach the .mdj file
.mdj files are not supported which is why I embed two screenshots

To Reproduce
Steps to reproduce the behavior:

Create a class diagram
Create a class
Add an operation to the class
Add a parameter to the operation
Click on the parameter to configure
Go under "Properties"
Write down a type related value under "defaultValue"

Expected behavior

Code should be generated
Parameter has a default value

Actual behavior

Parameter has no default value

Screenshots

Type hints not working correctly?

Type hints don't get the class names but instead [object Object]. Is this a bug, or am I doing something wrong?

Here's an example.

Class diagram:

+-----------------------+
| SynchronizerInterface |
+-----------------------+
| +synchronize()        |
+-----------------------+

+---------------------------------------------------------------+
|                         Synchronizer                          |
+---------------------------------------------------------------+
| -synchronizers: SynchronizerInterface[0..*]                   |
+---------------------------------------------------------------+
| +__construct(synchronizers: SynchronizerInterface[0..*] = []) |
| +add(synchronizer: SynchronizerInterface)                     |
+---------------------------------------------------------------+

Generated PHP code of the SynchronizerInterface interface and Synchronizer implementation:

interface SynchronizerInterface
{

    /**
     * 
     */
    public function synchronize();

}

class Synchronizer implements SynchronizerInterface
{

    /** @var [object Object][] */
    private array $synchronizers;

    /**
     * @param [object Object][] $synchronizers
     */
    public function __construct([object Object] $synchronizers = [])
    {
        // TODO implement here
    }

    /**
     * @param [object Object] $synchronizer
     */
    public function add([object Object] $synchronizer)
    {
        // TODO implement here
    }

    /**
     * 
     */
    public function synchronize()
    {
        // TODO implement here
    }

}

Type-hint arguments and return types

Could you add (or direct me) to how I can generate code with 7.1 type hints?

function myFunction( int $integer ): string
{
    return "{$integer}";
}

Property "readOnly" won't generate to a class constant

Attribute property: "readOnly" won't convert to const
With StarUML you can create--of course--attributes. Some of them may be constants so there is an option to mark them as such. This property is called readOnly.

Attach the .mdj file
.mdj files are not supported which is why I created two sceenshots.