Bearbeiten von „Typo3 - Extensions programmieren“

Links:

http://typo3.org/documentation/api/
== Templates ==
[[Typo3 Extension Developer Templates]]
== Extensions programmieren - wie fange ich an ? ==
Was möchtest du tun?
'''Ein vorhandenes Inhaltselement verändern, z.B. Felder hinzufügen oder ein neues Erstellen.'''

[[Typo3 Extensions - Inhaltstypen anlegen und bearbeiten]]

Ein Beispiel dafür ist die Extension metatags die den Inhaltselementen Text mit Bild und Bild zusätzliche Felder für Alt und Title Tag hinzufügt.

== Extensions Programmieren in der Praxis ==
[[Typo3 Extensions - ein Frontend Plugin Programmieren]]

[[Typo3 Extensions mit IRRE]]

Das IRRE Konzept hilft beim erstellen von Extensions mit "echten" relationalen Datenbankabfragen

[[Typo3 Extensions mit FlexForms]]


[[Typo3 Extensions - Backend Formulare und TCA Konfiguration]]

== Wichtige Variablen ==
 $_EXTKEY 
bzw. im Array...
Enthält den Extension Key.  Immer die Variable benutzen, dann kann man den Code leichte wieder verwenden.
 $TYPO3_CONF_VARS


== Wie arbeitet eine Extension ==
'''Laden:''' Extension Manager (EM) ruft ''ext_emconf.php'' (enthält nur das Array: $EM_CONF[$_EXTKEY]) bei allen Extensions auf die in der localconf.php aufgeführt sind.

'''Aufruf von Backend oder Frontend:''' ''ext_localconf.php'' wird ausgeführt (oder eine gecachete Kopie) In dieser wird die /typo3conf/localconf.php erweitert.
Funktion: weitere Klassen includieren (require_once())

=== Formulare im Backend ===
Das '''$TCA''' (Table Configuration Array) bestimmt welche Formularfelder verwendet werden.
Das Array ist in ext_tables.php(Bereiche: ctrl und feinterface s.u.) und tca.php gespeichert

* Jeder Eintrag im $TCA ist an eine Datenbanktabelle geknüpft
* Der erste Index ist der Tabellenname.
* Im zweiten Index gibt es 6 Bereiche: 
<pre>
 ctrl -> Informationen zur Tabelle
 interface -> Konfiguration für die Auflistung und Darstellung im Backend
 feInterface -> Eigenschaften für das Frontend Editing
 columns -> Informationen zu den Feldtypen der Tabelle und der Verarbeitung der Daten (zweiter Index ist hier der Spaltenname)
 types -> legt fest welche der in columns definierten Spalten dargestellt werden und in welcher Reihenfolge, 
          außerdem Zusatzinfo wie alternative Feldbezeichnung, Palettennummer, style codes...
 palettes -> Zum Zusammenfassen von mehreren Eingabefeldern, Zusammenstellungen wiederverwenden, Hilfsfelder definieren
</pre>

