Die drei Ansichten von DynPG: Unterschied zwischen den Versionen

Aus DynPG-Wiki
Wechseln zu: Navigation, Suche
(Formatierung überarbeitet)
(Artikel überarbeitet und gekürzt)
Zeile 2: Zeile 2:
  
 
== Die Ansichten ==
 
== Die Ansichten ==
 +
Bei der [[DynPG in eine Webseite einbinden|Einbindung von DynPG in eine Webseite]] haben Sie bereits sehen können, wie einfach man mit DynPG eine Liste der Gruppen im Backend anzeigen lassen kann. In dem Beispiel wurde die sogenannte Gruppenliste demonstriert. Insgesamt gibt es drei Ansichten:
  
In einem [[Ein erstes kleines Beispiel|ersten kleinen Beispiel]] konnten Sie sich davon überzeugen, wie einfach es ist mit DynPG zu einem ersten Resultat zu kommen. In dem Beispiel wurde die sogenannte Gruppenliste demonstriert. Insgesamt gibt es drei Ansichten:  
+
* die Gruppenliste: abgekürzt mit '''AG''' für ''all groups''
 +
* die Artikelliste: abgekürzt mit '''AA''' für ''all articles''
 +
* die Artikel-Detailansicht: abgekürzt mit '''A''' für ''article''
  
* die Gruppenliste (abgekürzt mit '''''AG''''')
+
Die ''Gruppenlisten-Ansicht'' gibt alle Gruppen(-namen) aus, die in der Datenbank vorhanden sind. In der ''Artikellisten-Ansicht'' kann man sich die Artikel einer bestimmten Gruppe anzeigen lassen. Die ''Artikel-Detailansicht'' zeigt letztlich den Artikelinhalt eines bestimmten Artikels an. Alle drei Ansichten haben Parameter, die die Ausgabe beeinflussen. Diesen Parametern und Aufrufen werden wir nun nach und nach vorstellen.
* die Artikelliste (abgekürzt '''''AA''''')
+
* die Artikel-Detailansicht (abgekürzt '''''A''''')
+
  
Die ''Gruppenlisten-Ansicht'' gibt alle Gruppen(-namen) aus, die in der Datenbank vorhanden sind. In der ''Artikellisten-Ansicht'' kann man sich die Artikel(-namen) einer bestimmten Gruppe anzeigen lassen. Die ''Artikel-Detailansicht'' zeigt letztlich den Artikelinhalt eines bestimmten Artikels an. Alle drei Ansichten haben Parameter, die die Ausgabe beeinflussen. Diesen Parametern und Aufrufen werden wir uns nun nach und nach widmen.
 
  
=== Integration einer Artikel-Detailansicht ===
+
=== Integration einer Gruppenliste ===
  
Dies ist die detaillierteste Anzeigestufe. Mit der Integration eines einzelnen Artikels wird ein bestimmter Artikel in der Detailansicht angezeigt. Durch diverse Parameterangaben können Sie weitere Einstellungen vornehmen.
+
Wie es der Name bereits vermuten lässt, werden in der Gruppenliste alle Gruppen in einer Liste dargestellt. Bei einem Klick auf eine der Gruppen, wird von dieser eine Artikel-Liste angezeigt oder wenn weitere Untergruppen bestehen eine Gruppen-Liste der Untergruppen. Von der Artikel-Liste gelangt man mittels Link zu der Detailansicht. Deshalb muss zuerst eine Gruppen-Liste, dann eine Artikel-Liste und zuletzt die Detailansicht eines Artikels implementiert werden. Dabei können Sie Parameter setzen und so weitere Einstellungen vornehmen und zusätzliche Optionen ein oder ausblenden.
  
Die Artikel-Detailansicht implementieren Sie durch folgenden PHP Code:
+
Die Gruppen-Liste implementieren Sie durch folgenden PHP Code:
 
<code>[php,Y]
 
<code>[php,Y]
 
<?php
 
<?php
   $DynPG->SetParam_A_Anytime(true);
