RealURL¶

The Display Controller provides a user object for creating speaking URLs for any link to a single record in conjunction with RealURL.

A typical configuration will look like:

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['realurl']['_DEFAULT']['postVarSets']['_DEFAULT'] = array(
        'item' => array(
                array(
                        'GETvar' => 'tx_displaycontroller[table]',
                        'valueMap' => array(
                                'news' => 'tt_news'
                        ),
                ),
                array(
                        'GETvar' => 'tx_displaycontroller[showUid]',
                        'userFunc' => 'Tesseract\\Displaycontroller\\Utility\\RealUrlTranslator->main',
                        'userFunc.' => array(
                                'tt_news ' => array(
                                        'alias_field' => 'title',
                                ),
                        )
                ),
        )
);

Note how the postVarSets configuration uses the "item" key. This is the default key expected by the Display Controller's RealURL user-function. It's possible to use another key, but it must be defined in the TypoScript configuration:

plugin.tx_displaycontroller.detailView.postVarSets = item

When creating a link to a single record, the Tesseract requires the link to be built using tx_displaycontroller[table] and tx_displaycontroller[showUid] query parameters, the first one containing the table's name and the second the primary key of the record. The Display Controller provides RealURL with a user object to transforms these parameters into a speaking URL.

In the above configuration the first parameter (tx_displaycontroller[table]) is mapped to a list of tables. The key used in the array will be the name of the table as a segment in the speaking URL. The second parameter (tx_displaycontroller[showUid]) refers to a user function for generating the alias with the proper field (of the proper table, since it will refer to tx_displaycontroller[table].

It is very important to keep these two configurations (for "table" and for "showUid") exactly in that order because it is expected to be this way. Setting a different order or using other indices in the configuration array will break the encoding/decoding process.

If the "alias_field" property is missing, the Display Controller will use the "uid" field as a fall-back.

The "alias_field" property in the configuration can be more than a simple string. It can contain expressions that will be interpreted by the expressions parser. Example:

'alias_field' => 'header_{date:Y}'

Another feature is to use a marker called ###LANG### which contains the 2-letter ISO code associated with the language in which the URL is being generated. The code is deducted from the language value map entered in the RealURL configuration. Given the following configuration:

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['realurl']['_DEFAULT']['preVars'] = array(
        array(
                'GETvar' => 'L',
                'valueMap' => array(
                        'fr' => '0',
                        'en' => '1',
                        'de' => '2',
                        'it' => '3'
                ),
                'valueDefault' => 'fr',
                'noMatch' => 'bypass',
        ),
);

the ###LANG### marker will contain "fr" when language is 0 or undefined (default), "en" when language is 1, etc. The "alias_field" configuration would then look like:

'alias_field' => 'header_###LANG###'

Note that to make the language configuration more easily accessible for the Display Controller, it is possible to use the "lang" key as index to the language configuration. So the above configuration would be written as:

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['realurl']['_DEFAULT']['preVars'] = array(
        'lang' => array(
                'GETvar' => 'L',
                'valueMap' => array(
                        'fr' => '0',
                        'en' => '1',
                        'de' => '2',
                        'it' => '3'
                ),
                'valueDefault' => 'fr',
                'noMatch' => 'bypass',
        ),
);