Funktionsreferenz: Unterschied zwischen den Versionen
Aus DynPG-Wiki
K |
K |
||
| Zeile 2: | Zeile 2: | ||
{{Quicklinks}} | {{Quicklinks}} | ||
| − | Eine Übersicht über die am häufigsten verwendeten DynPG-Funktionen zum Ausrucken finden Sie in der [[Schnellreferenz]]. | + | Hier finden Sie eine Liste aller Funktionen von DynPG. Eine Übersicht über die am häufigsten verwendeten DynPG-Funktionen zum Ausrucken finden Sie in der [[Schnellreferenz]]. |
== Allgemeine DynPG Funktionen == | == Allgemeine DynPG Funktionen == | ||
Version vom 31. Oktober 2010, 14:48 Uhr
Quicklinks
| DynPG Anwenden | DynPG Integrieren | |||||||
| Erste Schritte | Überblick | Backend | Module | Webseiten erstellen | Beispiele | Tutorials | Referenzen Globals |
Inhaltsregister |
Hier finden Sie eine Liste aller Funktionen von DynPG. Eine Übersicht über die am häufigsten verwendeten DynPG-Funktionen zum Ausrucken finden Sie in der Schnellreferenz.
Inhaltsverzeichnis
Allgemeine DynPG Funktionen
| |
|
|
|---|---|---|
$GLOBALS["DynPG"]->loadSavedParams(); |
Lädt die durch saveCurrentParams() vorher gespeicherten Parameter aus dem Zwischenspeicher. | |
$GLOBALS["DynPG"]->saveCurrentParams(); |
Speichert alle DynPG Parameter in einem Zwischenspeicher. Verwenden Sie diese Funktion, um Änderungen an Parametern durch vorheriges Zwischenspeichern und anschließendes Laden des vorherigen Zustands wieder rückgängig zu machen. | |
$GLOBALS["DynPG"]->SetParam_PathToNextPage(Seite); |
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 Seite der Artikel bei Klick auf den Link angezeigt werden soll. Ohne diese Methode wird die Ansicht in der selben Seite angezeigt. | Seite kann durch einen beliebigen Pfad zu einer anderen PHP-Datei ersetzt werden |
$GLOBALS["DynPG"]->SetParam_PathToRoot(Pfad); |
Setzt den Pfad zum Hauptverzeichnis von DynPG (in der sich auch die Datei getcontent.php befindet). | Pfad ist der relative Pfad zum DynPG Verzeichnis |
$GLOBALS["DynPG"]->SetParam_PlugIn_Language(Plugin, Sprachkuerzel); |
Setzt die Sprache eines Plugin. Dadurch wird die entsprechende Sprachdatei aus dem language/ Ordner des Plugin Verzeichnisses geladen und das Frontend des Plugins in der entsprechenden Sprache angezeigt. Das Kürzel entspricht immer dem Anfang des Dateinamens der jeweiligen Datei in diesem Ordner. | Plugin ist der String-Bezeichner des Plugins (z.B. 'DPGdynmenu' für das dynamische Menü)
Sprachkuerzel ist ein String der die zu verwendende Sprache festlegt. Standardmäßig werden 'de' (Deutsch), 'en' (Englisch) und 'es' (Spanisch) unterstützt. |
$GLOBALS["DynPG"]->SetParam_PlugIn_Param(Plugin, Parameter, Wert); |
Setzt den Parameter eines Plugins auf einen bestimmten Wert | Plugin ist der String-Bezeichner des Plugins (z.B. 'DPGdynmenu' für das dynamische Menü)
Parameter ist der String-Bezeichner des Parameters Wert ist der Wert des Parameters |
$GLOBALS["DynPG"]->SetParam_PlugIn_Template(Plugin, Template); |
Setzt das für ein bestimmtes Plugin zu verwendende Template | Plugin ist der String-Bezeichner des Plugins (z.B. 'DPGdynmenu' für das dynamische Menü)
Template ist der String-Bezeichner des Templates |
$GLOBALS["DynPG"]->SetParam_SRCH_ResultPage(Seite); |
Definiert auf welcher Seite die Suchresultate angezeigt werden sollen | Seite ist ein beliebiger Pfad zu einer PHP-Datei |
$GLOBALS["DynPG"]->setupLanguage(Sprachkuerzel); |
Setzt die Sprache der Webseite. Dadurch wird die entsprechende Sprachdatei aus dem localised/ Ordner des DynPG Verzeichnisses geladen und das Frontend in der entsprechenden Sprache angezeigt. Das Kürzel entspricht immer dem Anfang des Dateinamens der jeweiligen Datei in diesem Ordner. | Sprachkuerzel ist ein String der die zu verwendende Sprache festlegt. Standardmäßig werden 'de' (Deutsch), 'en' (Englisch) und 'es' (Spanisch) unterstützt. |
$GLOBALS["DynPG"]->setupTemplate(Template); |
Setzt das aktuell verwendete Template. Der Name des Standard-Templates ist 'default'. Dieses Template sollte jedesmal gesetzt werden, nach dem einige vorherige Änderung des Templates nicht mehr gebraucht wird. | Template ist der Name des Templates als String |
$GLOBALS["DynPG"]->Write_AllArticles(); |
Diese Methode erstellt die Artikel-Liste. | |
$GLOBALS["DynPG"]->Write_AllGroups(); |
Diese Methode erstellt die Gruppen-Liste. | |
$GLOBALS["DynPG"]->Write_Article(); |
Zeigt den aktuell gesetzten Artikel an. | |
$GLOBALS["DynPG"]->Write_ArticleSearch(); |
Diese Methode erstellt das Suchformular. | |
$GLOBALS["DynPG"]->Write_Guestbook(); |
Gibt das Gästebuch aus | |
$GLOBALS["DynPG"]->Write_Vote(ID); |
Gibt das Voting mit einer bestimmten ID aus | ID ist die ID des Votings |
Gruppenlistenansicht
| |
|
|
|---|---|---|
$GLOBALS["DynPG"]->SetParam_AG_Anytime(Anzeige); |
Bestimmt wann die Gruppenliste angezeigt wird (immer oder wenn durch Navigationskontext vorgegeben) | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AG_ForceNav(Anzeige); |
Bestimt ob die Navigation angezeigt werden soll | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AG_Maxview(Max); |
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. | Max bestimmt die maximale Anzahl von Artikeln pro Seite in der Artikelliste |
$GLOBALS["DynPG"]->SetParam_AG_Order( array(Index) ); |
Mit dieser Methode stellen Sie die Sortierreihenfolgen für Gruppenlisten um. Sie können hier mehrere Attribute angeben (z.B. $GLOBALS["DynPG"]->SetParam_AG_Order( Array('Index', 'ID') ); | Index = 'TITLE', 'LEAD', 'DATE_TO', 'DATE_FROM', 'TIME_TO', 'TIME_FROM', 'DATE', 'FIXPOINT', 'SHOWVISITS', 'SHOWDATE', 'SEARCHKEYS', 'INDEX', 'ID', 'VISITS', 'OWNER' oder 'MODIFIER' |
$GLOBALS["DynPG"]->SetParam_AG_Sort( array(Sortierung) ); |
Bestimmt, wie die Gruppenliste sortiert wird | Sortierung = 'ASC' aufsteigend oder 'DESC' absteigend |
$GLOBALS["DynPG"]->SetParam_UseCategory(Bezeichner, Art); |
Schränkt die Gruppenliste auf eine einzige Gruppe ein. | Bezeichner ist entweder die ID, oder der Name der Gruppe jeweils als String
Art ist die Art des Bezeichners. true bedeutet der Bezeichner ist der Name und false bedeutet, es handelt sich um die ID |
$GLOBALS["DynPG"]->Write_AllGroups(); |
Diese Methode erstellt die Gruppen-Liste. | |
Artikellistenansicht
| |
|
|
|---|---|---|
$GLOBALS["DynPG"]->SetParam_AA_Anytime(Anzeige); |
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 gelangt). | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AA_ArticleCss(Suffix); |
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 Suffix hinten angehängt (z.B Klasse TR.DynPG_General_tbl_A_Main_ wird zu TR.DynPG_General_tbl_A_Main_suffix). | Suffix kann durch einen beliebigen String ersetzt werden, welcher dann dem CSS-Klassennamen angehängt wird |
$GLOBALS["DynPG"]->SetParam_AA_Associations(array(Namen)); |
Zeigt alle Assoziationen mit den angebenenen Namen an | Namen ist eine Liste von Strings, die den Namen von vorhandenen Assoziationen entsprechen |
$GLOBALS["DynPG"]->SetParam_AA_CategoryNavigation(Anzeige); |
Hiermit wird bestimmt ob die Artikellisten Navigation (Breadcrumb) angzeigt werden soll oder nicht | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AA_ExcludeArticles(array(Ausschliessen)); |
Verwenden Sie diese Methode um einzelne Artikel nicht in der Liste anzuzeigen. | Ausschliessen kann durch eine komma-separierte Folge von Gruppen-IDs ersetzt werden, wodurch die entsprechenden Gruppen ausgeblendet werden |
$GLOBALS["DynPG"]->SetParam_AA_Group(Gruppenname); |
Geben Sie hier den Namen der Gruppe an, von der Sie eine Artikel-Listenansicht angezeigt haben wollen. | Gruppenname kann durch einen beliebigen Gruppennamen ersetzt werden |
| 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. | Einblenden kann durch eine komma-separierte Folge von Gruppen-IDs ersetzt werden, wodurch die entsprechenden Gruppen eingeblendet werden
Ausblenden kann durch eine komma-separierte Folge von Gruppen-IDs ersetzt werden, wodurch die entsprechenden Gruppen ausgeblendet werden | |
$GLOBALS["DynPG"]->SetParam_AA_ForceNav(Anzeige); |
Bestimt ob die Navigation angezeigt werden soll | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AA_ForwardText(Text); |
Bestimmt den Text, der bei einem Link zur Detailansicht eines Artikels angezeigt wird | Text ist ein beliebiger String |
$GLOBALS["DynPG"]->SetParam_AA_fullLoadText(Laden); |
Dadurch wird bestimmt ob Text-Replacements auf das Lead und Inhaltsfeld der Artikel innerhalb der Details ausgeführt werden oder nicht. Das ist dann von Interesse, wenn gewisse Artikelinhalte 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 den Seiten-Titel einer Forum-Seite generiert muss 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. | Laden = true der gesamte Inhalt wird geladen oder false es wird nicht der gesamte Inhalt geladen |
$GLOBALS["DynPG"]->SetParam_AA_HitlistTimeSpan(Tage); |
Setzt die Tage über welche eine Hitliste generiert wird. Nur relevant wenn nach 'VISITS' sortiert wurde bei SetParam_AA_Order() | Tage = Tage über die eine Hitliste generiert werden soll |
$GLOBALS["DynPG"]->SetParam_AA_IgnoreLimitation(Ignorieren); |
Steuert das ignorieren der Limitierung und schaltet diese dadurch aus | Ignorieren = true wird ignoriert oder false wird nicht ignoriert |
$GLOBALS["DynPG"]->SetParam_AA_IgnoreSeperator(Ignorieren); |
Steuert das ignorieren des Seperatorelements innerhalb der Artikellisten-Inhalte | Ignorieren = true wird ignoriert oder false wird nicht ignoriert |
$GLOBALS["DynPG"]->SetParam_AA_IncludeArticles(array(Einschliessen)); |
Wenn Sie einzelne Artikel in der Liste Anzeigen wollen, benutzen Sie diese Methode. Geben Sie die Nummern der Artikel an, welche angezeigt werden sollen. | Einschliessen kann durch eine komma-separierte Folge von Gruppen-IDs ersetzt werden, wodurch die entsprechenden Gruppen eingeblendet werden |
$GLOBALS["DynPG"]->SetParam_AA_Maxview(Max); |
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. | Max bestimmt die maximale Anzahl von Artikeln pro Seite in der Artikelliste |
$GLOBALS["DynPG"]->SetParam_AA_OneArticle(ID); |
Verwenden Sie diese Methode wenn Sie nur einen einzigen Artikel in der Liste Anzeigen wollen. Die Methode SetParam_AA_Group("Gruppenname") ist in diesem Falle nicht mehr notwendig. | ID muss durch die ID des Artikels ersetzt werden, welcher eingeblendet werden soll |
$GLOBALS["DynPG"]->SetParam_AA_Order( Array(Index) ); |
Mit dieser Methode stellen Sie die Sortierreihenfolgen für Artikellisten um. Sie können hier eine Liste von Attributen angeben (z.B. $GLOBALS["DynPG"]->SetParam_AA_Order( Array('Index', 'ID')); | Index = 'TITLE', 'LEAD', 'DATE_TO', 'DATE_FROM', 'TIME_TO', 'TIME_FROM', 'DATE', 'FIXPOINT', 'SHOWVISITS', 'SHOWDATE', 'SEARCHKEYS', 'INDEX', 'ID', 'VISITS', 'OWNER' oder 'MODIFIER' |
$GLOBALS["DynPG"]->SetParam_AA_PrintNavigation(Anzeige); |
Hiermit wird bestimmt ob die Artikelliste mit einem Print-Button versehen werden soll oder nicht | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AA_seperateHome(Anzeige); |
Bestimmt, ob der Home-View angezeigt werden soll | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_AA_SingleCss(ID); |
Dadurch kann ein eigenes/spezielles CSS für die Artikellisten gesetzt werden | ID = ID des CSS |
$GLOBALS["DynPG"]->SetParam_AA_Sort( Array(Sortierung) ); |
Bestimmt, wie die Artikel sortiert werden | Sortierung = 'ASC' aufsteigend oder 'DESC' absteigend |
$GLOBALS["DynPG"]->Write_AllArticles(); |
Diese Methode erstellt die Artikel-Liste. | |
Artikel-Detailansicht
| |
|
|
|---|---|---|
$GLOBALS["DynPG"]->SetParam_A_Article(Artikel_Nr); |
Setzt einen Artikel, der dann mit $GLOBALS["DynPG"]->Write_Article() ausgegeben werden kann. | Artikel_Nr ist die ID des Artikels (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"]->SetParam_A_ArticleCss(Suffix); |
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 Suffix hinten angehängt (z.B Klasse TR.DynPG_General_tbl_A_Main_ wird zu TR.DynPG_General_tbl_A_Main_suffix). | Suffix kann durch einen beliebigen String ersetzt werden, welcher dann dem CSS-Klassennamen angehängt wird |
$GLOBALS["DynPG"]->SetParam_A_ArticleHeader(Anzeige); |
Dadurch wird gesteuert ob der Artikeltitel in der Detailansicht angezeigt werden soll oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_A_CategoryNavigation(Anzeige); |
Dadurch wird gesteuert ob die Artikelnavigation (Breadcrumb) in der Detailansicht angezeigt werden soll oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_A_fullLoadText(Laden); |
Dadurch wird bestimmt ob Text-Replacements auf das Lead und Inhaltsfeld der Artikel innerhalb der Details ausgeführt werden oder nicht. Das ist dann von Interesse, wenn gewisse Artikelinhalte 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 den Seiten-Titel einer Forum-Seite generiert muss 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. | Laden = true der gesamte Inhalt wird geladen oder false es wird nicht der gesamte Inhalt geladen |
$GLOBALS["DynPG"]->SetParam_A_IgnoreLimitation(Ignorieren); |
Steuert das Ignorieren der Limitierung und schaltet diese dadurch aus | Ignorieren = true wird ignoriert oder false wird nicht ignoriert. |
$GLOBALS["DynPG"]->SetParam_A_IgnoreSeperator(Ignorieren); |
Falls Sie für den Artikel einen Seperator eingefügt haben, können Sie ihn für diese Ansicht ignorieren. Das heisst der Seperator wird entweder ignoriert und der Artikeltext ganz normal angezeigt (Standard), oder er wird berücksichtigt und der Artikeltext an dieser Stelle unterbrochen. In diesem Fall wird ein Link angezeigt, mit dem man durch einen Klick zum gesamten Text gelangt. | Ignorieren = true wird ignoriert oder false wird nicht ignoriert. |
$GLOBALS["DynPG"]->SetParam_A_LinkNavigation(Anzeige); |
Dadurch wird gesteuert ob der Link-Button in der Detailansicht angezeigt werden soll oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt. |
$GLOBALS["DynPG"]->SetParam_A_FacebookNavigation(Anzeige); |
Hierdurch wird festgelegt, ob ein Link zum Facebook Netzwerk erstellt werden soll. | Anzeige = true wird angezeigt oder false wird nicht angezeigt. |
$GLOBALS["DynPG"]->SetParam_A_PdfNavigation(Anzeige); |
Dadurch wird gesteuert ob der Pdf-Button in der Detailansicht angezeigt werden soll oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt. |
$GLOBALS["DynPG"]->SetParam_A_PrintNavigation(Anzeige); |
Dadurch wird gesteuert ob der Print-Button in der Detailansicht angezeigt werden soll oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_A_RecommendNavigation(Anzeige); |
Dadurch wird gesteuert ob der Weiterempfehlen-Button in der Detailansicht angezeigt werden soll oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt. |
$GLOBALS["DynPG"]->SetParam_A_ShowText(Anzeige); |
Bestimmt ob der Artikelinhalt angezeigt wird oder nicht. | Anzeige = true wird angezeigt oder false wird nicht angezeigt. |
$GLOBALS["DynPG"]->SetParam_A_TwitterNavigation(Anzeige, tinyURL); |
Hierdurch wird festgelegt, ob ein Link zu Twitter erstellt werden soll. | Anzeige = true wird angezeigt oder false wird nicht angezeigt.
tinyURL = true es wird eine kurze URL erzeugt oder false es wird keine kurze URL erzeugt. |
$GLOBALS["DynPG"]->Write_Article(); |
Zeigt den aktuellen ( z.b. den mit $GLOBALS["DynPG"]->SetParam_A_Article(ID) gesetzten) Artikel an. | |
Home-View
| |
|
|
|---|---|---|
$GLOBALS["DynPG"]->SetParam_H_Anytime(Anzeige); |
Bestimmt, ob der Home-View immer angezeigt werden soll | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_H_ArticleHeader(Anzeige); |
Bestimmt ob der Artikeltitel in der Homeansicht angezeigt werden soll oder nicht | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_H_ForwardText(Anzeige); |
Bestimmt ob der Link auf die Detail-Ansicht des Artikels angezeigt werden soll oder nicht | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_H_Group(Gruppenname); |
Gibt an aus welcher Gruppe die Home-Artikel in der Home-Anzeige selektiert werden sollen | Gruppenname ist der Name der Gruppe als String |
$GLOBALS["DynPG"]->SetParam_H_ShowAll(Anzeige); |
Bestimmt ob alle Home-Artikel angezeigt werden sollen oder nicht | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->SetParam_H_ShowText(Anzeige); |
Bestimmt ob der Inhalt des Artikels in der Detail-Ansicht angezeigt werden soll oder nicht | Anzeige = true wird angezeigt oder false wird nicht angezeigt |
$GLOBALS["DynPG"]->Write_Home(); |
Diese Methode erstellt die Ansicht der Artikel auf Home. | |
Zufällige Artikel
| |
|
|
|---|---|---|
$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. | |
$GLOBALS["DynPG"]->SetParam_POOL_Add( Array(Artikel) ); |
Geben Sie hier die Artikelnummern an, aus welchen nach Zufallsprinzip einer ausgewählt und angezeigt werden soll. Möchten Sie einen Zufallsartikel aus allen Artikeln erstellen so lassen Sie diese Zeile einfach weg. | Artikel durch Kommas separierte Liste von Artikel-IDs |
$GLOBALS["DynPG"]->SetParam_POOL_Show(Show); |
Geben Sie hier an, ob der Seperator bei einem Zufallsartikel beachtet werden soll | Show = 1 steht für Ja, 0 steht für Nein |
$GLOBALS["DynPG"]->Write_RandomArticlePool(); |
Diese Methode erstellt die Ansicht eines Zufallartikels. | |
