Benutzerfunktionen

Die Benutzerfunktionen ermöglichen Ihnen die entsprechenden Seiten-Elemente des yappadoo-CMS auszugeben. Mit einem Aufruf dieser Funktionen werden fertig html-formatierte Seitenelemente in den Quelltext Ihrer Seite ausgegeben (z.B. das Navigationsmenü) oder es werden Werte aus dem System abgerufen (z.B. Homepage-URL). Auch die Notwendigkeit zur Anzeige bestimmter Elemente wird mit diesen Funktionen abgefragt (z.B. Anzeige des Adminmenüs).

Nach dem Import der Datei "yappadoo.php" stehen diese Funktionen global zur Verfügung. Die Funktionsnamen beginnen alle mit dem Prefix "yap_".

Je nach dem Verhalten der Funktionen folgt danach im Funktionenamen entweder "_render" oder "_get" oder "_has".

NameTypBedeutungDatei
_renderAusgabe (Layout)Die Funktion gibt formatiertes HTML an der "Stelle des Funktionsaufrufs" ausetc/dynamics.php
_getRückgabeDie Funktion schreibt einen unformatierten Wert in die Ausgabelib/user_functions.php
_hasTestDer Rückgabewert der Funktion ist "true" oder "false"lib/user_functions.php

Die "_render"-Funktionen greifen selbst auf die "_get"- und "_has"-Funktionen aus der Datei "lib/user_functions.php" zurück. In den "_get"- und "_has"-Funktionen wird keinerlei (HTML-) Formatierung vorgenommen.
In den "render"-Funktionen aus der Datei "etc/dynamics.php" wird also das Layout der einzelnen System-Elemente (z.B. Navigationsmenüs) bestimmt und kann hier auch angepasst werden.

Tabellarische Übersicht

Neben dieser tabellarischen Kurzübersicht finden Sie weiter unten in diesem Dokument ausführlichere Informationen zu den einzelnen Funktionen (Absätze "...auf einen Blick").

Die Ausgabefunktionen geben das entsprechende Element in den HTML-Code der aufrufenden Seite. Ist das entsprechende Element auf der aktuellen Seite nicht vorhanden, wird nichts ausgegeben. Ob ein Element auf der aktuellen Seite vorhanden ist, kann mit den zugehörigen _has-Testfunktionen geprüft werden.

Name der Ausgabefunktion_has-Fkt.Ausgabe
yap_renderContent()Seiteninhalt
yap_renderWarnings()Warnungen
yap_renderErrors()Fehlermeldungen
  
yap_renderPageStructure()Navigationsmenü (komplett)
yap_renderPrimaryMenu()xNav-Hauptmenü (horiz.Teil)
yap_renderSecondaryMenu()xNav-Untermenü (vert.Teil)
yap_renderPageStructurePath()xBrotkrumennav.
yap_renderSecondaryMenuTitle()xName/Link des Hauptmenüpkt. für Untermenü
  
yap_renderPageFlatNav() Menü einer linearen Seitennavigation
yap_renderNextPageLink(), yap_renderBeforePageLink() Link zu nächster bzw. vorhergehender Seite (lineare Navigation)
yap_renderTopPageLink() Link zurück zum oberen Bereich der Seite
  
yap_renderAdminMenu()xAdminmenü (vert.)
yap_renderAdminMenu_quick()xKurz-Adminmenü (horiz.)
  
yap_renderUserAccountLinks()xAccountlinks (komplett)
yap_renderUserLoginLink()xAnmelden-Link
yap_renderUserLogoutLink()xAbmelden-Link
yap_renderUserRegisterLink()xNeuanmelden-Link
yap_renderUserLoginForm()xAnmelden-Formular
  
yap_renderTitle()xSeitenüberschrift
yap_renderPrintLink()Ausdrucken-Link
yap_renderFootLine()Fußzeile
yap_renderSearchForm()Suchformular
  
yap_recursivePathRenderer(&$nodeArray)intern
yap_recursiveNaviRenderer(&$nodeArray)intern

Die Rückgabefunktionen geben unformatierte Zeichenketten (oder Objekte) zurück. Die Rückgabewerte dieser Funktionen können zur Nutzung im eigenen Code genutztwerden. Diese Funktionen korrespondieren teilweise mit den entsprechenden render-Funktionen.