=== Daten bearbeiten mit TCE und TCEforms ===
Die im $TCA definierten Daten müssen in irgend einer Form bearbeitet werden. Ein umfangreiches Modul dazu befindet sich  in der Extension CMS (typo3/sysext/cms/layout/db_layout.php. DDas Modul greift auf die '''Typo3 Core Engine (TCE)''' zurück, die zum Verarbeiten und Speichern von Daten dient. Die '''Formulare werden mit der Klasse TCEforms''' erzeugt. Bearbeitet wird hierbei im Backend.

Immer dann, wenn man die '''im $TCA eingetragenen Tabellen über Eingabemasken manipulieren''' will ist des sinnvoll die TCE zu nutzen.

 t3lib_TCEmain -> t3lib/class.t3lib_tce-main.php
 t3lib_TCEforms -> TCEforms

==== Einsatz in Extensions ====
Instanz von t3lib_TCEmain erzeugen:
 require_once(PATH_t3lib."class.t3lib_tcemain.php");
 $tce=t3lib_div::makeInstance('t3lib_TCEmain');
Arrays für Daten und Kommandos erzeugen:
 $data[tabelle][uid][feld] = wert
um neue Daten zu schreiben bevor man eine uid hat belegt man uid mit NEW und einem Zufallsstring z.B. NEWo1amh
 $cmd[tabelle][uid][befehl] = wert
dabei stehen verschiedene Befehle zur Verfügung:
 copy, move, delete, localize, version, new
Die beiden Arrays werden dann mittels 
 $tce->start($data,$cmd) 
an die TCE übergeben und von 
$tce->process_cmdmap() 
abgearbeitet.

== Wie kann ich eine eigene Extension debuggen? ==
=== Hilfreiche Extensions zur Entwicklung von Extensions ===
'''devlog''' -> schreibt log Einträge in eine Datenbanktabelle. Dazu ruft man an in seiner Extension die Funktion TODO auf und übergibt die Werte die man loggen will.

''' Extension Development Evaluator  (extdeveval) ''' -> Referenzen aufrufen, Autmatisch Funktionsinfos schreiben u.v.m.
	
=== permalink ===
Wenn man eine eigene Extension schreibt benutzt man zum größten Teil Array, und um den Überblick zu behalten was nach den ganzen schritten in einem Array noch so drin steht hat man die möglichkeit mit einer Funktion das Array schön und sauber in einer tabelle anzeigen zu lassen.

Beispiel:

PHP-Code:
<pre>
$data = array("Name" => "Peter KeineAhnung", "Alter" => 22, "Wohnort" => "Ratingen");
t3lib_div::debug($data);
</pre>

Ergebnis:

je nach devIPMask Einstellungen ist auch nur

PHP-Code:

 debug();

nützlich, vor allem wenn ein Kundenprojekt Online ist einfach im Installtool und devIpMask deine IP eingeben und dann mit debug(); arbeiten, so kannst nur du den debug sehen und nicht irgendwelche User die grade auf der Site sind.

Kleiner Zusatz Tip:

Ihr lasst euch gleichzeitig mehrere Debugs ausgeben und verliert den überblick welcher debug welcher ist... Beispiel Ihr lasst euch ein Array vor einer funktion debugen und anschliessend...

da habt ihr dann die möglichkeit euerem Debug einen Namen zu geben..

Beispiel:
PHP-Code:
 $data = array("Name" => "Peter KeineAhnung", "Alter" => 22);
 t3lib_div::debug(,'Array vorher');
        
 $data['Name'] = 'T.uX';
 $data['Alter'] = 32;

 t3lib_div::debug(,'Array nachher');

Auch bei der Verwendung der integrierten DB-Abstraktionsschicht können eine Reihe von Fehlern auftreten, die teilweise nur sehr magere Fehlermeldungen produzieren. Um eine etwas explizitere Fehlerausgabe zu erzwingen sollte man folgende Zeile in seine Extension integrieren*:

PHP-Code:
 $GLOBALS['TYPO3_DB']->debugOutput = true;
So wird z.B. das SQL-Stement Ausgegeben, das zu einem Fehler geführt hat.

== Datenbankabfrage in Extensions ==
[[TYPO3 - Datenbankabfragen in Extensions]]

== Struktur einer Extension ==
'''ext_emconf.php'''

Informationen und Metadaten zur Extension. Etwa die Infos die im Kickstarter unter General Info stehen.

* Root-Verzeichnis
**'''ext_localconf.php''' Enthält '''Konfigurationsdaten''' ($TYPO3_CONF_VARS) für das Backend und Frontend. Hier kann über die Extension API auch '''TypoScript''' eingebunden werden.
**'''ext_tables.php''' Konfiguration von '''Datenbanktabellen'''. Plugins und Module über die Extension API einbinden. (Alles über Kickstarter)
**'''ext_tables.sql''' '''SQL-Daten''' für die Tabellendefinition. Die Auswertung erfolgt über den Extension Manager und das Install-Tool.
**'''ext_tables_static+adt.sql''' '''SQL-Tabellendefinition''' inkl. Daten. Z.B. für statische Daten (Länderinfos etc.)Die Tabellen müssen zusätzlich in ext_tables.sql definiert sein.
**'''ext_typoscript_*.txt''' '''Globaler TypoScript-Code'''. Steht nicht üver Template-Datensätze zur Auswahl (siehe /static)
**'''ext_conf_template.txt''' Hier werden '''Optionen zur Konfiguration''' angelegt, die der Benutzer im Extensionmanager einstellen kann.
**'''*icon*.gif''' '''Symbol-Dateien''' für Extension,DB-Tabellen,Plugins, Module...
**'''locallang*.php''' Texte für die '''Lokalisierung''' in verschiedenen Sprachen
**'''class.ext_update.php''' Funktionen für ein '''Update der Extension''' (Beispiel siehe newloginbox).

*'''pi1/''' Verzeichnis für '''Skripte und Daten''' des Plugin
**'''class*.php''' '''PHP-Klassen''' z.B. für Plugins oder Submodule

*'''cm1/''' Verzeichnis für Dateien die das '''Kontext-Menü''' betreffen

*'''mod1/''' Verzeichnis für ein Modul.
**'''conf.php''' Konfigurationsdatei für ein '''Modul''' zum einbinden ins Backend.
**'''index.php''' '''Hauptscript eines Moduls'''.

*'''modfunc1/''' Skripte und Daten für '''Submodul-Funktionen'''

*'''static/''' '''TypoScript-Template'''-Dateien. Diese werden über die Extension-API eingebunden und stehen dann in Template-Datensätzen, ähnlich den Standard Templates zur Auswahl.

*'''sv1/''' Verzeichnis für '''Services'''

*'''res/''' Verzeichnis für beliebige 'recourcen'.

*'''doc/''' Verzeichnis der '''Dokumentation'''.

== Wo werden Extensions installiert ? ==
===typo3/sysext/ (System)===
System Extensions wie cms und lang. Hier können keine Extensions mit dem Extension Manager installiert werden.
===typo3/ext/ - globale Extensions (Global) ===
Z.B. diese die von Typo3 mitgeliefert werden. Mit der Option allowGlobalInstall kann man die Installation in dieses Verzeichnis erlauben. Das ist dann nicht sinnvoll wenn sich mehrere Typo3 WEbsites eine Installation teilen, weil es hier zu Versionskonflikten kommen kann.
===typo3conf/ext - lokale Extensions (Local)===
Hier werden normalerweise alle Extensions installiert. Die Lokale Installation hat immer Vorang vor einer globalen.

== Typolinks richtig in Extensions einsetzen ==

In diesem kurzem Tutorial möchte ich zeigen, wie man Typolinks in eigenen Erweiterungen erstellt, die das
Feature 'Simulate Static Documents' unterstützen und eine Ausgabe erstellen, die von Typo3 gecached wird
und so auch mit der Indexed search verwendet werden können. Diese Informationen wurden aus anderen
Erweiterungen zusammengetragen, speziell aus der Erweiterung tt_board.
Typoscript
Zuerst erstelle in der Datei 'ext_typoscript_setup.txt' eine Eigenschaft, die deiner Erweiterung mitteilt, ob
caching genutzt werden soll oder nicht:


<pre>
plugin.tx_myextension_pi1 {
allowCaching = 1
}
</pre>

Wenn das später auf 0 gesetzt wird, werden diese Seiten nicht mehr gecached.

'''Vorbereitung'''

Bereite in der main() Funktion den Typolink vor und konfiguriere das caching:

<pre>
class tx_myextension_pi1 extends tslib_pibase {
...
var $allowCaching = "";
function main($content,$conf) {
$this->conf=$conf;
...
// Preconfigure the typolink
$this->local_cObj = t3lib_div::makeInstance("tslib_cObj");
$this->local_cObj->setCurrentVal($GLOBALS["TSFE"]->id);
$this->typolink_conf = $this->conf["typolink."];
$this->typolink_conf["parameter."]["current"] = 1;
$this->typolink_conf["additionalParams"] =
$this->cObj->stdWrap($this->typolink_conf["additionalParams"],
$this->typolink_conf["additionalParams."]);
unset($this->typolink_conf["additionalParams."]);
// Configure caching
$this->allowCaching = $this->conf["allowCaching"]?1:0;
if (!$this->allowCaching) {
$GLOBALS["TSFE"]->set_no_cache();
}
...
}
}
Links erstellen
Um nun Links in der Erweiterung zu erstellen, benutze das folgende Code Fragment:
$temp_conf = $this->typolink_conf;
$temp_conf["additionalParams"] .= "&tx_myextension_pi1[key]=value";
$temp_conf["useCacheHash"] = $this->allowCaching;
$temp_conf["no_cache"] = !$this->allowCaching;
$the_link = $this->local_cObj->typolink("Linktext", $temp_conf);
</pre>

Danach kann man '$the_link' zu der Ausgabe hinzufügen. Das '$temp_conf' Array kann man mit allen
Eigenschaften des typolink Objektes erweitern.

Tutorial by typo3.hachmeister.org
Von:fruit-lab.de


== Datei Uploads in Backend Extensions ==
Feld im Kickstarter anlegen. in der tca.php kannst du den uploadfolder festlegen.

Komplizierter wirds in folgendem Fall (aus typo3.net 12-2007)

 stimmt schon, dass man da den ordner ändern kann, aber was wenn ich nicht alle dateien in einen ordner speichern will?
ich brauche 2 ordner. einen für normale downloads und in den anderen würden die dateien reinkommen, die kostenpflichtig downzuloaden sind. diesen ordner muss ich also per htaccess schützen. darum wärs nötig, dass der upload-ordner für den späteren redakteur frei wählbar, oder zumindest 2 ordner auswählbar sind.

irgendwelche ideen?


alles kein Problem.

Man kann in der ext_emconf.php unter createDirs die benötigten Verzeichnisse angeben.
Für Fileupload gibts auch einige Typofunktionen die man nutzen kann, so helfen einem folgende Klassen weiter:
t3lib_basicFileFunctions
t3lib_extFileFunctions

== Debug Methode ==
Typo3 | Debug Methode :: Hilfe bei der Programmierung

Wenn man eine eigene Extension schreibt benutzt man zum größten Teil Array, und um den Überblick zu
behalten was nach den ganzen schritten in einem Array noch so drin steht hat man die möglichkeit mit einer Funktion das Array schön und sauber in einer tabelle anzeigen zu lassen.

'''Beispiel:'''
<pre>
$data = array("Name" => "Peter KeineAhnung", "Alter" => 22, "Wohnort" => "Ratingen");
echo t3lib_div::debug($data);
</pre>

Ergebnis:

[[Bild:TS_debug01.gif]]

je nach devIPMask Einstellungen ist auch nur
 debug($sonstwas);
nützlich, vor allem wenn ein Kundenprojekt Online isteinfach im Installtool und devIpMask deine IP eingeben und dann mit debug($sonstwas); arbeiten, so kannst nur du den debug sehen und nicht irgendwelche User die grade auf der Site sind.

Kleiner Zusatz Tip:

Ihr lasst euch gleichzeitig mehrere Debugs ausgeben und verliert den überblick welcher debug welcher ist...

'''Beispiel''' 

Ihr lasst euch ein Array vor einer funktion debugen und anschliessend...
da habt ihr dann die möglichkeit euerem Debug einen Namen zu geben..

'''Beispiel:'''
<pre>
$data = array("Name" => "Peter KeineAhnung", "Alter" => 22, "Wohnort" => "Ratingen");
echo t3lib_div::debug($data,'Array vorher');
$data['Name'] = 'T.uX';
$data['Alter'] = 32;
echo t3lib_div::debug($data,'Array nachher');
</pre>

Ergebnis:

[[Bild:TS_debug02.gif]]

Hinweis:
läst du dir eine Variable im debug ausgeben erscheint [b]|debug|[/b]. das funzt nur mit Arrays ;-)
Auch bei der Verwendung der integrierten DB-Abstrktionsschicht können eine Reihe von Fehlern auftreten,
die teilweise nur sehr magere Fehlermeldungen produzieren. Um eine etwas explizitere Fehlerausgabe zu
erzwingen sollte man folgende Zeile in seine Extension integrieren*:
$GLOBALS['TYPO3_DB']->debugOutput = true;

