Class Diagram

The mermaid documentation describes Class Diagrams as:

The class diagram is the main building block of object-oriented modeling. It is used for general conceptual modeling of the structure of the application, and for detailed modeling to translate the models into programming code. Class diagrams can also be used for data modeling. The classes in a class diagram represent both the main elements, interactions in the application, and the classes to be programmed.

In Siren, we attempt to use the language of mermaid.js as consitently as possible for building up your Class Diagrams, with one notable exception — classes are represented as Symbol. We have generalized Symbol since this package is for PHP and we want class, interface, trait and enum to be first class concepts. You still have the possiblity of providing general Annotations too.

For example:

$diagram = Siren::class('Class Diagram')
    ->addSymbol($c = Symbol::class('ClassA'))
    ->addSymbol($i = Symbol::interface('InterfaceA'))
    ->addRelation(Relation::make($c, i)
        ->strength(Strength::DEPENDENCY)
        ->connection($c, Connection::EXTENSION)
    );

---
title: Class Diagram
---
classDiagram
class ClassA
class InterfaceA{
<<interface>>
}

ClassA <|.. InterfaceA

Loading

Direction

Enum: \Siren\Builder\ClassDiagram\Enums\Direction

Sets the direction the Class Diagram flows in.

---
title: Direction::TOP_DOWN or Direction::TOP_TO_BOTTOM
---
classDiagram
  direction TD
  classA --> classB

Loading

---
title: Direction::BOTTOM_TO_TOP
---
classDiagram
  direction BT
  classA --> classB

Loading

---
title: Direction::LEFT_TO_RIGHT
---
classDiagram
  direction LR
  classA --> classB

Loading

---
title: Direction::RIGHT_TO_LEFT
---
classDiagram
  direction RL
  classA --> classB

Loading

Symbol

Class: \Siren\Builder\ClassDiagram\Symbol

The Symbols are the building blocks of the class diagram and are used to define the various object types in the system. The main Symbol types are ::class(), ::interface(), ::trait(), ::enum(), however you can also add any annotation you want to your ::class()es.

Symbol::trait('HasLions')
    ->addMember(Member::make('pride')->visibility(Visibility::PROTECTED)->type('array<Lion>'))
    ->addMethod(Method::make('addLion')->addArgument('lion', 'Lion'));

classDiagram
class HasLions{
<<trait>>
array~Lion~ pride
addLion(Lion lion)
}

Loading

Symbol::class('MailService')
    ->annotation('service')
    ->addMethod(Method::make('send')->addArgument('message', 'Mail'));

classDiagram
class MailService{
<<service>>
send(Mail message)
}

Loading

Modifier

Enum: \Siren\Builder\ClassDiagram\Enums\Modifier

Modifier
ABSTRACT
FINAL

There are a few variations of the class Symbol which can be controlled by passing them to the class(string name, ?Modifier modifier = null) method of the ClassDiagram. This will simply add the proper annotations.

Siren::class()
    ->addSymbol(Symbol::class('AbstractModel', Modifier::ABSTRACT))

classDiagram
class Person{
    <<abstract>>
}

Loading

Member

Class: \Siren\Builder\ClassDiagram\Member

These are individual items of a Symbol's attribute list. You can add Members to a Symbol using its addMember(Member member) method.

Member::make('taxRate')
    ->visibility(Visibility::PRIVATE)
    ->classifier(Classifier::STATIC)
    ->type('Percentage')

classDiagram
class Country{
    Percentage taxRate$
}

Loading

Method

Class: \Siren\Builder\ClassDiagram\Method

The functions and methods defined by a Symbol. You can add Methods to a Symbol using its addMethod(Method method) method.

Method::make('salesTax')
    ->addArgument(Argument::make('amount', 'Money'))
    ->visibility(Visibility::PUBLIC)
    ->classifier(Classifier::ABSTRACT)
    ->return('Money')

classDiagram
class Country{
    +salesTax(Money amount)* Money
}

Loading

Argument

Class: \Siren\Builder\ClassDiagram\Argument

Arguments define the interface of a Method, and can be added using the addArgument(Argument argument) method.

Argument::make('name', 'type')

classDiagram
class Class{
    method(type name)
}

Loading

Type

Class: \Siren\Builder\ClassDiagram\Type

Types are used to define the data type of values in the Diagram. For example return types, argument types or member types. Type is abstracted from package consumers, and is handled in methods like addArgument(string name, string type).

Visiblity

Enum: \Siren\Builder\ClassDiagram\Enums\Visibility

Visbility
PUBLIC
PROTECTED
PRIVATE
INTERNAL

The visiblity of a Method or Member. You can add visiblity using the visibility(Visibility visiblity) method.

classDiagram
class Person{
    +public
    #protected
    -private
    unspecified
}

Loading

Classifier

Enum: \Siren\Builder\ClassDiagram\Enums\Classifier

Classifier
ABSTRACT
STATIC

The classifier of a Method or Member. You can add classifier using the classifier(Classifier classifier) method.

classDiagram
class Person{
    string staticProperty$
    void abstractMethod()*
}

Loading

Relation

Class: \Siren\Builder\ClassDiagram\Relation

Relations define the connections between the Symbols of the diagram, and express the way in which they are connected.

Siren::class()
    ->addSymbol($a = Symbol::class('ClassA'))
    ->addSymbol($b = Symbol::class('ClassB'))
    ->addRelation(Relation::make($a, b)
            ->name('🧜‍♀️ Relation')
            ->connection($a, Connection::AGGREGATION)
            ->multiplicity($a, Multiplicity::ONE_TO_N)
            ->strength(Strength::DEPENDENCY));

