Funktionsreferenz: Unterschied zwischen den Versionen

Aus DynPG-Wiki
Wechseln zu: Navigation, Suche
Zeile 282: Zeile 282:
 
| <code>[php, N]$GLOBALS["DynPG"]->_POOL_Clear();</code>
 
| <code>[php, N]$GLOBALS["DynPG"]->_POOL_Clear();</code>
 
| 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.  
 
| 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.  
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_H_Anytime(false);</code>
 +
|
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_H_ArticleHeader(false);</code>
 +
| Bestimmt ob der Artikeltitel in der Homeansicht angezeigt werden soll oder nicht
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_H_ShowAll(false);</code>
 +
| Bestimmt ob alle Home-Artikel angezeigt werden sollen oder nicht
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_H_ForwardText(true);</code>
 +
| Bestimmt ob der Link auf die Detail-Ansicht des Artikels angezeigt werden soll oder nicht
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_H_ShowText(true);</code>
 +
| Bestimmt ob der Inhalt des Artikels in der Detail-Ansicht angezeigt werden soll oder nicht
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_H_Group('');</code>
 +
| Gibt an aus welcher Gruppe die Home-Artikel in der Home-Anzeige selektiert werden sollen
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->Write_Home();</code>
 +
| Diese Methode erstellt die Ansicht der Artikel auf Home. Hier dürfen Sie keine Änderungen vornehmen.
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->SetParam_SRCH_ResultPage('');</code>
 +
| Definiert auf welcher Seite die Suchresultate angezeigt werden sollen
 +
| &nbsp;
 +
 +
|-
 +
| <code>[php, N]$GLOBALS["DynPG"]->Write_ArticleSearch();</code>
 +
| Diese Methode erstellt das Suchformular. Hier dürfen Sie keine Änderungen vornehmen.
 
| &nbsp;
 
| &nbsp;
  

Version vom 15. Januar 2010, 21:45 Uhr

Dieser Artikel ist möglicherweise nicht auf einem aktuellen Stand. Aktualisieren Sie ihn, wenn Sie können!


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

Funktionen für die Artikel-Detailansicht
Funktion
Beschreibung
Parameter 
$GLOBALS["DynPG"]->SetParam_A_Article(Artikel_Nr);
 Setzt einen Artikel, der mit $GLOBALS["DynPG"]->Write_Article() dann ausgegeben werden kann. Artikel_Nr = "Nummer des Artikels" (sichtbar im Backend!) 


