DynPG in eine Webseite einbinden: Unterschied zwischen den Versionen

Aus DynPG-Wiki
Wechseln zu: Navigation, Suche
(Artikel aktualisiert)
Zeile 1: Zeile 1:
 
[[Category:Integration_in_eine_Webseite]]
 
[[Category:Integration_in_eine_Webseite]]
 
== Einbinden von DynPG ==
 
== Einbinden von DynPG ==
DynPG kann in jede beliebige HTML-Seite eingebunden werden. Dies geschieht, indem zuersteinmal die entsprechende HTML-Datei mit der Endung <tt>.php</tt> versehen wird. Die eigentliche Integration erfolgt nun durch Einfügen folgender Zeilen an den Anfang der Seite:
+
DynPG kann in jede beliebige HTML-Seite eingebunden werden. Dies geschieht, indem zuerst die entsprechende HTML-Datei mit der Endung <tt>.php</tt> versehen wird. Die eigentliche Integration erfolgt nun durch Einfügen folgender Zeilen am Anfang der Seite:
 
+
  
 
'''Snippet - Einbinden von DynPG'''
 
'''Snippet - Einbinden von DynPG'''
Zeile 12: Zeile 11:
 
</code>
 
</code>
  
=== Erklärung ===
 
Diese Zeilen müssen Sie auf jeder PHP-Seite, bei der Sie DynPG implementieren wollen, zuerst angeben. Dies bedeutet, dass vor dem Befehl <tt><?php</tt> kein Zeichen an den Browser versandt werden durfte (d.h. weder Sonderzeichen noch sonstige, nicht in PHP-Bereiche geschriebene Zeichen).
 
  
Die erste Zeile muss den Pfad der Datei getcontent.php enthalten, ausgehend vom Verzeichnis in der die PHP Datei gespeichert ist. Änderungen sind hier nur nötig, wenn Sie DynPG nicht im Ordner "cms" installiert haben. In der zweiten Zeile geben Sie das Verzeichnis an, indem Sie DynPG installiert haben. Dabei ist immer von dem Verzeichnis auszugehen, in der Sie diese Datei gespeichert haben. Um ein höheres Verzeichnis zu erreichen schreiben Sie zwei Punkte ( <tt>..</tt> ). Jede Ordnerangabe müssen Sie mit einem "Slash" ( <tt>/</tt> ) abschliessen.
+
'''Erklärung''':
  
=== Beispiel ===
+
Diese Zeilen müssen Sie als erstes in jeder PHP-Datei, in der Sie DynPG nutzen wollen, angeben. Dadurch werden die Anweisungen für die Code-Snippets von DynPG verfügbar gemacht.
Dazu noch ein Beispiel:
+
  
* Datei "beispielseite.php" liegt im Verzeichnis "seiten/beispielseite.php".
+
* ''Zeile 1'': Die erste Zeile muss den Pfad zur Datei mit dem Namen <tt>getcontent.php</tt> enthalten. Diese Datei befindet sich im Hauptverzeichnis von DynPG. Da es sich um eine relative Pfadangabe handelt, erfolgt die Angabe ausgehend vom Verzeichnis in der die PHP Datei gespeichert ist.
* die Dateien von DynPG sind im Verzeichnis "programme/cms/" gespeichert.
+
* ''Zeile 2'': In der zweiten Zeile geben Sie das Verzeichnis an, indem Sie DynPG installiert haben. Dabei ist immer von dem Verzeichnis auszugehen, in der Sie diese Datei gespeichert haben. Um ein höheres Verzeichnis zu erreichen schreiben Sie zwei Punkte ( <tt>..</tt> ). Jede Ordnerangabe müssen Sie mit einem "Slash" ( <tt>/</tt> ) abschliessen.
* die Ordner "seiten" und "programme" befinden sich im selben Verzeichnis
+
 
* die Pfadangabe sieht folgendermaßen aus:
+
[[Image:Note.png]] ''Hinweis'':  Wenn Sie anderes Snippet mit dem <tt>include</tt> Befehl von PHP in eine Seite einbinden, die DynPG bereits eingebunden hat, dann können Sie diese Zeilen in dem Snippet, dass Sie einbinden möchten, weglassen. 
:<code>[php,N]SetParam_PathToRoot('../programme/cms/');</code>
+
 
