Funktionsreferenz

Aus DynPG-Wiki
Version vom 20. März 2009, 01:36 Uhr von Sebastian (Diskussion | Beiträge)

(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Alle verfügbaren Funktionen, ihre Aufgabe und ihre Parameter können hier nachgelesen werden.

Funktion
Beschreibung
Parameter
$DynPG->SetParam_A_Article(Artikel_Nr);
Setzt einen Artikel, der mit $DynPG->Write_Article() dann ausgegeben werden kann. Artikel_Nr = "Nummer des Artikels" (sichtbar im Backend!)


$DynPG->SetParam_A_Anytime(Sichtbarkeit);
Bestimmt wann ein Artikel angezeigt wird (immer oder wenn durch Navigationskontext vorgegeben) Sichtbarkeit = "true" (immer) oder "false" (wenn durch Navigationskontext vorgegeben)


$DynPG->Write_Article();
Zeigt den aktuellen ( z.b. den mit $DynPG->SetParam_A_Article(x) gesetzten) Artikel an. keine Parameter
$DynPG->SetParam_A_ArticleCss("css_1");
Hier haben Sie die Möglichkeit, weitere CSS-Klassennamem speziell für diesen Artikel zu generieren. Die Klassennamen für diesen Artikel bekommen den Wert "css_1" hinten angehängt (z.B Klasse "TR.DynPG_General_tbl_A_Main_" wird zu "TR.DynPG_General_tbl_A_Main_css1"). Mehr zum CSS in Kapitel 3.  
$DynPG->SetParam_A_IgnoreSeperator(false);
Falls Sie für den Artikel einen Seperator eingefügt haben, können Sie ihn für diese Ansicht ignorieren. Das heisst bei true wird der Seperator ignoriert (Standard) und der Artikeltext ganz normal angezeigt, bei false wird der Seperator berücksichtigt und der Artikeltext wird an dieser Stelle unterbrochen . Darunter wird ein Link angezeigt, mit dem man durch einen Klick zum gesamten Text gelangt.  
$DynPG->SetParam_PathToNextPage('next.php');
Wird ein Text durch einen Seperator unterbrochen, entsteht ein Link, über den man dann zum gesamten Text gelangt. Mit dieser Methode legen die Seite fest, auf welcher der Artikel bei Klick auf den Link angezeigt werden soll. Ohne diese Methode wird die Ansicht in der selben Seite angezeigt.  

Tabelle 2.1. Tabelle der Funktionen für die Artikel-Detailansicht.


Funktion
Beschreibung
Parameter
$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).  
$DynPG->SetParam_AA_Group("News");
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.  
$DynPG->Write_AllArticles();
Diese Methode erstellt die Artikel-Liste. Hier dürfen Sie keine Änderungen vornehmen.  
$DynPG->SetParam_AA_Groups(array(), array());
Mit dieser Methode haben Sie die Möglichkeit eine Artikelliste aus mehreren Gruppen zu erstellen, indem Sie im ersten Parameter Gruppen einbinden und im zweiten Paramter Gruppen ausblenden können. Die Methode SetParam_AA_Group("Gruppenname"); ist in diesem Falle nicht mehr notwendig. Geben Sie einfach die Gruppennummern zwischen den Klammern von array() ein und trennen Sie diese mit einem Komma.  
$DynPG->SetParam_AA_OneArticle(3);
Wenn Sie nur einen einzigen Artikel in der Liste anzeigen wollen, benutzen Sie diese Methode. Geben Sie die Nummer des Artikels an, der angezeigt werden soll. Die Methode SetParam_AA_Group("Gruppenname"); ist in diesem Falle nicht mehr notwendig.  
$DynPG->SetParam_AA_Maxview(5);
Hier können Sie die Anzahl der Artikel, die pro Seite angezeigt werden sollen angeben. Lassen Sie diese Methode weg, so wird der Wert 'EL_Groups:MaximumArticlesEachSite' den Sie in der config.php angegeben haben benutzt.  
$DynPG->SetParam_AA_ArticleCss("css_1");
Hier haben Sie die Möglichkeit, weitere CSS-Klassennamem speziell für diesen Artikel zu generieren. Die Klassennamen für diesen Artikel bekommen den Wert "css_1" hinten angehängt (z.B Klasse "TR.DynPG_General_tbl_A_Main_" wird zu "TR.DynPG_General_tbl_A_Main_css1"). Mehr zum CSS in Kapitel 3.  
$DynPG->SetParam_POOL_Show(2);
Mit dieser Methode erstellen sie eine Liste mit allen Artikeln aus einer Zufallsgruppe. Da damit die Gruppe zufällig bestimmt wird, ist die Methode ...->SetParam_AA_Group() wegzulassen.  
$DynPG->SetParam_AA_Order( Array('INDEX') );
   
$DynPG->SetParam_AA_Sort( Array('ASC') );
   
$DynPG->SetParam_AA_ForceNav(false);
   
     

Tabelle 2.2. Tabelle der Funktionen für die Artikellistenansicht.


Funktion
Beschreibung
Parameter
$DynPG->Write_AllGroups();
Diese Methode erstellt die Gruppen-Liste. Hier dürfen Sie keine Änderungen vornehmen.  
$DynPG->SetParam_AG_Maxview(5);
Hier können Sie die Anzahl der Gruppen, die pro Seite angezeigt werden sollen angeben. Lassen Sie diese Methode weg, so wird der Wert 'EL_Groups:MaximumGroupsEachSite' den Sie in der config.php angegeben haben benutzt.  
$DynPG->SetParam_AG_ForceNav(false);
   
$DynPG->SetParam_AG_Anytime(true);
   
     
     
     
     

Tabelle 2.3. Tabelle der Funktionen für die Gruppenlistenansicht.


Funktion
Beschreibung
Parameter
$DynPG->SetParam_POOL_Add( Array(12,1) );
Geben Sie hier die Artikelnummern an, aus welchen nach Zufallsprinzip einer ausgewählt und angezeigt werden soll. Trennen Sie die Nummern jeweils mit einem Komma. Wollen Sie einen Zufallsartikel aus allen Artikeln erstellen so lassen Sie diese Zeile einfach weg.  
$DynPG->SetParam_POOL_Show(1);
Geben Sie hier an, ob der Seperator bei einem Zufallsartikel beachtet werden soll. 1 steht für Ja, 0 für Nein.  
$DynPG->Write_RandomArticlePool();
Diese Methode erstellt die Ansicht eines Zufallartikels. Hier dürfen Sie keine Änderungen vornehmen.  
$DynPG->_POOL_Clear();
Falls Sie mehrere Zufallsartikel auf einer Seite haben, so ist der Aufruf dieser Methode notwendig. Er leert den Pool der Zufallsartikel und ein neuer kann erstellt werden. Dieser Aufruf erfolgt als letzter. Änderungen müssen Sie keine vornehmen.  
$DynPG->setupTemplate('default');
   
     
     
     

Tabelle 2.4. Weitere Funktionen