So wird z.B. das SQL-Stement Ausgegeben, das zu einem Fehler geführt hat.
Tutorial by typo3.kj187.de

== PHP-Skripte einbinden ==




=== mit PHP_SCRIPT ===

Im Typo Script:
<pre>
##############################
### temporäres Test Script ###
##############################

temp.phpScript = PHP_SCRIPT
temp.phpScript {
   file = demo/test.inc.php
   myVerySpecialOwnParameter = Hallo Welt
   myParamArray {
      a = 2
      b = 5
   }
}
</pre>
Im Skript text.inc.php
<pre>
<?php
// Use the debug-function to view the config
// array $conf given by TypoScript:
debug( $conf );

$contentArr[] = "Test";
$contentArr[] = $conf['file'];
$contentArr[] = $conf['myVerySpecialOwnParameter'];
$contentArr[] = implode( $conf['myParamArray.'], ', ' );

// Put all your output to $content,
// that TYPO3 will display for you:
$content = implode( $contentArr, '< br />' );
?>
</pre>

=== mit PHP_SCRIPT_EXT ===
Typo3 | Externe PHP Scripte einbinden

Haben Sie ihr Projekt auf Typo3 umgestellt und wollen dennoch ihre eigenen PHP-Scripte verwenden? Dann machen Sie folgendes.