Name der RückgabefunktionRückgabe
yap_getBrowserTitle()Titel für Browserfenster
yap_getProjectName()Name der (gesamten) Webseite
yap_getTitle()Seitenüberschrift
yap_getHomepageURL()URL des Home-Link
yap_getOpenPrimaryMenuNode()Node-Objekt des aktuell geöffneten Hauptmenüpunktes
yap_getOpenSecondaryMenuNode()Node-Objekt des aktuell geöffneten Untermenüpunktes

Die Testfunktionen geben true oder false zurück. Mit diesen Funktionen kann die Ausgabe eines Elements auf der aktuellen Seite geprüft werden. Diese Funktionen korrespondieren mit den entsprechenden render-Funktionen.

Name der TestfunktionTestet auf Ausgabemöglichkeit
yap_hasOpenPrimaryMenuNode()Hauptmenüpunkt geöffnet?
yap_hasOpenSecondaryMenuNode()Untermenüpunkt geöffnet?
yap_hasPageStructurePath()Brotkrumennavigation
 
yap_hasTitle()Seitenüberschrift
yap_hasAdminMenu()Administrationsmenü
 
yap_hasUserLoginForm()Anmeldeformular
yap_hasUserLoginLink()Anmeldelink
yap_hasUserLogoutLink()Abmeldelink
yap_hasUserRegisterLink()Neuanmeldungs-Link
yap_hasUserAccountLinks()Benutzeraccount-Links

Die render-Funktionen auf einen Blick

Die folgenden Funktionen geben die entsprechenden Elemente(Inhalte) direkt beim Aufruf in den Quelltext der aufrufenden Seite aus. Da nicht immer alle Elemente auf der Seite erscheinen (z.B. Adminmenü), geben diese Funktionen nicht immer etwas zurück. Ob ein entsprechendes Element auf der Seite erscheint, kann mit der korrespondierenden "has"-Funktion geprüft werden.


Contentbereich

yap_renderContent()

Gibt den eigentlichen Seiteninhalt aus. Dies können selbst hinterlegte Inhalte sein, als auch systeminterne Seiteninhalte (Anmeldeformular, Meldungen etc.).
Normalerweise werden die Seitenüberschrift yap_renderTitle() und Fehler- und Warnmeldungenyap_renderErrors(), yap_renderWarnings() automatisch innerhalb dieses Bereichs ausgegeben. Sollten Sie diese Elemente gesondert ausgeben wollen, rufen Sie die Funktion folgendermaßen auf:
yap_renderContent(false)
Verwendet Styles : Die Formatierung des Inhaltes erfolgt mittels zahlreicher CSS-Classes

yap_renderTitle()

Gibt die aktuelle Überschrift einer Seite aus.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasTitle())
Verwendet Styles : yap_title

yap_renderWarnings()

Gibt Warnungen des Systems aus.
Verwendet Styles : .yap_error

yap_renderErrors()

Gibt evtl. aufgetretene Fehlermeldungen aus.
Verwendet Styles : .yap_error


Navigationsbereich

Diese Funktionen sind abhängig von den Konfigurationseinstellungen:

  • automenu

yap_renderPageStructure()

Navigationsmenü: Gibt das vollständige Navigationsmenü aus. Sollten Sie ein aufgeteiltes Navigationsmenü verwenden wollen, nutzen Sie bitte die Funktionen yap_renderPrimaryMenu() und yap_renderSecondaryMenu()
Die Rückgabe erfolgt immer.
Verwendet Styles : yap_nav_div

yap_renderPrimaryMenu()

Navigationsmenü: Gibt das oberste Ebene der Punkte des Navigationsmenüs aus. Bei einem aufgeteiltem Navigationsmenü sind dies die Menüpunkte des horizontalen Hauptmenüs.
Die Rückgabe erfolgt immer.
Verwendet Styles : yap_navfirst_div | .yap_primary_subopen_li | .yap_primary_subclosed_li | .yap_primary_nosub_li

yap_renderSecondaryMenu()