* und zur Datei getcontent.php so:
+
 
:<code>[php,N]require('../programme/cms/getcontent.php');</code>
+
'''Ein einfaches Beispiel''':
 +
 
 +
Nehmen wir an, Sie haben die folgenden Dateistruktur auf Ihrem Server:
 +
* die Datei <tt>beispielseite.php</tt> liegt im Verzeichnis <tt>seiten/beispielseite.php</tt>.
 +
* die Dateien von DynPG sind im Verzeichnis <tt>dynpg/</tt> gespeichert
 +
* die Ordner <tt>seiten/</tt> und <tt>dynpg/</tt> befinden sich im selben Verzeichnis
 +
 
 +
Die Pfadangaben sehen dann folgendermaßen aus:
 +
<code>[php,N]
 +
<?php
 +
  require('../dynpg/getcontent.php');
 +
  SetParam_PathToRoot('../dynpg/');
 +
?>
 +
</code>
  
 
== Minimalbeispiel ==
 
== Minimalbeispiel ==
Nun will ich daran gehen ein Minimalbeispiel für die Einbindung in eine Website zu zeigen. Wir erstellen nun eine Datei mit bspw. dem Namen '''''"index.php"'''''. Die Ordnerstruktur könnte dann in etwa so aussehen:
+
Zum Testen der Einstellung können Sie das folgende Minimalbeispiel verwenden. Passen Sie hier die ersten beiden Zeilen wie im vorherigen Abschnitt beschrieben an. Wir wollen zudem gleich eine Liste aller im Backend vorhandenen Gruppen ausgeben. Dazu fügen wir zwei weitere DynPG-Anweisungen zwischen den <tt>body</tt> Tags ein.
  
[[Image:sample1_dirstructure.jpg|Abbildung 2.1. Ordnerstruktur des Minimalbeispiels]]
+
<code>[php, N]
 +
<?php
 +
  require('../dynpg/getcontent.php');
 +
  SetParam_PathToRoot('../dynpg/');
 +
?>
  
Im Ordner '''''"cms"''''' ist also unser CMS installiert. Nun füllen wir die Datei mit etwas Standard-Html-Code:
 
{{-}}
 
<code>[php, N]
 
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
Zeile 44: Zeile 54:
  
 
<body>
 
<body>
Hallo Welt!
+
  <?php
 +
    $DynPG->SetParam_AG_Anytime(true);
 +
    $DynPG->Write_AllGroups();
 +
  ?>
 
</body>
 
</body>
  
Zeile 50: Zeile 63:
 
</code>
 
</code>
  
Nun wollen wir DynPG einbinden und dazu schreiben wir die folgenden Zeilen in den Kopf von "index.php":
 
 
<code>[php, N]
 
<?php
 
  require 'cms/getcontent.php';
 
  $DynPG->SetParam_PathToRoot('cms/');
 
?>
 
</code>
 
 
Dieser Code dient dazu alle Funktionalitäten von DynPG in der aktuellen HTML-Datei verfügbar zu machen. In Zeile 3 muss der relative Pfad zu dem DynPG-Ordner (hier "cms/") stehen.
 
 
[[Image:caution.png]] '''Achtung!''' Diese beiden Zeilen müssen unbedingt an oberster Stelle in der Datei stehen (ohne führende Freizeile!!)
 
 
Nun können wir also loslegen. Wir wollen alle Gruppen (bei der Installation von DynPG wurden bereits automatisch Gruppen erzeugt!) in unserer Datenbank anzeigen lassen. Dazu fügen wir die folgenden Zeilen '''''zwischen die body-tags''''' unserer HTML-Seite ein:
 
 
<code>[php, N]
 
<?php
 
  $DynPG->SetParam_AG_Anytime(true);
 
  $DynPG->Write_AllGroups();
 
?>
 
</code>
 
 
Was genau das alles bedeutet, werden wir später sehen. Wenn wir aber alles richtig gemacht haben, dann müsste bei aufrufen der Seite nun folgende Ausgabe zu sehen sein:
 
 
[[Image:frontend_example1.jpg|Abbildung 2.2. Ausgabe des Minimalbeispiels|200px]]
 
  
 +
