Funktionsreferenz

Aus DynPG-Wiki
Wechseln zu: Navigation, Suche
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 = "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"]->Write_Article();
Zeigt den aktuellen ( z.b. den mit $GLOBALS["DynPG"]->SetParam_A_Article(x) gesetzten) Artikel an.
-
$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_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_PrintNavigation(ANZEIGE);
Dadurch wird gesteuert ob der Printknopf in der Detailansicht angezeigt werden soll oder nicht. ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$GLOBALS["DynPG"]->SetParam_A_LinkNavigation(ANZEIGE);
Dadurch wird gesteuert ob der Linkknopf 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 Weiterempfehlenknopf in der Detailansicht angezeigt werden soll oder nicht. ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$GLOBALS["DynPG"]->SetParam_A_PdfNavigation(ANZEIGE);
Dadurch wird gesteuert ob der Pdfknopf in der Detailansicht angezeigt werden soll oder nicht. ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$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_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_ShowText(ANZEIGE);
Bestimmt ob der Artikel Inhalt angezeigt wird oder nicht ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$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 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. IGNORIEREN = true wird ignoriert oder false wird nicht ignoriert
$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. 'next.php' kann durch einen beliebigen Pfad zu einer anderen PHP-Datei ersetzt werden


Funktionen für die Artikellistenansicht
Funktion
Beschreibung
Parameter
$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 gelangen). ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$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. "News" kann durch einen beliebigen Gruppennamen ersetzt werden
$GLOBALS["DynPG"]->Write_AllArticles();
Diese Methode erstellt die Artikel-Liste.
-
$GLOBALS["DynPG"]->SetParam_AA_Groups(array(EINBLENDEN), array(AUSBLENDEN));
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. 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_OneArticle(ID);
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. ID muss durch die ID des Artikels ersetzt werden, welcher eingeblendet werden soll
$GLOBALS["DynPG"]->SetParam_AA_ExcludeArticles(array(AUSSCHLIESSEN));
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. AUSSCHLIESSEN

AUSBLENDEN kann durch eine komma-separierte Folge von Gruppen-IDs ersetzt werden, wodurch die entsprechenden Gruppen ausgeblendet werden

$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_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_POOL_Show(ID);
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. ID ist die ID der Gruppe, aus der die Zufallsartikel angezeigt werden
$GLOBALS["DynPG"]->SetParam_AA_Order( Array(INDEX) );
Mit dieser Methode stellen Sie die Sortierreihenfolgen für Artikellisten um. 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') ); INDEX = 'TITLE', 'LEAD', 'DATE_TO', 'DATE_FROM', 'TIME_TO', 'TIME_FROM', 'DATE', 'FIXPOINT', 'SHOWVISITS', 'SHOWDATE', 'SEARCHKEYS', 'INDEX', 'ID', 'VISITS', 'OWNER', 'MODIFIER'
$GLOBALS["DynPG"]->SetParam_AA_Sort( Array(SORTIERUNG) );
Bestimmt, wie die Artikel sortiert werden SORTIERUNG = 'ASC' aufsteigen oder 'DESC' absteigend
$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_seperateHome(ANZEIGE);
Bestimmt, ob der Home-View angezeigt werden soll ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$GLOBALS["DynPG"]->SetParam_AA_CategoryNavigation(ANZEIGE);
Hiermit wird bestimmt ob die Artikellisten Navigation (Breadcrump) angzeigt werden soll oder nicht ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$GLOBALS["DynPG"]->SetParam_AA_PrintNavigation(ANZEIGE);
Hiermit wird bestimmt ob die Artikelliste mit einem Printknopf versehen werden soll oder nicht 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_IgnoreSeperator(IGNORIEREN);
Steuert das ignorieren des Seperator Elements innerhalb der Artikellisten-Inhalte IGNORIEREN = true wird ignoriert oder false wird nicht ignoriert
$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_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_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_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_TextGrouping(GRUPPIEREN);
Legt fest, ob die Artikel beim Abfragen der Datenbank gruppiert werden sollen TRUE = true Artikel werden gruppiert oder false Artikel werden nicht gruppiert


Funktionen für die Gruppenlistenansicht
Funktion
Beschreibung
Parameter
$GLOBALS["DynPG"]->Write_AllGroups();
Diese Methode erstellt die Gruppen-Liste.
-
$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_ForceNav(ANZEIGE);
Bestimt ob die Navigation angezeigt werden soll ANZEIGE = true wird angezeigt oder false wird nicht angezeigt
$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_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') ); INDEX = 'TITLE', 'LEAD', 'DATE_TO', 'DATE_FROM', 'TIME_TO', 'TIME_FROM', 'DATE', 'FIXPOINT', 'SHOWVISITS', 'SHOWDATE', 'SEARCHKEYS', 'INDEX', 'ID', 'VISITS', 'OWNER', 'MODIFIER'
$GLOBALS["DynPG"]->SetParam_AG_Sort( Array('ASC') );
Bestimmt, wie die Gruppenliste sortiert wird SORTIERUNG = 'ASC' aufsteigen oder 'DESC' absteigend
$GLOBALS["DynPG"]->SetParam_UseCategory(KATEGORIENAME);
Einschränken der Gruppenliste auf einzelne Unterkategorien KATEGORIENAME = Name der Gruppe als String


Weitere Funktionen
Funktion
Beschreibung
Parameter
$GLOBALS["DynPG"]->SetParam_POOL_Add( Array(ARTIKEL) );
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. 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.
-
$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.
-
$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_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_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_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"]->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"]->Write_Home();
Diese Methode erstellt die Ansicht der Artikel auf Home.
-
$GLOBALS["DynPG"]->SetParam_SRCH_ResultPage('');
Definiert auf welcher Seite die Suchresultate angezeigt werden sollen
-
$GLOBALS["DynPG"]->Write_ArticleSearch();
Diese Methode erstellt das Suchformular.
-
$GLOBALS["DynPG"]->setupTemplate(TEMPLATE);
Setzt das aktuell verwendete Template. Der Name des Standard-Tempaltes 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