Navigationsmenü: Gibt das Untermenü des derzeitig geöffneten Hauptmenü-Punktes aus. Bei einem aufgeteiltem Navigationsmenü sind dies die Menüpunkte des vertikalen Untermenüs.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasOpenSecondaryMenuNode())
Verwendet Styles : yap_nav_div | .yap_secondary_subopen_li | .yap_secondary_subclosed_li | .yap_secondary_nosub_li

yap_renderPageStructurePath()

Navigationsmenü: Gibt die Brotkrumen-Navigation aus.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasPageStructurePath())
Verwendet Styles : yap_navbreedcrumb_div

yap_renderSecondaryMenuTitle()

Navigationsmenü: Gibt aus den Namen des derzeitig geöffneten Hauptmenüpunktes (aus der obersten Ebene des Navigationsmenüs) als Link aus.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasOpenPrimaryMenuNode())
Verwendet Styles : yap_navsubtitle_div


Bereich zur linearen Seitennavigation

Die lineare Seitennavigation erfolgt über zwei Schalter:

  • "vorwärts" (weiter - nächste Seite) und
  • "rückwärts" (zurück - vorhergehende Seite)

Mittels diese Schalter unter jeder Seite kann der gesamte Navigationsbaum einfach durchlaufen werden.
Zusätzlich finden Sie in diesem Bereich einen Link, welcher zum oberen Bereich der gerade angezeigten Webseite führt ("nach oben").
Diese Funktionen sind abhängig von den Konfigurationseinstellungen:

  • automenu

yap_renderPageFlatNav()

Gibt das vollständige Menü zur linearen Seitennavigation als HTML-Tabelle aus. Nutzt dabei die Funktionen yap_renderNextPageLink(), yap_renderBeforePageLink() und yap_renderTopPageLink()
Die Rückgabe erfolgt immer.
Verwendet Styles : .yap_navflatnext_a | .yap_navflatbefore_a | .yap_navflattop_a

yap_renderNextPageLink() , yap_renderBeforePageLink()

Gibt den Link auf die nächste bzw. vorhergehende Seite der derzeitig angezeigten Seite für lineare Navigation aus.
Die Rückgabe erfolgt immer.
Verwendet Styles : .yap_navflatnext_a | .yap_navflatbefore_a

yap_renderTopPageLink()

Gibt den Link für einen Sprung auf den oberen Bereich innerhalb der angezeigten Seite aus
Die Rückgabe erfolgt immer.
Verwendet Styles : .yap_navflattop_a


Administrationsmenüs

Diese Funktionen sind abhängig von den Konfigurationseinstellungen:

  • public
  • openmode
  • stealthmode

yap_renderAdminMenu()

Gibt das vertikale (Haupt-)Administrationsmenü aus. Das Administrationsmenü gewährt Zugriff auf alle Funktionen des Systems.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasAdminMenu())
Verwendet Styles : yap_menu_div

yap_renderAdminMenu_quick()

Gibt das horizontale Schnellzugriffs-Administrationsmenü aus. Das Menü gewährt schnellen Zugriff auf die wichtigsten Funktionen.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasAdminMenu())
Verwendet Styles : yap_menuh_div


Benutzeraccountverwaltung

Diese Funktionen sind abhängig von den Konfigurationseinstellungen:

  • public
  • openmode

yap_renderUserAccountLinks()

Gibt alle Links zur Benutzeranmeldung und -Registrierung aus.
Die Rückgabe erfolgt u.U. nicht immer! (s.a. yap_hasUserAccountLinks())
Verwendet Styles : yap_user_register_a | yap_user_login_a | yap_user_logout_a

yap_renderUserLoginForm()

Gibt das Anmeldeformular aus. Die einzelnen Felder werden mehrzeilig ausgegeben. Um das Formular einzeilig ausgeben zu lassen geben rufen Sie die Funktion folgendermaßen auf:
yap_renderLoginForm(false)
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasUserLoginForm(), yap_hasUserAccountLinks())
Verwendet Styles : yap_user_loginform_div

yap_renderUserLoginLink()

Gibt den Link zum Anmeldeformular aus.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasUserLoginLink() | yap_hasUserAccountLinks())
Verwendet Styles : yap_user_login_a

yap_renderUserLogoutLink()

