Usage in Symfony forms
======================

Netgen Content Browser supports calling the browser from Symfony forms. To
facilitate this, three custom Symfony form types have been implemented:

* Single content browser type
* Multiple content browser type
* Dynamic content browser type

.. include:: usage_requirements.rst.inc

Single content browser type
---------------------------

Single content browser type allows you to select a single item of a predefined
item type.

Form type class
~~~~~~~~~~~~~~~

``Netgen\ContentBrowser\Form\Type\ContentBrowserType``
``Netgen\ContentBrowser\Form\Type\ContentBrowserIntegerType``

Available options
~~~~~~~~~~~~~~~~~

* ``item_type``

    This option defines which item type will the browser select

    **type**: ``string``, **required**: Yes

* ``start_location``

    This option defines in which location the Content Browser will start.

    **type**: ``int|string``, **required**: No, **default value**: ``null``

* ``custom_params``

    This option is used to transfer any custom parameters to your backend.

    **type**: ``array``, **required**: No, **default value**: ``[]``

Other options
~~~~~~~~~~~~~

If using ``ContentBrowserType`` parent of this type will be Symfony ``TextType``
type, so any options available in that type can be used in this type too. Also,
in this case, the value returned by the Symfony form will be a string. If you
need an integer, you can use ``ContentBrowserIntegerType``, which will use
Symfony's ``IntegerType`` as the parent.

Multiple content browser type
-----------------------------

Multiple content browser type allows you to select one or more items of a
predefined item type.

Form type class
~~~~~~~~~~~~~~~

``Netgen\ContentBrowser\Form\Type\ContentBrowserMultipleType``
``Netgen\ContentBrowser\Form\Type\ContentBrowserMultipleIntegerType``

Available options
~~~~~~~~~~~~~~~~~

* ``item_type``

    This option defines which item type will the browser select

    **type**: ``string``, **required**: Yes

* ``min``

    This option defines how many items must at least be selected before the
    dialog can be closed. Use ``null`` to disable the limit.

    **type**: ``int``, **required**: No, **default value**: ``null``

* ``max``

    This option defines how many items must at maximum be selected for dialog to
    be closed. Use ``null`` to disable the limit.

    **type**: ``int``, **required**: No, **default value**: ``null``

* ``start_location``

    This option defines in which location the Content Browser will start.

    **type**: ``int|string``, **required**: No, **default value**: ``null``

* ``custom_params``

    This option is used to transfer any custom parameters to your backend.

    **type**: ``array``, **required**: No, **default value**: ``[]``

Other options
~~~~~~~~~~~~~

Parent of this type is the Symfony ``CollectionType`` type, so any options
available in that type can be used in this type too.

The values returned by the Symfony form will be strings. If you need integers,
you can use ``ContentBrowserMultipleIntegerType``.

Dynamic content browser type
----------------------------

Dynamic content browser type allows you to select a single item, however, in
contrast to ``ContentBrowserType`` type, this type allows you to select the item
type before calling the dialog.

This type is the composite one, meaning it is constructed from two child forms,
one that will hold the selected item type (named ``item_type``) and the one that
will hold the selected item ID (named ``item_id``).

Form type class
~~~~~~~~~~~~~~~

``Netgen\ContentBrowser\Form\Type\ContentBrowserDynamicType``

Available options
~~~~~~~~~~~~~~~~~

* ``item_types``

    This option defines which item types will be available to select from

    **type**: ``array`` of ``string`` values, **required**: Yes

* ``start_location``

    This option defines in which location the Content Browser will start.

    **type**: ``int|string``, **required**: No, **default value**: ``null``

* ``custom_params``

    This option is used to transfer any custom parameters to your backend.

    **type**: ``array``, **required**: No, **default value**: ``[]``