README

TYPO3 Extension singleview #############################

local

What does it do?

This extension allows to display single view on different page than list view and still keep urls user and SEO friendly.

Look at example below for better understanding.

Lets take following list view url:

https://www.example.com/list/

TYPO3 default is that when you put single view on different page then there is no easy way to remove it from slugified url. You will get something like below (single view is on separate page named "detail"):

https://www.example.com/list/detail/title-of-single-item/

If you will use ext:singleview then you can put single view on different page than list view but the slugified url will still look nice like below - so no /detail/ part.

https://www.example.com/list/title-of-single-item/

Installation

Use composer:

composer require sourcebroker/singleview

Usage

Each configuration of the ext:singleview settings has to be registered in your ext_localconf.php file using \SourceBroker\Singleview\Service\SingleViewService::registerConfig() static method as in example below (for ext:news)

<?php

\SourceBroker\Singleview\Service\SingleViewService::registerConfig(
    1,
    2,
    function() {
        $newsParams = \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('tx_news_pi1');
        return !empty($newsParams['news']);
    },
    ['backend_layout'],
);

Parameters of registerConfig() method:

First param is PID of the list view page.
Second param is PID of the single view page.
Third param is closure which returns boolean (or boolean value as a condition) which needs to be met to show single page on list view page. Closure is good here because at ext_localconf.php level the url/slug is not decoded yet so the value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('tx_news_pi1') is empty. But at the place the closure is executed the \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('tx_news_pi1') will return good value.
Fourth param is optional and its array of strings with names of the fields which will be copied from single page to list page. If you use backend_layouts for managing your layouts then probably you should put there ['backend_layout']

IMPORTANT!

Single view links should point to the same page uid as list view.

Technical background

The idea behind is to use TYPO3 build in feature "Show content from pid" which you can find in page properties. In this extension value for "Show content from pid" field is set dynamically based on $_GET parameter. When TYPO3 renders page with list view then ext:singleview checks if $_GET parameter has single view request. If this is true then it sets "content_from_pid" field with value of single view page uid. This way single view page with its content and layout is shown on list view page.

To be sure that TYPO3 will not use one cache for list view and single view a "content_from_pid" is added to hashBase. You can deactivate this behaviour by setting: $GLOBALS['TYPO3_CONF_VARS']['EXT']['EXTCONF']['singleview']['hashBaseCustomization']['enabled'] = false;

Changelog

See https://github.com/sourcebroker/singleview/blob/master/CHANGELOG.rst

sourcebroker / singleview

Maintainers

Details