classDiagram
direction LR
class ClassA
class ClassB
ClassA "1..n" o.. ClassB : "🧜‍♀️ Relation"

Loading

Strength

Enum: \Siren\Builder\ClassDiagram\Enums\Strength

Strength
ASSOCIATION
DEPENDENCY

The implied stength of the relation between two Symbols.

classDiagram
direction TB
ClassA -- ClassB : ASSOCIATION
ClassB .. ClassC : DEPENDENCY

Loading

Multiplicity

Enum: \Siren\Builder\ClassDiagram\Enums\Multiplicity

Multiplicity
ONLY_ONE
ZERO_OR_ONE
ONE_OR_MORE
MANY
N
ZERO_TO_N
ONE_TO_N

Multiplicity defines the number of instance of one Symbol that can be attached to another Symbol.

classDiagram
ClassA --> "1" ClassB : ONLY_ONE
ClassC --> "0..1" ClassD : ZERO_OR_ONE
ClassE --> "1..*" ClassF : ONE_OR_MORE
ClassG --> "*" ClassH : MANY
ClassI --> "n" ClassJ : N
ClassK --> "0..n" ClassL : ZERO_TO_N
ClassM --> "1..n" ClassN : ONE_TO_N

Loading

Connection

Enum: \Siren\Builder\ClassDiagram\Enums\Connection

Connection
EXTENSION
DEPENDENCY
COMPOSITION
AGGREGATION

Connection defines the nature of the relationship between the two Symbols.

classDiagram
ClassA --|> ClassB : EXTENSION
ClassC --> ClassD : DEPENDENCY
ClassE --* ClassF : COMPOSITION
ClassG --o ClassH : AGGREGATION
ClassI -- ClassJ : NONE

Loading

Diagram of ClassDiagram

And here is a mermaid.js Class Diagram, of Siren's ClassDiagram generator.

---
title: Class Diagram for Siren's ClassDiagram
---
classDiagram
class ClassDiagram{
?string title
array symbols
array relations
+addSymbol(Symbol symbol) self
+hasSymbol(Symbol symbol) bool
+removeSymbol(Symbol symbol) self
+addRelation(Relation relation) self
+hasRelation(Relation relation) bool
+removeRelation(Relation relation) self
__toString() string
}

class Symbol{
string name
array~Member~ members
array~Method~ methods
?string annotation
class(string name, ?Modifier modifier)$ self
interface(string name)$ self
enum(string name)$ self
trait(string name)$ self
annotation(string annotation) self
addMember(Member member) self
addMethod(Method method) self
__toString() string
}

class Member{
string name
?Type type
?Classifier classifier
?Visibility visibility
+make(string name, ?string type)$ self
+type(string type) self
+classifier(Classifier classifier) self
+visibility(Visibility visibility) self
+__toString() string
}

class Method{
string name
array arguments
?Type return
?Visibility visibility
?Classifier classifier
+make(string name)$ self
+addArgument(string name, ?string type) self
+return(string type) self
+classifier(Classifier classifier) self
+visibility(Visibility visibility) self
+__toString() string
}

class Relation{
Symbol symbolA
?Connection connectionA
?Multiplicity multiplicityA
Symbol symbolB
?Connection connectionB
?Multiplicity multiplicityB
Strength strength
?string name
make(Symbol symbolA, Symbol symbolB)$ self
key() string
name(string name) self
connection(Symbol symbol, ?Connection connection) self
multiplicity(Symbol symbol, ?Multiplicity multiplicity) self
strength(Strength strength) self
__toString() string
}

class Type{
string type
+make(string type)$ self
__toString() string
}

class Argument{
string name
?Type type
+make(string name, ?string type)$ self
__toString() string
}

class Classifier{
<<enum>>
ABSTRACT
STATIC
}

class Connection{
<<enum>>
EXTENSION
DEPENDENCY
COMPOSITION
AGGREGATION
}

class Modifier{
<<enum>>
ABSTRACT
FINAL
}

class Multiplicity{
<<enum>>
ONLY_ONE
ZERO_OR_ONE
ONE_OR_MORE
MANY
N
ZERO_TO_N
ONE_TO_N
}

class Strength{
<<enum>>
DEPENDENCY
ASSOCIATION
}

class Visibility{
<<enum>>
PUBLIC
PROTECTED
PRIVATE
INTERNAL
}

ClassDiagram --o Symbol
ClassDiagram --o Relation
Relation --> Multiplicity
Relation --> Strength
Relation --> Connection
Symbol --o Member
Symbol --> Method
Symbol --> Modifier
Member --> Type
Member --> Classifier
Member --> Visibility
Method --> Type
Method --o Argument
Method --> Visibility
Method --> Classifier
Argument --> Type

Loading

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

class-diagram.md

class-diagram.md

Class Diagram

Contents

Direction

Symbol

Modifier

Member

Method

Argument

Type

Visiblity

Classifier

Relation

Strength

Multiplicity

Connection

Diagram of ClassDiagram

Files

class-diagram.md

Latest commit

History

class-diagram.md

File metadata and controls

Class Diagram

Contents

Direction

Symbol

Modifier

Member

Method

Argument

Type

Visiblity

Classifier

Relation

Strength

Multiplicity

Connection

Diagram of ClassDiagram