Dependency Container - Versionsgeschichte

Tril: /* Services */

2013-05-16T19:42:26Z

‎Services

Tril: /* Parameter */

2013-05-16T19:41:56Z

‎Parameter

Tril: /* How to use */

2013-05-16T19:41:26Z

‎How to use

Tril am 16. Mai 2013 um 19:36 Uhr

2013-05-16T19:36:49Z

Tril: Die Seite wurde neu angelegt: „{{ExtInfo | Dev=Benutzer:tril | DevSite=http://bit3.de | Version=ab 2.11 | ERLink=https://github.com/bit3/contao-dependency-container | TrackerLink=http://dev…“

2013-05-16T12:42:29Z

Die Seite wurde neu angelegt: „{{ExtInfo | Dev=Benutzer:tril | DevSite=http://bit3.de | Version=ab 2.11 | ERLink=https://github.com/bit3/contao-dependency-container | TrackerLink=http://dev…“

Neue Seite

{{ExtInfo
| Dev=[[Benutzer:tril]]
| DevSite=http://bit3.de
| Version=ab 2.11
| ERLink=https://github.com/bit3/contao-dependency-container
| TrackerLink=http://dev.contao-forge.org/projects/avisota/issues
}}
[[Kategorie:Extensions]]

=Dependency Container für Contao=

Ein Dependency Container ist Teil des [http://de.wikipedia.org/wiki/Dependency_Injection Dependency Injection] Konzepts.
Deshalb bezeichnet man ihn auch als Dependency Injection Container oder kurz DI Container.
Die Erweiterung heißt deshalb nur "Dependency Container", weil diese lediglich einen Container für Abhängigkeiten gemäß dem DI Konzept bereit stellt.
DI umfasst neben Komponenten (wie den Container) auch Programmierparadigmen und API Definitionen und muss daher von jedem Entwickler selbst "angewendet" werden.

==Was macht der Container?==

Der Container ist ein zentraler Speicherort für Parameter und Dienste.
Parameter und Dienste haben einen Namen, damit ist der Container prinzipiell nichts anderes als ein <code>Key → Value</code> Storage.

===Parameter===

Parameter sind vergleichbar mit Konfigurationseinstellungen.
Innerhalb von Contao machen diese prinzipiell kaum Sinn, da es dort das <code>$GLOBALS['TL_CONFIG']</code> Array gibt.
Mit Ihnen lassen sich aber Dienste gut konfigurieren.

===Dienste (Services)===

Dienste sind Objekte die bestimmte Funktionen zur Verfügung stellen und vom Container bei Anforderung instanziiert und zur Verfügung gestellt werden.
Ob ein Dienst bei jedem Aufruf neu erzeugt wird oder aber als Singleton innerhalb des Containers verbleibt entscheidet der Container.

==Wieso ein DI Container?==

In Contao werden für Dienste häufig Singleton Klassen eingesetzt.
Singleton Klassen lassen sich allerdings nur schwer modifizieren oder rekonfigurieren.

==Technische Umsetzung==

Der Dependency Container verwendet die [http://symfony.com/doc/2.1/components/dependency_injection/index.html Dependency Injection Component] von Symfony2.

==Zugriff auf den Container==

Der Container steht als globales Objekt zur Verfügung:
<source lang="php">
$GLOBALS['container']->get('foo.bar');
</source>
oder
<source lang="php">
global $container;
$container->get('foo.bar');
</source>

=Parameter und Dienste konfigurieren=

Ein Dienst wird mit <code>register</code> registriert:
<source lang="php">
$container->register('myServiceName', 'MyClassName')
->addArgument('myConstructorArgument')
->addMethodCall('myMethodName', array('myMethodArgument'));
</source>
Das Beispiel registriert einen Dienst '''myServiceName''', mit der Klasse '''MyClassName'''.
Außerdem wird ein Argument mit dem Wert <code>'myConstructorArgument'</code> hinzugefügt, das beim Instanziieren an den Konstruktor übergeben wird.
Anschließend wird noch die Methode '''myMethodName''' aufgerufen, mit dem Parameter <code>'myMethodArgument'</code>.

Umgesetzt im PHP Code entspricht dies:
<source lang="php">
$myServiceName = new MyClassName('myConstructorArgument');
$myServiceName->myMethodName('myMethodArgument');
</source>

Parameter lassen sich einfach mit <code>setParameter</code> definieren:
<source lang="php">
$container->setParameter('myservice.myproperty', 'myValue');
</source>
Parameter können auch komplexe Werte wie Arrays und Objekte beinhalten.

Parameter können mit <code>getParameter</code> wieder abgefragt werden oder mit '%<parameter name>%' innerhalb der Service-Konfiguration wieder verwendet werden.
<source lang="php">
$container->register('myServiceName', 'MyClassName')
->addArgument('%myservice.myproperty%')
</source>

Welche Möglichkeiten der Container genau liefert, lässt sich in der [http://symfony.com/doc/2.1/components/dependency_injection/introduction.html#basic-usage Basic usage] nachlesen.

==services.php, services.yml, services.xml==

Konfiguriert wird der Container innerhalb einer <code>services.php</code>, <code>services.yml</code> oder <code>services.xml</code>, die innerhalb des <code>config/</code> Verzeichnisses im Modul abgelegt werden muss. Die einfachste Möglichkeit ist natürlich über die <code>services.php</code>, wie im oben gezeigtem Beispiel. Wie die Konfiguration mittels <code>services.yml</code> bzw. <code>services.xml</code> funktioniert, kann den Kapiteln [http://symfony.com/doc/2.1/components/dependency_injection/introduction.html#setting-up-the-container-with-configuration-files Setting Up the Container with Configuration Files] und [http://symfony.com/doc/2.1/components/dependency_injection/parameters.html#parameters-in-configuration-files Parameters in Configuration Files] entnommen werden.

===lokale services.php, services.yml, services.xml===

Um die Parameter und Services lokal zu überschreiben kann eine <code>services.php</code>, <code>services.yml</code> oder <code>services.xml</code> in <code>system/config/</code> hinterlegt werden.

=Verwenden von TL_CONFIG Einträgen=

Die Einträge aus <code>$GLOBALS['TL_CONFIG']</code> sind als Parameter mit dem Prefix <code>contao.</code> registriert, z.B. entspricht <code>contao.adminEmail</code> der Variable <code>$GLOBALS['TL_CONFIG']['adminEmail']</code>.

@@ Zeile 49: / Zeile 49: @@
 <source lang="php">
 $container['myServiceName'] = function($container) {
      $object = new MyClassName($container['myConstructorArgument']);

← Nächstältere Version		Version vom 16. Mai 2013, 19:41 Uhr
Zeile 16:		Zeile 16:

	==How to use==		==How to use==
		+
		+	Technisch wird der [https://github.com/fabpot/Pimple Pimple] Container verwendet.

	===Zugriff auf Werte im Container===		===Zugriff auf Werte im Container===

@@ Zeile 38: / Zeile 38: @@
 <source lang="php">
 $container['myServiceParameter'] = 'value';
 </source>

@@ Zeile 4: / Zeile 4: @@
 | Version=ab 2.11
 | ERLink=https://github.com/bit3/contao-dependency-container
-| TrackerLink=http://dev.contao-forge.org/projects/avisota/issues
+| TrackerLink=https://github.com/bit3/contao-dependency-container/issues
 }}
 [[Kategorie:Extensions]]
@@ Zeile 15: / Zeile 15: @@
 DI umfasst neben Komponenten (wie den Container) auch Programmierparadigmen und API Definitionen und muss daher von jedem Entwickler selbst "angewendet" werden.
-==Was macht der Container?==
+==How to use==
-Der Container ist ein zentraler Speicherort für Parameter und Dienste.
+===Zugriff auf Werte im Container===
-Parameter und Dienste haben einen Namen, damit ist der Container prinzipiell nichts anderes als ein <code>Key &rarr; Value</code> Storage.
 <source lang="php">
-$GLOBALS['container']->get('foo.bar');
+$value = $GLOBALS['container']['foo.bar'];
 </source>
 oder
 <source lang="php">
 global $container;
-$container->get('foo.bar');
+$value = $container['foo.bar'];
 </source>
-=Parameter und Dienste konfigurieren=
+===Werte im Container definieren===
-Ein Dienst wird mit <code>register</code> registriert:
+Services werden in Modulen über die <code>system/modules/X/config/services.php</code>
-<source lang="php">
+oder lokal über die <code>system/config/services.php</code> definiert.
-$container->register('myServiceName', 'MyClassName')
-    ->addArgument('myConstructorArgument')
-    ->addMethodCall('myMethodName', array('myMethodArgument'));
-</source>
-Das Beispiel registriert einen Dienst '''myServiceName''',  mit der Klasse '''MyClassName'''.
-Außerdem wird ein Argument mit dem Wert <code>'myConstructorArgument'</code> hinzugefügt, das beim Instanziieren an den Konstruktor übergeben wird.
-Anschließend wird noch die Methode '''myMethodName''' aufgerufen, mit dem Parameter <code>'myMethodArgument'</code>.
-Umgesetzt im PHP Code entspricht dies:
+====Parameter====
-<source lang="php">
-$myServiceName = new MyClassName('myConstructorArgument');
-$myServiceName->myMethodName('myMethodArgument');
-</source>
 <source lang="php">
-$container->setParameter('myservice.myproperty', 'myValue');
+$container['myServiceParameter'] = 'value';
 </source>
-Parameter können mit <code>getParameter</code> wieder abgefragt werden oder mit '%<parameter name>%' innerhalb der Service-Konfiguration wieder verwendet werden.
+====Services====
 <source lang="php">
-$container->register('myServiceName', 'MyClassName')
+$container['myServiceName'] = function($container) {
-     ->addArgument('%myservice.myproperty%')
+    $object = new MyClassName($container['myConstructorArgument']);
 </source>