Gibt den Link zum Abmelden aus.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasLogoutLink, yap_hasUserAccountLinks())
Verwendet Styles : yap_user_logout_a

yap_renderUserRegisterLink()

Gibt aus den Link zur Registrierung eines neuen Nutzeraccounts aus.
Die Rückgabe erfolgt nicht immer! (s.a. yap_hasLogoutLink, yap_hasUserAccountLinks())
Verwendet Styles : yap_user_register_a


Weitere Elemente

yap_renderSearchForm()

Gibt das (kleine) Suchformular zur Augabe auf jeder Seite aus. Es kann ein Funktionsparameter mit einer Zeichenkette übergeben werden. Diese Zeichenkette (z.B. "<br/>") wird dann zwischen dem Formularfeld und dem Button ausgegeben:
(yap_renderSearchForm('<br/>').
Die Augabe des Formulars erfolgt standardmäßig einzeilig.
Die Rückgabe erfolgt immer.
Verwendet Styles : yap_searchform_div

yap_renderFootLine($align = "center")

Gibt die Fußzeile mit Informationen zur aktuell angezeigten Seite aus. Mittels dem Parameter "$align" kann die Ausrichtung der Fußzeile erfolgen(left, right, center). Die angezeigten Werte können über die config-Variablen:

  • showlastmod
  • showprocesstime

bestimmt werden.
Verwendet Styles : yap_footline_div

yap_renderPrintLink()

Gibt den Link zum Seitenausdruck aus.
Die Rückgabe erfolgt immer.
Abhängig von der Konfigurationsvariable showprintlink
Verwendet Styles : yap_printlink_a

Interne Funktionen

yap_recursiveNaviRenderer(&$nodeArray)

Diese interne Funktion wird zur Ausgabeerzeugung der Menüunterpunkte im Navigationsmenü rekursiv aufgerufen.

yap_recursivePathRenderer(&$nodeArray)

Diese interne Funktion wird zur Ausgabeerzeugung der Einträge im Brotkrumen-Navigationsmenü rekursiv aufgerufen.

Die get- und has-Funktionen auf einen Blick

Mit diesen Funktionen kann die Existenz eines Elements ("has") auf der aktuellen Seite geprüft werden oder ein Wert aus dem System abgefragt werden ("get")

yap_hasOpenPrimaryMenuNode()

Ist ein Hauptmenü-Punkt geöffnet?

yap_getOpenPrimaryMenuNode()

Node-Objekt des derzeitig geöffneten Hauptmenü-Punktes

yap_hasOpenSecondaryMenuNode()

Wird ein Untermenü angezeigt?

yap_getOpenSecondaryMenuNode()

Node-Objekt des derzeitig anzuzeigenden Untermenü-Punktes

yap_hasPageStructurePath()

Brotkrumen-Navigation anzeigen?

yap_getHomepageURL()

Link-URL der "Home"-Page des Systems


yap_hasUserLoginForm()

Wird das Anmelde-Formular angezeigt?

yap_hasUserLoginLink()

Wird ein "Anmelden"-Link angezeigt?

yap_hasUserLogoutLink()

Wird ein "Abmelden"-Link angezeigt?

yap_hasUserRegisterLink()

Wird ein "Neuanmelden"-Link angezeigt?

yap_hasUserAccountLinks()

Werden benutzeraccount-spezifische Links angezeigt ("Anmelden", "Abmelden", "Registrieren")?


yap_hasTitle()

Ist eine Seitenüberschrift anzuzeigen?

yap_getTitle()

Überschrift der aktuellen Seite


yap_getProjectName()

Gibt den Namen der Webseite zurück. Dieser Name wird in den Konfigurationseinstellungen eingestellt ("pagename"). Ist dort kein Name hinterlegt, wird der Name des CMS-Systemes zurückgegeben.


yap_getBrowserTitle()

Titel zur Anzeige im Browserfenster ("title"-Tag des HTML-Seite)

yap_hasAdminMenu()

Wird das Administrationsmenü angezeigt?

[ Seite drucken ] [ nach oben ]
Zuletzt bearbeitet am 2008-05-01 11:44 von StefanSorg.
Ausgegeben in 0.0034 sec