+
   $DynPG->SetParam_AG_Anytime(true);
   $DynPG->SetParam_A_Article(1);
+
   $DynPG->Write_AllGroups();
  $DynPG->Write_Article();
+
 
?>
 
?>
 
</code>
 
</code>
 
  
 
'''Erläuterung:'''
 
'''Erläuterung:'''
*Zeile 2: <tt>$DynPG->SetParam_A_Anytime(true);</tt>
+
*Zeile 3: <tt>$DynPG->Write_AllGroups();</tt>
:Dieser Parameter weist DynPG an, diesen Artikel ständig anzuzeigen und nicht nur dann, wenn dies durch den Kontext vorgegeben ist, d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangen. Wenn Sie einen Artikel einzeln anzeigen, muss dieser Parameter stets auf true gesetzt sein.
+
:Diese Methode erstellt die Gruppen-Liste.
*Zeile 3: <tt>$DynPG->SetParam_A_Article(19);</tt>
+
:Hier können Sie angeben, welchen Artikel Sie anzeigen möchten. Schreiben Sie einfach die Artikelnummer, die automatisch von DynPG zugewiesen wurde, als Sie den Artikel erstellt haben. Diese können Sie im Backend einsehen. In der Artikelauflistung finden Sie dort eine Spalte, welche die jeweilige ID anzeigt.
+
*Zeile 4: <tt>$DynPG->Write_Article();</tt>
+
:Diese Methode erstellt die Detailansicht des Artikels. Sie muss zwingend der letzte Aufruf auf dieser Ebene sein.
+
  
