RequirementDiagram Class

class RequirementDiagram

Represents a RequirementDiagram diagram

addElement(Element ...$element)

Add element(s)

Parameters:

  • ...$element (Element) – The element(s)

Returns:

A new instance of RequirementDiagram with the element(s) added

Return type:

RequirementDiagram

addRelationship(Relationship ...$relationship)

Add relationship(s)

Parameters:
Returns:

A new instance of RequirementDiagram with the relationship(s) added

Return type:

RequirementDiagram

addRequirement(Requirement ...$requirement)

Add requirement(s)

Parameters:
Returns:

A new instance of RequirementDiagram with the requirement(s) added

Return type:

RequirementDiagram

render(array $attributes = [])

Renders the diagram

Parameters:

  • $attributes (array) –

    HTML attributes for the <pre> tag as name=>value pairs

    Note

    The mermaid class is added

Returns:

Mermaid diagram code in a <pre> tag

Return type:

string

withComment(string $comment)

Add a comment

Parameters:

  • $comment (string) – The comment

Returns:

A new instance of RequirementDiagram with the comment

Return type:

RequirementDiagram

withElement(Element ...$element)

Set element(s)

Parameters:

  • ...$element (Element) – The element(s)

Returns:

A new instance of RequirementDiagram with the element(s)

Return type:

RequirementDiagram

withRelationship(Relationship ...$relationship)

Set relationship(s)

Parameters:
Returns:

A new instance of RequirementDiagram with the relationship(s)

Return type:

RequirementDiagram

withRequirement(Requirement ...$requirement)

Set requirement(s)

Parameters:
Returns:

A new instance of RequirementDiagram with the requirement(s)

Return type:

RequirementDiagram

withTitle(string $title)

Add a title

Parameters:

  • $title (string) – The title

Returns:

A new instance of RequirementDiagram with the title

Return type:

RequirementDiagram