UserJourney Class
=================

.. php:class:: UserJourney

    Represents a User Journey diagram

    .. php:method:: addSection(Section ...$section)

        Add section(s)

        :param Section ...$section: The section(s)
        :returns: A new instance of ``UserJourney`` with the section(s) added
        :rtype: UserJourney

    .. php:method:: render(array $attributes = [])

        Renders the diagram

        :param array $attributes: HTML attributes for the <pre> tag as name=>value pairs

            .. note:: The *mermaid* class is added

        :returns: Mermaid diagram code in a <pre> tag
        :rtype: string

    .. php:method:: withComment(string $comment)

        Add a comment

        :param string $comment: The comment
        :returns: A new instance of ``UserJourney`` with the comment
        :rtype: UserJourney

    .. php:method:: withSection(Section ...$section)

        Set section(s)

        :param Section ...$section: The section(s)
        :returns: A new instance of ``UserJourney`` with the section(s)
        :rtype: UserJourney

    .. php:method:: withTitle(string $title)

        Set the title

        :param string $title: The title
        :returns: A new instance of ``UserJourney`` with the title
        :rtype: UserJourney