22. März 2009

Extension Programmierung: Flexform- und Typoscriptwerte zusammenführen

in Dev, Extension, Tutorial, TypoScript

Eine Möglichkeit Werte und Konstanten in Extensions zu definieren, besteht darin diese direkt in den Flexform zu speichern. Aber um die Übersicht bei einer Vielzahl von Werten zu behalten oder um etwas mehr Dynamik ins Spiel zu bringen, bietet sich Typoscript an.
Im Idealfall gibt es einen guten Mix aus beiden Varianten in einer guten Extension:

  • „Typoscriptscheuer“ Anfänger will nur ein paar Einstellungen in den Flexform machen und die Extension soll laufen – kein Problem
  • Ein anderer Administrator möchte die Extension (z.B. an einem Marker ausgeben und daher) direkt über Typoscript einstellen – kein Problem

Variante 1 – $conf erweitern:
Ich gehe meist den Weg die Flexform Werte direkt im Array $this->conf zu speichern und vorhandene Werte zu überschreiben (schließlich überwiegt die Einstellungen in den Flexform bei den meisten Extensions).
Eine Funktion, die einmal zu Beginn ausgeführt wird um $this->conf zu erweitern, kann z.B. so aussehen:

// enables flexform values in $conf
function config() {
    if (is_array($this->cObj->data['pi_flexform']['data'])) { // if there are flexform values
        foreach ($this->cObj->data['pi_flexform']['data'] as $key => $value) { // every flexform category
            if (count($this->cObj->data['pi_flexform']['data'][$key]['lDEF']) > 0) { // if there are flexform values
                foreach ($this->cObj->data['pi_flexform']['data'][$key]['lDEF'] as $key2 => $value2) { // every flexform option
                    if ($this->pi_getFFvalue($this->cObj->data['pi_flexform'], $key2, $key)) { // if value exists in flexform
                        $this->conf[$key.'.'][$key2] = $this->pi_getFFvalue($this->cObj->data['pi_flexform'], $key2, $key); // overwrite $this->conf
                    }
                }
            }
        }
    }
}

Der Vorteil liegt auf der Hand: Alleine die Verwendung von $this->conf (z.B. $this->conf[’singlePid‘]) genügt um an die jeweiligen Konstanten zu kommen.

Variante 2 – Funktion die mir den passenden Wert liefert:
Dmitry Dulepov beschreibt in seinem Buch TYPO3 Extension Development eine andere Variante. Beim Aufruf einer kurzen Funktion wird der passende Wert zurückgeliefert – die Funktion kann so aussehen:

function fetchConfigurationValue {
	$value = trim($this->pi_getFFvalue($this->cObj->data['pi_flexform'], $param));
    return $value ? $value : $this->conf[$param];
}

Hier kommt man an den Konfigurationswert indem man diese Funktion jedes Mal aufruft, wenn diese benötigt wird:
$this->fetchConfigurationValue(’singlePid‘)

4 Reaktionen zu “Extension Programmierung: Flexform- und Typoscriptwerte zusammenführen”

Kommentare abonnieren (RSS) oder TrackBack URL

Hallo,

guter Tipp, aber in die Funktion „fetchConfigurationValue“ ist fehlerhaft: Du mußt ja noch das Sheet angeben, in dem der Wert steht (standard ist „sDEF“).

function fetchConfigurationValue($fieldName, $sheet) {
$value = trim($this->pi_getFFvalue($this->cObj->data[‚pi_flexform‘], $fieldName, $sheet));
return $value ? $value : $this->conf[$fieldName];
}

Auf welcher Seite steht diese Funktion im Buch? Konnte sie nicht finden.

Sven Burkert am 25. März 2009 um 12:06

Seite 126 „Loading configuration“ gleich links oben

Alex Kellner am 27. März 2009 um 09:52

So könnte die erste Funktion in einer anderen Klasse liegen:

public function flex2conf(&$pObj) {
	if (is_array($pObj->cObj->data['pi_flexform']['data'])) { // if there are flexform values
		foreach ($pObj->cObj->data['pi_flexform']['data'] as $key => $value) { // every flexform category
			if (count($pObj->cObj->data['pi_flexform']['data'][$key]['lDEF']) > 0) { // if there are flexform values
				foreach ($pObj->cObj->data['pi_flexform']['data'][$key]['lDEF'] as $key2 => $value2) { // every flexform option
					if ($pObj->pi_getFFvalue($pObj->cObj->data['pi_flexform'], $key2, $key)) { // if value exists in flexform
						$pObj->conf[$key.'.'][$key2] = $pObj->pi_getFFvalue($pObj->cObj->data['pi_flexform'], $key2, $key); // overwrite $conf
					}
				}
			}
		}
	}
}

Aufruf in der Hauptklasse der Extension:

$this->conf = $conf;
$this->div->flex2conf($this);
Alex am 21. April 2009 um 16:57

Ist es richtig, dass im ersten Fall die setup oder config-Werte immer nach folgendem Schema aufgebaut sein müssen?

tx_extkey_piN.sheet.field = xxxxx

Folgendes würde nicht treffen?
tx_extkey_piN.field = xxxxx

Ich fange gerade erst mit der Entwicklung an also bitte ich höflichst um etwas Nachsicht. 😉

Danke
Mario

Mario Kröll am 28. September 2010 um 12:15

Kategorien

Archiv