$GLOBALS["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) 


$GLOBALS["DynPG"]->Write_Article();
 Zeigt den aktuellen ( z.b. den mit $GLOBALS["DynPG"]->SetParam_A_Article(x) gesetzten) Artikel an. keine Parameter 
$GLOBALS["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.   
$GLOBALS["DynPG"]->SetParam_A_CategoryNavigation(false);
 Dadurch wird gesteuert ob die Artikelnavigation (Breadcrumb) in der Detailansicht angezeigt werden soll oder nicht.   
$GLOBALS["DynPG"]->SetParam_A_PrintNavigation(false);
 Dadurch wird gesteuert ob der Printknopf in der Detailansicht angezeigt werden soll oder nicht.   
$GLOBALS["DynPG"]->SetParam_A_LinkNavigation(true);
 Dadurch wird gesteuert ob der Linkknopf in der Detailansicht angezeigt werden soll oder nicht.   
$GLOBALS["DynPG"]->SetParam_A_RecommendNavigation(true);
 Dadurch wird gesteuert ob der Weiterempfehlenknopf in der Detailansicht angezeigt werden soll oder nicht.   
$GLOBALS["DynPG"]->SetParam_A_PdfNavigation(true);
 Dadurch wird gesteuert ob der Pdfknopf in der Detailansicht angezeigt werden soll oder nicht.   
$GLOBALS["DynPG"]->SetParam_A_ArticleHeader(false);
 Dadurch wird gesteuert ob der Artikeltitel in der Detailansicht angezeigt werden soll oder nicht.   
$GLOBALS["DynPG"]->SetParam_A_fullLoadText(true);
 Dadurch wird bestimmt ob Textreplacements auf das Lead und Inhaltsfeld der Artikel innerhalb der Details ausgeführt werden oder nicht. Das wird dann wichtig, wenn gewisse Artikel Inhalte auf einer Seite mehrmals angezeigt werden sollen, aber nur an einer Stelle der gesamte Inhalt und dadurch auch seine Funktionen/Plugins etc. ausgeführt werden muss. Zum Beispiel das Snippet welches mir den Seiten-Titel einer Forum-Seite generiert, muss mir nur den Inhalt des Titels zurückgeben. Wäre dabei dieser Parameter auf TRUE gesetzt, würden sämtliche Forum-Funktionen bereits in diesem Snippet abgehandelt und danach ein zweites mal im eigentlichen Inhalts Snippet!   
$GLOBALS["DynPG"]->SetParam_A_ShowText(true);
 Bestimmt ob der Artikel Inhalt angezeigt wird oder nicht   
$GLOBALS["DynPG"]->SetParam_A_IgnoreLimitation(true);
 Steuert das ignorieren der Limitierung und schaltet diese dadurch aus   
$GLOBALS["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.   
$GLOBALS["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.  


Funktionen für die Artikellistenansicht
Funktion
Beschreibung
Parameter 
$GLOBALS["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).   
$GLOBALS["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.   
$GLOBALS["DynPG"]->Write_AllArticles();
 Diese Methode erstellt die Artikel-Liste. Hier dürfen Sie keine Änderungen vornehmen.   
$GLOBALS["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.   
$GLOBALS["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.   
$GLOBALS["DynPG"]->SetParam_AA_ExcludeArticles(array());
 Wenn Sie einzelne Artikel nicht in der Liste anzeigen wollen, benutzen Sie diese Methode. Geben Sie die Nummern der Artikel an, welche nicht angezeigt werden sollen.   
$GLOBALS["DynPG"]->SetParam_AA_IncludeArticles(array());
 Wenn Sie einzelne Artikel in der Liste anzeigen wollen, benutzen Sie diese Methode. Geben Sie die Nummern der Artikel an, welche angezeigt werden sollen.   
$GLOBALS["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.   
$GLOBALS["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.   
$GLOBALS["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.   
$GLOBALS["DynPG"]->SetParam_AA_Order( Array('INDEX') );
 Mit dieser Methode stellen Sie die Sortierreihenfolgen für Artikellisten um. Möglich sind folgende Angaben: 'TITLE', 'LEAD', 'DATE_TO', 'DATE_FROM', 'TIME_TO', 'TIME_FROM', 'DATE', 'FIXPOINT', 'SHOWVISITS', 'SHOWDATE', 'SEARCHKEYS', 'INDEX', 'ID', 'VISITS', 'OWNER', 'MODIFIER'. Des Weiiteren ist es möglich, nach mehreren Attributen zu sortieren. Hierzu geben Sie die entsprechenden Attribute Komma-Separiert an: $GLOBALS["DynPG"]->SetParam_AA_Order( Array('INDEX', 'ID') );   
$GLOBALS["DynPG"]->SetParam_AA_Sort( Array('ASC') );
     
$GLOBALS["DynPG"]->SetParam_AA_ForceNav(false);
     
$GLOBALS["DynPG"]->SetParam_AA_seperateHome(true);
 Flag "Auf Home-Ansicht anzeigen" auslesen und danach selektieren   
$GLOBALS["DynPG"]->SetParam_AA_CategoryNavigation(false);
 Hiermit wird bestimmt ob die Artikellisten Navigation (Breadcrump) angzeigt werden soll oder nicht   
$GLOBALS["DynPG"]->SetParam_AA_PrintNavigation(false);
 Hiermit wird bestimmt ob die Artikelliste mit einem Printknopf versehen werden soll oder nicht   
$GLOBALS["DynPG"]->SetParam_AA_SingleCss(0);
 Dadurch kann ein eigenes/spezielles css für die Artikellisten gesetzt werden   
$GLOBALS["DynPG"]->SetParam_AA_IgnoreSeperator(true);
 Steuert das ignorieren des Seperator Elements innerhalb der Artikellisten-Inhalte   
$GLOBALS["DynPG"]->SetParam_AA_fullLoadText(false);
 Dadurch wird bestimmt ob Textreplacements auf das Lead und Inhaltsfeld der Artikel innerhalb der Listen ausgeführt werden oder nicht. Das wird dann wichtig, wenn gewisse Artikel Inhalte auf einer Seite mehrmals angezeigt werden sollen, aber nur an einer Stelle der gesamte Inhalt und dadurch auch seine Funktionen/Plugins etc. ausgeführt werden muss. Zum Beispiel das Snippet welches mir den Seiten-Titel einer Forum-Seite generiert, muss mir nur den Inhalt des Titels zurückgeben. Wäre dabei dieser Parameter auf TRUE gesetzt, würden sämtliche Forum-Funktionen bereits in diesem Snippet abgehandelt und danach ein zweites mal im eigentlichen Inhalts Snippet!   
$GLOBALS["DynPG"]->SetParam_AA_Associations(array());
   
$GLOBALS["DynPG"]->SetParam_AA_IgnoreLimitation(true);
 Steuert das ignorieren der Limitierung und schaltet diese dadurch aus   
$GLOBALS["DynPG"]->SetParam_AA_HitlistTimeSpan(0);
 Setzt die Tage über welche eine Hitliste generiert wird. Nur relevant wenn nach VISITS sortiert wurde bei SetParam_AA_Order()   
$GLOBALS["DynPG"]->SetParam_AA_TextGrouping(false);
  


Funktionen für die Gruppenlistenansicht
Funktion
Beschreibung
Parameter 
$GLOBALS["DynPG"]->Write_AllGroups();
 Diese Methode erstellt die Gruppen-Liste. Hier dürfen Sie keine Änderungen vornehmen.   
$GLOBALS["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.   
$GLOBALS["DynPG"]->SetParam_AG_ForceNav(false);
     
$GLOBALS["DynPG"]->SetParam_AG_Anytime(true);
     
$GLOBALS["DynPG"]->SetParam_AG_Order( Array('INDEX') );
 Mit dieser Methode stellen Sie die Sortierreihenfolgen für Gruppenlisten um. Des Weiteren ist es möglich, nach mehreren Attributen zu sortieren. Hierzu geben Sie die entsprechenden Attribute Komma-Separiert an: $GLOBALS["DynPG"]->SetParam_AG_Order( Array('INDEX', 'ID') );   
$GLOBALS["DynPG"]->SetParam_AG_Sort( Array('ASC') );
     
$GLOBALS["DynPG"]->SetParam_UseCategory('Meine Artikel');
 Einschränken der Gruppenliste auf einzelne Unterkategorien  


Weitere Funktionen
Funktion
Beschreibung
Parameter 
$GLOBALS["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.   
$GLOBALS["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.   
$GLOBALS["DynPG"]->Write_RandomArticlePool();
 Diese Methode erstellt die Ansicht eines Zufallartikels. Hier dürfen Sie keine Änderungen vornehmen.   
$GLOBALS["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.   
$GLOBALS["DynPG"]->SetParam_H_Anytime(false);
   
$GLOBALS["DynPG"]->SetParam_H_ArticleHeader(false);
 Bestimmt ob der Artikeltitel in der Homeansicht angezeigt werden soll oder nicht   
$GLOBALS["DynPG"]->SetParam_H_ShowAll(false);
 Bestimmt ob alle Home-Artikel angezeigt werden sollen oder nicht   
$GLOBALS["DynPG"]->SetParam_H_ForwardText(true);
 Bestimmt ob der Link auf die Detail-Ansicht des Artikels angezeigt werden soll oder nicht   
$GLOBALS["DynPG"]->SetParam_H_ShowText(true);
 Bestimmt ob der Inhalt des Artikels in der Detail-Ansicht angezeigt werden soll oder nicht   
$GLOBALS["DynPG"]->SetParam_H_Group('');
 Gibt an aus welcher Gruppe die Home-Artikel in der Home-Anzeige selektiert werden sollen   
$GLOBALS["DynPG"]->Write_Home();
 Diese Methode erstellt die Ansicht der Artikel auf Home. Hier dürfen Sie keine Änderungen vornehmen.   
$GLOBALS["DynPG"]->SetParam_SRCH_ResultPage('');
 Definiert auf welcher Seite die Suchresultate angezeigt werden sollen   
$GLOBALS["DynPG"]->Write_ArticleSearch();
 Diese Methode erstellt das Suchformular. Hier dürfen Sie keine Änderungen vornehmen.   
$GLOBALS["DynPG"]->setupTemplate('default');
    
Von „http://wiki-de.dynpg.org/wiki_de/index.php?title=Funktionsreferenz&oldid=2208“