Weitere mögliche Parameter können Sie der [[Funktionsreferenz]] entnehmen.
+
Weitere mögliche Parameter für die Gruppenliste können Sie der [[Funktionsreferenz#Gruppenlistenansicht|Funktionsreferenz]] entnehmen. Nach dem Aufruf der Methode <tt>Write_AllGroups()</tt> müssen Sie nun die Einstellungen für die Artikel-Liste und danach die Einstellungen für die Detaiansicht eines Artikels vornehmen.
  
=== Integration einer Artikel-Liste ===
 
  
Dies ist die zweittiefste Anzeigestufe. Mit der Integration der Artikel-Liste wird eine Liste aller Artikel einer Gruppe angezeigt. Bei einem Klick auf einen der Artikel, wird dieser in der Detailansicht angezeigt. Deshalb muss zuerst eine Artikel-Liste implementiert werden und direkt darunter die Detailansicht für den einzelnen Artikel. Auch hier können Sie Parameter setzen und dadurch weitere Einstellungen vornehmen.
+
=== Integration einer Artikelliste ===
  
Die Artikel-Liste implementieren Sie durch folgenden PHP Code (muss innerhalb des "body"-Tags stehen):
+
Dies ist die zweittiefste Anzeigestufe. Mit der Integration der Artikelliste wird eine Liste aller Artikel einer Gruppe angezeigt. Bei einem Klick auf einen der Artikel, wird dieser in der Detailansicht angezeigt. Deshalb muss zuerst eine Artikelliste implementiert werden und darunter die Detailansicht für den einzelnen Artikel. Auch hier können Sie Parameter setzen und dadurch weitere Einstellungen vornehmen.
 +
 
 +
Die Artikelliste implementieren Sie durch folgenden PHP Code (muss innerhalb des "body"-Tags stehen):
 
<code>[php,Y]
 
<code>[php,Y]
 
<?php
 
<?php
Zeile 47: Zeile 42:
 
?>
 
?>
 
</code>
 
</code>
 
  
 
'''Erläuterung:'''
 
'''Erläuterung:'''
 
*Zeile 2: <tt>$DynPG->SetParam_AA_Anytime(true);</tt>
 
*Zeile 2: <tt>$DynPG->SetParam_AA_Anytime(true);</tt>
 
:Dieser Parameter weist DynPG an, diese Artikelliste ständig anzuzeigen und nicht nur dann, wenn dies durch den Kontext vorgegeben ist (d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangen).
 
:Dieser Parameter weist DynPG an, diese Artikelliste ständig anzuzeigen und nicht nur dann, wenn dies durch den Kontext vorgegeben ist (d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangen).
*Zeile 3: <tt>$DynPG->SetParam_AA_Group("News");</tt>
+
*Zeile 3: <tt>$DynPG->SetParam_AA_Group("Gruppenname");</tt>
:Geben Sie hier den Namen der Gruppe an, von der Sie eine Artikel-Listenansicht angezeigt haben wollen. In diesem Beispiel würde eine Liste der Artikel in der Gruppe "News" angezeigt werden.
+
:Geben Sie hier den Namen der Gruppe an, von der Sie eine Artikel-Listenansicht angezeigt haben wollen. In diesem Beispiel würde eine Liste der Artikel in der Gruppe "Gruppenname" angezeigt werden.
 
*Zeile 4: <tt>$DynPG->Write_AllArticles();</tt>
 
*Zeile 4: <tt>$DynPG->Write_AllArticles();</tt>
 
:Diese Methode erstellt die Artikel-Liste.
 
:Diese Methode erstellt die Artikel-Liste.
  
 +
Weitere mögliche Parameter für die Artikelliste können Sie der [[Funktionsreferenz#Artikellistenansicht|Funktionsreferenz]] entnehmen.
  
Nach dem Aufruf der Methode <tt>Write_AllArticles()</tt> müssen Sie nun die Einstellungen für die Detailansicht eines Artikels vornehmen. Diese sind natürlich identisch mit denen der [[#Integration einer Artikel-Detailansicht]], deshalb werden Sie hier nicht noch mal erläutert. Am Ende muss wiederum die Methode <tt>Write_Article();</tt> stehen. Eine Implementierung einer Artikel-Liste könnte also beispielsweise so Aussehen:
 
<code>[php,N]
 
<?php
 
  $DynPG->SetParam_AA_Anytime(true);
 
  $DynPG->SetParam_AA_Group("Gruppenname");
 
  $DynPG->Write_AllArticles();
 
  $DynPG->Write_Article();
 
?>
 
</code>
 
  
Weitere mögliche Parameter entnehmen Sie der [[Funktionsreferenz]].
+
=== Integration einer Artikel-Detailansicht ===
  
=== Integration einer Gruppen-Liste ===
+
Dies ist die detaillierteste Anzeigestufe. Mit der Integration eines einzelnen Artikels wird ein bestimmter Artikel in der Detailansicht angezeigt. Durch diverse Parameterangaben können Sie weitere Einstellungen vornehmen.
  
Wie es der Name schon verrät, werden in der Gruppen-Liste alle Gruppen in einer Liste aufgereiht. Bei einem Klick auf eine der Gruppen, wird von dieser eine Artikel-Liste angezeigt oder wenn weitere Untergruppen bestehen eine Gruppen-Liste der Untergruppen. Von der Artikel-Liste gelangt man mittels Link zu der Detailansicht. Deshalb muss zuerst eine Gruppen-Liste, dann eine Artikel-Liste und zuletzt die Detailansicht eines Artikels implementiert werden. Auch hier können Sie Parameter setzen und so weitere Einstellungen vornehmen und zusätzliche Optionen ein oder ausblenden.
+
Die Artikel-Detailansicht implementieren Sie durch folgenden PHP Code:
 
+
Die Gruppen-Liste implementieren Sie durch folgenden PHP Code:
+
 
<code>[php,Y]
 
<code>[php,Y]
 
<?php
 
<?php
   $DynPG->SetParam_AG_Anytime(true);
+
   $DynPG->SetParam_A_Anytime(true);
   $DynPG->Write_AllGroups();
+
   $DynPG->SetParam_A_Article(1);
 +
  $DynPG->Write_Article();
 
?>
 
?>
 
</code>
 
</code>
 
  
 
'''Erläuterung:'''
 
'''Erläuterung:'''
*Zeile 3: <tt>$DynPG->Write_AllGroups();</tt>
+
*Zeile 2: <tt>$DynPG->SetParam_A_Anytime(true);</tt>
:Diese Methode erstellt die Gruppen-Liste.
+
:Dieser Parameter weist DynPG an, diesen Artikel ständig anzuzeigen und nicht nur dann, wenn dies durch den Kontext vorgegeben ist, d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangen. Wenn Sie einen Artikel einzeln anzeigen, muss dieser Parameter stets auf true gesetzt sein.
 
+
*Zeile 3: <tt>$DynPG->SetParam_A_Article(19);</tt>
 
+
:Hier können Sie angeben, welchen Artikel Sie anzeigen möchten. Schreiben Sie einfach die Artikelnummer, die automatisch von DynPG zugewiesen wurde, als Sie den Artikel erstellt haben. Diese können Sie im Backend einsehen. In der Artikelauflistung finden Sie dort eine Spalte, welche die jeweilige ID anzeigt.
Nach dem Aufruf der Methode <tt>Write_AllGroups()</tt> müssen Sie nun die Einstellungen für die Artikel-Liste und danach die Einstellungen für die Detaiansicht eines Artikels vornehmen. Diese sind natürlich identisch mit denen der [[#Integration einer Artikel-Detailansicht]] und [[#Integration einer Artikel-Liste]], deshalb werden Sie hier nicht noch mal erläutert. Am Ende der entsprechenden Ansicht muss wiederum die Methode <tt>Write_AllArticles();</tt> bzw. <tt>Write_Article();</tt> stehen.
+
*Zeile 4: <tt>$DynPG->Write_Article();</tt>
 
+
:Diese Methode erstellt die Detailansicht des Artikels. Sie muss zwingend der letzte Aufruf auf dieser Ebene sein.
Eine komplette Implementierung einer Gruppen-Liste könnte also beispielsweise so aussehen:
+
<code>[php,N]
+
<?php
+
  $DynPG->SetParam_AG_Anytime(true);
+
  $DynPG->Write_AllGroups();
+
  $DynPG->Write_AllArticles();
+
  $DynPG->Write_Article();
+
?>
+
</code>
+
 
+
Weitere mögliche Parameter entnehmen Sie der [[Funktionsreferenz]].
+
 
+
== Weiterführung des Beispiels ==
+
 
+
Zur Veranschaulichung erweitern wir nun unser bestehendes Beispiel. Dieses wird um ein paar nette Funktionen verfeinert. Zusätzlich zur Gruppenliste sollen auch die Untergruppen bzw. die Artikel die in diesen Gruppen existieren, angezeigt werden. Damit sind wir dann bereits in der Lage durch unsere Gruppen zu navigieren und vorhandene Artikel darzustellen.
+
 
+
<code>[php,N]
+
<?php
+
  $DynPG->SetParam_AA_Anytime(false);
+
  $DynPG->Write_AllArticles();
+
 
+
  $DynPG->SetParam_A_Anytime(false);
+
  $DynPG->Write_Article();
+
?>
+
</code>
+
 
+
Nun wird nicht mehr nur eine starre Gruppenliste angezeigt. Es existiert jetzt eine komplette Navigation. (den vollständigen Code des Beispiels finden sie [[Code-Schnipsel Alle Ansichten (komplette Navigation)|hier]])
+
 
+
=== Erläuterungen ===
+
 
+
Nun zur Erklärung der beiden vorangegangenen Beispiele. Was die einzelnen Funktionen genau tun werden wir hier nicht erörtern (siehe dazu:[[Funktionsreferenz]]), aber wir werden uns damit befassen, wie sie zusammenspielen. Schauen wir zuerst den Aufruf aus Beispiel 1 (das Minimalbeispiel) an.
+
 
+
<code>[php,N]
+
  $DynPG->SetParam_AG_Anytime(true);
+
</code>
+
 
+
Der Präfix "SetParam" kündigt schon an, dass hierbei ein Parameter gesetzt wird. Es gibt mehrere solcher Funktionen. "AG" (wie schon aus obiger Tabelle bekannt) steht für die Gruppenlisten-Ansicht. Die Funktion bewirkt, dass die Gruppenliste von Anfang an (beim Aufruf der Seite) angezeigt wird und nicht nur dann, wenn dies durch den Kontext vorgegeben ist (d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangt). Würden wir der Funktion das Argument "false" übergeben, so wäre dies folglich nicht der Fall. Nun wurde also ein Parameter gesetzt der die folgende Funktion
+
 
+
<code>[php,N]
+
  $DynPG->Write_AllGroups();
+
</code>
+
 
+
in eben genannter Weise beeinflusst.
+
 
+
Im Beispiel 2 (komplette Navigation) funktioniert das analog, nur dass wir die Parameter- und Ausgabefunktionen auch für die Artikellistenansicht (AA) und die Artikel-Detailansicht (A) aufrufen. Es fällt allerdings auf, dass bei den "SetParam"-Funktionen als Argument "false" übergeben wird. Dies ist nötig, denn wir wollen die Artikellisten und Artikel die sich in einer Gruppe befinden ja nur dann ausgeben, wenn der Kontext es vorgibt (also dann wenn der Nutzer auf die Gruppe geklickt hat) und nicht von Anfang an.
+
 
+
[[Image:note.png]] '''Anmerkung''' Die Reihenfolge von <tt>Write_AllGroups()</tt>, <tt>Write_AllArticles()</tt> und <tt>Write_Article()</tt> im Code ist beliebig.
+
 
+
Nun können Sie daran gehen die Ansicht von Beispiel 2 weiter zu beeinflussen, z.B. mit:
+
 
+
<code>[php,N]
+
  $DynPG->SetParam_AG_ForceNav(false);
+
</code>
+
  
Dadurch wird die "Zurück-Weiter-Navigation" abgeschaltet. Weitere nützliche Parameter-Funktionen finden Sie in der [[Funktionsreferenz]].
+
Weitere mögliche Parameter für die Artikel-Detailansicht können Sie der [[Funktionsreferenz#Artikel-Detailansicht|Funktionsreferenz]] entnehmen.

Version vom 7. Oktober 2010, 15:15 Uhr


Die Ansichten

Bei der Einbindung von DynPG in eine Webseite haben Sie bereits sehen können, wie einfach man mit DynPG eine Liste der Gruppen im Backend anzeigen lassen kann. In dem Beispiel wurde die sogenannte Gruppenliste demonstriert. Insgesamt gibt es drei Ansichten:

  • die Gruppenliste: abgekürzt mit AG für all groups
  • die Artikelliste: abgekürzt mit AA für all articles
  • die Artikel-Detailansicht: abgekürzt mit A für article

Die Gruppenlisten-Ansicht gibt alle Gruppen(-namen) aus, die in der Datenbank vorhanden sind. In der Artikellisten-Ansicht kann man sich die Artikel einer bestimmten Gruppe anzeigen lassen. Die Artikel-Detailansicht zeigt letztlich den Artikelinhalt eines bestimmten Artikels an. Alle drei Ansichten haben Parameter, die die Ausgabe beeinflussen. Diesen Parametern und Aufrufen werden wir nun nach und nach vorstellen.


Integration einer Gruppenliste

Wie es der Name bereits vermuten lässt, werden in der Gruppenliste alle Gruppen in einer Liste dargestellt. Bei einem Klick auf eine der Gruppen, wird von dieser eine Artikel-Liste angezeigt oder wenn weitere Untergruppen bestehen eine Gruppen-Liste der Untergruppen. Von der Artikel-Liste gelangt man mittels Link zu der Detailansicht. Deshalb muss zuerst eine Gruppen-Liste, dann eine Artikel-Liste und zuletzt die Detailansicht eines Artikels implementiert werden. Dabei können Sie Parameter setzen und so weitere Einstellungen vornehmen und zusätzliche Optionen ein oder ausblenden.

Die Gruppen-Liste implementieren Sie durch folgenden PHP Code:

  1. <?php
  2. $DynPG->SetParam_AG_Anytime(true);
  3. $DynPG->Write_AllGroups();
  4. ?>

Erläuterung:

  • Zeile 3: $DynPG->Write_AllGroups();
Diese Methode erstellt die Gruppen-Liste.

Weitere mögliche Parameter für die Gruppenliste können Sie der Funktionsreferenz entnehmen. Nach dem Aufruf der Methode Write_AllGroups() müssen Sie nun die Einstellungen für die Artikel-Liste und danach die Einstellungen für die Detaiansicht eines Artikels vornehmen.


Integration einer Artikelliste

Dies ist die zweittiefste Anzeigestufe. Mit der Integration der Artikelliste wird eine Liste aller Artikel einer Gruppe angezeigt. Bei einem Klick auf einen der Artikel, wird dieser in der Detailansicht angezeigt. Deshalb muss zuerst eine Artikelliste implementiert werden und darunter die Detailansicht für den einzelnen Artikel. Auch hier können Sie Parameter setzen und dadurch weitere Einstellungen vornehmen.

Die Artikelliste implementieren Sie durch folgenden PHP Code (muss innerhalb des "body"-Tags stehen):

  1. <?php
  2. $DynPG->SetParam_AA_Anytime(true);
  3. $DynPG->SetParam_AA_Group("Gruppenname");
  4. $DynPG->Write_AllArticles();
  5. ?>

Erläuterung:

  • Zeile 2: $DynPG->SetParam_AA_Anytime(true);
Dieser Parameter weist DynPG an, diese Artikelliste ständig anzuzeigen und nicht nur dann, wenn dies durch den Kontext vorgegeben ist (d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangen).
  • Zeile 3: $DynPG->SetParam_AA_Group("Gruppenname");
Geben Sie hier den Namen der Gruppe an, von der Sie eine Artikel-Listenansicht angezeigt haben wollen. In diesem Beispiel würde eine Liste der Artikel in der Gruppe "Gruppenname" angezeigt werden.
  • Zeile 4: $DynPG->Write_AllArticles();
Diese Methode erstellt die Artikel-Liste.

Weitere mögliche Parameter für die Artikelliste können Sie der Funktionsreferenz entnehmen.


Integration einer Artikel-Detailansicht

Dies ist die detaillierteste Anzeigestufe. Mit der Integration eines einzelnen Artikels wird ein bestimmter Artikel in der Detailansicht angezeigt. Durch diverse Parameterangaben können Sie weitere Einstellungen vornehmen.

Die Artikel-Detailansicht implementieren Sie durch folgenden PHP Code:

  1. <?php
  2. $DynPG->SetParam_A_Anytime(true);
  3. $DynPG->SetParam_A_Article(1);
  4. $DynPG->Write_Article();
  5. ?>

Erläuterung:

  • Zeile 2: $DynPG->SetParam_A_Anytime(true);
Dieser Parameter weist DynPG an, diesen Artikel ständig anzuzeigen und nicht nur dann, wenn dies durch den Kontext vorgegeben ist, d.h. wenn ein Benutzer durch eine Artikelliste oder andere Elemente mit dynamischen Artikellisten auf diese Seite gelangen. Wenn Sie einen Artikel einzeln anzeigen, muss dieser Parameter stets auf true gesetzt sein.
  • Zeile 3: $DynPG->SetParam_A_Article(19);
Hier können Sie angeben, welchen Artikel Sie anzeigen möchten. Schreiben Sie einfach die Artikelnummer, die automatisch von DynPG zugewiesen wurde, als Sie den Artikel erstellt haben. Diese können Sie im Backend einsehen. In der Artikelauflistung finden Sie dort eine Spalte, welche die jeweilige ID anzeigt.
  • Zeile 4: $DynPG->Write_Article();
Diese Methode erstellt die Detailansicht des Artikels. Sie muss zwingend der letzte Aufruf auf dieser Ebene sein.

Weitere mögliche Parameter für die Artikel-Detailansicht können Sie der Funktionsreferenz entnehmen.