Schreiben Sie in das SETUP Feld des Templates:

<pre>
tt_content.script = CASE
tt_content.script {
key.field = select_key
test = PHP_SCRIPT_EXT
test.file = fileadmin/dein_script.php
}
</pre>

Um das Script jetzt als Contentelement in die Seite einzubinden, legen Sie einen neuen Seiteninhalt an. Wechseln Sie von Typ = Text auf Typ = Skript. In das CODE Feld müssen Sie jetzt nur noch test eintragen und sie sind fertig. 

Dies ist die einfachste Methode. Die Ausgabe des Scripts wird aber nicht in den Cache aufgenommen! Diese Funktion wird leider nicht unterstützt.

Tutorial by typo3.kj187.de

Anmerkung Steff: Für die Cache Funktion kann man z.B. eine Einfache Extension basteln.

== Beispiele ==
===Einträge aus Bildausrichtungen im Backend entfernen===
aus cron_cssstyledimgtext
<pre>
<?php
if (!defined ('TYPO3_MODE'))     die ('Access denied.');

t3lib_extMgm::addPItoST43($_EXTKEY,'pi1/class.tx_croncssstyledimgtext_pi1.php','_pi1','',1);

$_EXTCONF = unserialize($_EXTCONF);
if ($_EXTCONF['addPageTS'])	{
	t3lib_extMgm::addPageTSConfig('
TCEFORM.tt_content.imageorient.types.image.removeItems = 8,9,10,17,18,25,26
');
}

$TYPO3_CONF_VARS['FE']['XCLASS']['tslib/class.tslib_content.php']=t3lib_extMgm::extPath($_EXTKEY).'class.ux_tslib_content.php';
?>

</pre>


=== Bilder in eigener Extension rendern ===


In diesem Beispiel benutzte Variablen:
 $BildAdresse
 $ParameterFuerImgTag
 $Alttext

In PHP-Datei der Extension:

 $this->conf["imageBeispiel."]["file"]="uploads/pics/".$BildAdresse;
 $this->conf["imageBeispiel."]["params"]=$ParameterFuerImgTag;
 $this->conf["imageBeispiel."]["altText"]=$Alttext;
 $Bild=$this->cObj->IMAGE($this->conf["imageBeispiel."]);
 $Content.=$Bild;

In Typoscript Setup

 plugin.tx_hoTest_pi1 {     //hier Plugin-Name
 imageArtikel{
     file.maxW = {$ho_Test.BildWidthNews}  
     imageLinkWrap = 1
     imageLinkWrap {
       enable = 1
       bodyTag = <BODY bgColor=white>
       wrap = |
       width = 400m
       height = 400
       JSwindow = 1
       JSwindow.newWindow = 1
       JSwindow.expand = 17,20
     }
   }
 }

Der Wert {$ho_Test.BildWidthNews} kann aus Constants übernommen werden.

Siehe dazu auch
Konstanten von Constants im Setup verwenden
und
Konstanten für Constant-Editor bereitstellen

(aus www.easy-office4you.de/ 10.1.2006)



=== Spalten der Seiten umbenennen ===

Um die Spalten der Seite im Backend beliebig umzubenennen und/oder zusätzliche eigene Spalten zu verwenden, muß die Extension zed_more_columns installiert werden und dann in der Datei ext_tables.php die Spalten-Namen eingeben werden.

Beispiel:

 $TCA["tt_content"]["columns"]["colPos"]["config"]["items"] = array (
 "0" => array ("Mitte||Mitte||||||||","0"),
 "1" => array ("Links||Links||||||||","1"),
 "2" => array ("Rechts||Rechts||||||||","2"),
 "3" => array ("Teaser||Teaser||||||||","3"),
 "4" => array ("Fusszeile||Fusszeile||||||||","4")
 );

== Bei Extension dafür sorgen, daß im Backend kein Sortierungs-Button entsteht ==


In der Datei ext_tables.php der Extension folgende Zeile ändern

 "sortby" => "name",

ändern in

 "default_sortby" => "ORDER BY name",

Anstatt "name" kann natürlich auch ein anderes Suchkriterium verwendet werden.