.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../../../Includes.txt

ForeignMultipleMm
^^^^^^^^^^^^^^^^^

.. figure:: ../../../Images/Configuration/ForeignMultiple.png
	:width: 500px
	:alt: ForeignMultipleMm form element

	There is a dropdown to select entries from which are then saved into the relation (MM) table.

The idea here is to select multiple entries from another table and saving the relations (our original entry and one with one or many entries from the foreign table) in a separate relation (MM) table. Our original table, by the way, always is updated with the current number of relations.

nMaxCount
---------

Number. If bigger than 0, this is the maximum amount of elements taken.

bShowAsMultipleCheckboxes
-------------------------

Boolean. If set to true, checkboxes for all (!) possible options are shown in order to allow the user to check the applicable ones. Of course, this makes sense only if there are not too many options. Default is false.

sForeignDatabase
----------------

String. If set and different from the default database in this SQL Frontend, all calls relevant to this foreign key are executed on this foreign database. Keep in mind that the database has to be accessible by the same database user as defined in *dbal*.

sForeignTable
-------------

String. The table to fetch the entries from (within the same database).

sForeignColumn
--------------

String. Column/Field to save into the relation table.

sForeignColumnShow
------------------

String. The column/field to show to the user.

sForeignTableOrderBy
--------------------

String. The column/field to sort the foreign table by. Define the order in which to present the values in the form element to the user. Append an *ASC* (from a to z) or *DESC* (from z to a) to specify the direction.

Example: ::

    name ASC

bForeignHideEmptyEntry
----------------------

Boolean. If true, empty entries (we are talking about sForeignColumn) are not shown at all.

bOrderByValue
-------------

Boolean. If true, shown entries are sorted by their shown value.

bOrderByRawValue
----------------

Boolean. If true, shown entries are sorted by their column value.

If both bOrderByValue and bOrderByRawValue are set, bOrderByValue is taken.

aForeignWhereShow
-----------------

Array with where additions that is applied to the foreign table when loading values for output. Example: ::

    'aForeignWhereShow' => array(
        'pid:24',
        'hidden:0'
    )

aForeignWhereForm
-----------------

Array with where additions that is applied to the foreign table when loading values for the **form**. Example is actually the same as aForeignWhereShow except that you might want to add something or leave something out.

The **difference between aForeignWhereShow and aForeignWhereForm** is that the first is applied when loading values for outputs whereas the latter is applied when loading values for the form dropdown. This might come in handy whenever you want to give the user the possibility to select only entries that are x and y but want to display them even if they are now not y anymore. More practical example: Let users only select entries that are not hidden but since you change those settings from time to time you might still want to display entries where the foreign keys are -- in the meantime -- hiden.

sLocalUid
---------

String. The key column within our original table that should be written to the MM table as the local uid.

Example: ::

    uid

sForeignRelation
----------------

String. Table name of the MM relation table.

Example: ::

    tx_news_domain_model_category_feusers_mm

sForeignRelationUidLocal
------------------------

String. Name of the column/field in the MM relation table that holds sLocalUid (our original table's key). Most probably (following a TYPO3 kind-of standard) this is just *uid_local*.

Example: ::

    uid_local

sForeignRelationUidForeign
--------------------------

String. Just like sForeignRelationUidLocal but for the foreign key.

Example: ::

    uid_foreign

sForeignRelationOrderBy
-----------------------

String. How to sort the MM table which defines how to sort the entries for the user. You may append an *ASC* for a-z order or a *DESC* for z-a order.

Example: ::

    crdate ASC

aForeignRelationWhere
---------------------

Array holding where additions for the relation (MM) table. Most likely you won't need this but at least you have the possibilty to use it.

Example: ::

    'aForeignRelationWhere' => array(
        'deleted:0',
        'hidden:0'
    )

sWrapSingle
-----------

String. Wrapper for every single entry. Don't forget to include a pipe symbol (|). Example: ::

    <li>|</li>

sConcatenate
------------

String. Now think of the uploaded files being outputted in a normal or detail view. How would you like to chain multiple images together? Default is a simple comma but you might change that here.

Example: ::

    ,

sConcatenateRaw
---------------

String. See sConcatenate. This is pretty much the same except that this chaining string is used whenever we need a raw output (at the moment, only CSV files are built upon raw outputs).