settings – Alexander Dick

Damit die Plugin Settings einer Extbase Extension auch im CommandController (Backend / CLI Kontext) verfügbar sind, muss auf folgendes geachtet werden:

1. die plugin Settings in module kopieren:

module.tx_foo < plugin.tx_foo

1	module.tx_foo < plugin.tx_foo

2. In der ext_localconf.php die constants.txt und setup.txt mittels ExtensionManagementUtility::addTypoScript includen:

if(TYPO3_MODE === 'BE') {

    // Constants
    \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScript($_EXTKEY,'constants',' <INCLUDE_TYPOSCRIPT: source="FILE:EXT:'. $_EXTKEY .'/Configuration/TypoScript/constants.txt">');

    // Setup     
    \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScript($_EXTKEY,'setup',' <INCLUDE_TYPOSCRIPT: source="FILE:EXT:'. $_EXTKEY .'/Configuration/TypoScript/setup.txt">');

    // CommandController registrieren
    $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['extbase']['commandControllers'][] = 'Vendor\Foo\Command\FooCommandController';

}

if(TYPO3_MODE === 'BE') {

// Constants

\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScript($_EXTKEY,'constants',' <INCLUDE_TYPOSCRIPT: source="FILE:EXT:'. $_EXTKEY .'/Configuration/TypoScript/constants.txt">');

// Setup

\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScript($_EXTKEY,'setup',' <INCLUDE_TYPOSCRIPT: source="FILE:EXT:'. $_EXTKEY .'/Configuration/TypoScript/setup.txt">');

// CommandController registrieren

$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['extbase']['commandControllers'][] = 'Vendor\Foo\Command\FooCommandController';

}

damit wird sichergestellt, dass das Setup unter allen Umständen geladen wird. In der Regel bindet man das Extension Setup ja in einem Frontend TS Template ein; somit wird es im Backend / CLI Kontext nicht geladen (zumindest dann nicht, wenn man es nicht im Root Template eingebunden hat sondern z.B. in einem Extension Template auf einer Unterseite).

3) im Controller die Settings über den ConfigurationManager reinholen:

<?php
namespace Vendor\Foo\Command;

class FooCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandController {

    /**
     * @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
     * @inject
     */
    protected $configurationManager;


    /**
     * @var array
     */
    protected $settings = array();


    /**
     * Settings aus dem CibfigurationManager ziehen und zuweisen
     */
    public function initialize() {

        $settings = $this->configurationManager->getConfiguration(
            \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS
        );

        $this->settings = $settings;

    }
    
    /**
     * die eigentliche Command Methode -> initialize() aufrufen
     */ 
    public function fooCommand() {
        $this->initialize();
        
        // $foo = $this->settings['bar']; 
        // Command Logik ...
    }
}

<?php

namespace Vendor\Foo\Command;

class FooCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandController {

/**

* @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface

* @inject

protected $configurationManager;

/**

* @var array

protected $settings = array();

/**

* Settings aus dem CibfigurationManager ziehen und zuweisen

public function initialize() {

$settings = $this->configurationManager->getConfiguration(

\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS

);

$this->settings = $settings;

}

/**

* die eigentliche Command Methode -> initialize() aufrufen

public function fooCommand() {

$this->initialize();

// $foo = $this->settings['bar'];

// Command Logik ...

}

Wenn man mit Extbase ein Backend Modul erstellt, sind im Controller die Settings auf die man in einem Frontend Controller mit $this->settings direkt zugreifen kann, nicht verfügbar.

Damit das auch in einem Backend Modul funktioniert, sind 2 Sachen notwendig.

1) Die Zuweisung der Settings im Typoscript Template:

plugin.tx_foo {
    settings {
        foo = bar
    }
}

module.tx_foo.settings < plugin.tx_foo.settings

plugin.tx_foo {

settings {

foo = bar

}

module.tx_foo.settings < plugin.tx_foo.settings

2) im Controller die Settings über den Tx_Extbase_Configuration_BackendConfigurationManager holen, beispielsweise in der initializeAction:

    /**
     * @return void
     */
	public function initializeAction() {

		if(TYPO3_MODE === 'BE') {

			$configurationManager = t3lib_div::makeInstance('Tx_Extbase_Configuration_BackendConfigurationManager');
			$this->settings = $configurationManager->getConfiguration(
				$this->request->getControllerExtensionName(),
				$this->request->getPluginName()
			);			

		}

	}

/**

* @return void

public function initializeAction() {

if(TYPO3_MODE === 'BE') {

$configurationManager = t3lib_div::makeInstance('Tx_Extbase_Configuration_BackendConfigurationManager');

$this->settings = $configurationManager->getConfiguration(

$this->request->getControllerExtensionName(),

$this->request->getPluginName()

);

}

Damit man sich die Abfrage ob man sich im Backend befindet sparen kann (TYPO3_MODE === ‚BE‘), empfehle ich für das Backend Modul einen eigenen Controller zu machen der dann auch nur dort verwendet wird.

Schlagwort: settings

Plugin Settings in Extbase CommandController

Extbase Plugin Settings in Backend Modul auslesen