Packet Class
=============

.. php:class:: Packet

    Represents a Packet diagram

    .. php:method:: render(array $attributes)

        Render the Mermaid code enclosed in a <pre> tag

        :param array $attributes: HTML attributes for the enclosing <pre> tag
        :returns: Mermaid code enclosed in a <pre> tag
       :rtype: string

    .. php:method:: addField(Field ...$field)

        Add packet field(s)

        :param Field ...$field: The packet field(s)
        :returns: A new instance of ``Packet`` with the fields added to existing fields
        :rtype: Packet

    .. 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:: withField(Field ...$field)

        Set packet field(s)

        :param Field ...$field: The packet field(s)
        :returns: A new instance of ``Packet`` with the fields
        :rtype: Packet

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

        Set the diagram title

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