ZenUmlDiagram Class

class ZenUmlDiagram

Represents a ZenUmlDiagram

addItem(ItemInterface ...$interface)

Add item(s)

Parameters:
Returns:

A new instance of ZenUmlDiagram with the item(s) added

Return type:

ZenUmlDiagram

addParticipant(Participant ...$participant)

Add participant(s)

Parameters:
Returns:

A new instance of ZenUmlDiagram with the participant(s) added

Return type:

ZenUmlDiagram

render(array $attributes)

Render the Mermaid code enclosed in a <pre> tag

Parameters:
  • $attributes (array) – HTML attributes for the enclosing <pre> tag

Returns:

Mermaid code enclosed in a <pre> tag

Return type:

string

withComment(string $comment)

Sets a comment for the ZenUmlDiagram

Parameters:
  • $comment (string) – The comment

Returns:

A new instance of ZenUmlDiagram with the comment

Return type:

ZenUmlDiagram

withItem(ItemInterface ...$interface)

Set item(s)

Parameters:
Returns:

A new instance of ZenUmlDiagram with the item(s)

Return type:

ZenUmlDiagram

withTitle(string $title)

Sets a title for the ZenUmlDiagram

Parameters:
  • $title (string) – The title

Returns:

A new instance of ZenUmlDiagram with the title

Return type:

ZenUmlDiagram

withParticipant(Participant ...$participant)

Set participant(s)

Parameters:
Returns:

A new instance of ZenUmlDiagram with the participant(s)

Return type:

ZenUmlDiagram