Was genau das alles bedeutet, werden wir später in den Artikeln zu den [[Die drei Ansichten von DynPG|drei Sichten von DynPG]] sehen. Wenn wir aber alles richtig gemacht haben, dann müsste beim Aufrufen der Seite nun eine ähnliche Ausgabe, wie die folgende zu sehen sein:
  
Der komplette Code der HTML-Datei kann [[Code-Schnipsel Minimalbeispiel|hier]] heruntergeladen werden.
+
[[Image:frontend_example1.jpg|Abbildung 2.2. Ausgabe des Minimalbeispiels]]

Version vom 7. Oktober 2010, 15:40 Uhr

Einbinden von DynPG

DynPG kann in jede beliebige HTML-Seite eingebunden werden. Dies geschieht, indem zuerst die entsprechende HTML-Datei mit der Endung .php versehen wird. Die eigentliche Integration erfolgt nun durch Einfügen folgender Zeilen am Anfang der Seite:

Snippet - Einbinden von DynPG

<?php
  require('cms/getcontent.php');
  $DynPG->SetParam_PathToRoot('cms/');
?>


Erklärung:

Diese Zeilen müssen Sie als erstes in jeder PHP-Datei, in der Sie DynPG nutzen wollen, angeben. Dadurch werden die Anweisungen für die Code-Snippets von DynPG verfügbar gemacht.

  • Zeile 1: Die erste Zeile muss den Pfad zur Datei mit dem Namen getcontent.php enthalten. Diese Datei befindet sich im Hauptverzeichnis von DynPG. Da es sich um eine relative Pfadangabe handelt, erfolgt die Angabe ausgehend vom Verzeichnis in der die PHP Datei gespeichert ist.
  • Zeile 2: In der zweiten Zeile geben Sie das Verzeichnis an, indem Sie DynPG installiert haben. Dabei ist immer von dem Verzeichnis auszugehen, in der Sie diese Datei gespeichert haben. Um ein höheres Verzeichnis zu erreichen schreiben Sie zwei Punkte ( .. ). Jede Ordnerangabe müssen Sie mit einem "Slash" ( / ) abschliessen.

Note.png Hinweis: Wenn Sie anderes Snippet mit dem include Befehl von PHP in eine Seite einbinden, die DynPG bereits eingebunden hat, dann können Sie diese Zeilen in dem Snippet, dass Sie einbinden möchten, weglassen.


Ein einfaches Beispiel:

Nehmen wir an, Sie haben die folgenden Dateistruktur auf Ihrem Server:

  • die Datei beispielseite.php liegt im Verzeichnis seiten/beispielseite.php.
  • die Dateien von DynPG sind im Verzeichnis dynpg/ gespeichert
  • die Ordner seiten/ und dynpg/ befinden sich im selben Verzeichnis

Die Pfadangaben sehen dann folgendermaßen aus:

<?php
  require('../dynpg/getcontent.php');
  SetParam_PathToRoot('../dynpg/');
?>

Minimalbeispiel

Zum Testen der Einstellung können Sie das folgende Minimalbeispiel verwenden. Passen Sie hier die ersten beiden Zeilen wie im vorherigen Abschnitt beschrieben an. Wir wollen zudem gleich eine Liste aller im Backend vorhandenen Gruppen ausgeben. Dazu fügen wir zwei weitere DynPG-Anweisungen zwischen den body Tags ein.

<?php
  require('../dynpg/getcontent.php');
  SetParam_PathToRoot('../dynpg/');
?>
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
<head>
	<title>Minimalbeispiel</title>
	<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
</head>
 
<body>
  <?php
    $DynPG->SetParam_AG_Anytime(true);
    $DynPG->Write_AllGroups();
  ?>
</body>
 
</html>


Was genau das alles bedeutet, werden wir später in den Artikeln zu den drei Sichten von DynPG sehen. Wenn wir aber alles richtig gemacht haben, dann müsste beim Aufrufen der Seite nun eine ähnliche Ausgabe, wie die folgende zu sehen sein:

Abbildung 2.2. Ausgabe des Minimalbeispiels