TYPO3 DocCheck Login

Extension key

typo3_docchecklogin

Package name

antwerpes/typo3-docchecklogin

Version

2.1

Language

en

Author

Sabrina Zwirner

License

This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml

Rendered

Mon, 15 Sep 2025 17:13:36 +0000

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org.

Introduction

If you find any errors or have feature requests please contact us on github.

Screenshots

Configuration screen

This are the extension configuration screens that are reachable from the TYPO3 backend.

For this navigate to Settings ➞ Extension Configuration ➞ typo3_docchecklogin

Basic

Economy

Business

Crawling

Plugin configuration

The settings within the plugin flexform

Frontend view

Language will vary.

Installation

https://yourwebsite.com/login

https://yourwebsite.com/login?logintype=login&dc=dcloginparam

Configuration

Extension configuration

For the plugin to work properly you need to set up the extension configuration accordingly to your login licence and your needs.

To understand better which settings are usable by your licence the settings are grouped by so. To know what the different licences are standing for please follow this page.

For the basic functionality, the free DocCheck Basic Licence should suffice.

If you don't have a licence yet and you are interested in buying one, please contact industry@doccheck.com. They will also provide you with test licenses if needed.

Each group in the extension configuration is based on the group before. The exception is the Crawling-Feature that can be used even when you dont have a licence.

To access the extension configuration navigate in the TYPO3 backend to Settings ➞ Extension Configuration ➞ typo3_DocChecklogin.

ExtTables

The plugin adds four new database fields to the fe_users table.

TsConfig

This site covers options to configure the plugin. All written options can be overwritten with constants.

Test login user

To get a test user for the DocCheck Login you can visit the DocCheck CReaM website.

1. Login to CReaM

   First login to CReaM, where you manage your DocCheck Login.

2. Navigate to test password

   In the navigation navigate to Password protection ➞ Test passwords.

   

3. Click the button

   Click on the top right button Create new test password.

   

4. Select the project

   Select the target projects and save the selection.

5. Set user information

   Give the user an username, password, profession etc. and save it.

   Done!

Hooks

Following hooks can be used to extend functionalities of the DocCheck Login plugin.

$GLOBALS['TYPO3_CONF_VARS']['EXT']['typo3_docchecklogin']['beforeRedirect'][] =
\Vendor\Package\Hook\MyHook::class . '->beforeRedirect';

Best practices

Inline login

If you want to use the login template directly inside a fluid template, for example to use it in a popup, you can do so by creating a lib element.

Got to your typoscript configuration and add & edit the following code.

lib.login = USER
lib.login{
    userFunc = TYPO3\CMS\Extbase\Core\Bootstrap->run
    vendorName = Antwerpes
    extensionName = Typo3Docchecklogin
    pluginName = DocCheckAuthentication
    controller = DocCheckAuthentication
    features.requireCHashArgumentForActionArguments = 0
    view =< plugin.tx_typo3docchecklogin.view
    settings =< plugin.tx_typo3docchecklogin.settings
    settings.loginId = <yourLoginId>
    settings.loginLayout = xl
    settings.customLayout =
    settings.language = de
    settings.redirect = 1
}

Afterwards you can use the code in the fluid template like the following:

<f:cObject typoscriptObjectPath="lib.login"/>

403 error handling

When you have a restriced page and the user is clicking on it the user will normaly comes to a 403 page that you can define in the TYPO3 backend under Site Management ➞ Error Handling.

If you want that the user get redirected to the login page and after login gets back to the requested page you can use this error handler.

1. Create the file ErrorLoginHandler in you extension Classes folder

   The class can look like the following:

   <?php
   
   namespace Vendor\MyExtension;
   
   use Psr\Http\Message\ResponseInterface;
   use Psr\Http\Message\ServerRequestInterface;
   use TYPO3\CMS\Core\Context\Context;
   use TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerInterface;
   use TYPO3\CMS\Core\Http\RedirectResponse;
   use TYPO3\CMS\Core\Utility\GeneralUtility;
   use TYPO3\CMS\Extbase\Utility\DebuggerUtility;
   
   class ErrorLoginHandler implements PageErrorHandlerInterface
   {
       public function handlePageError(
           ServerRequestInterface $request,
           string $message,
           array $reasons = []
       ): ResponseInterface {
           return new RedirectResponse('/login?redirect_url='.$request->getUri()->getPath(), 403);
       }
   }

   Copied!

   Note

   The class expects that you have a /login page where the DocCheck Login plugin is included. Incase you have the DocCheck Login included in another page, just change the url accordingly.

2. Navigate in the TYPO3 backend to

   Sites ➞ Your Site Configuration ➞ Error Handling ➞ + Create new

3. The configurate should look like the following

   

4. Save and enjoy

   Now the user should get redirected back to the requested url that he tried to access while he was not logged in.

Sitemap

Index