Rheinwerk Computing < openbook > Rheinwerk Computing - Professionelle Bücher. Auch für Einsteiger.
Professionelle Bücher. Auch für Einsteiger.

Inhaltsverzeichnis
Vorwort
1 Einleitung
2 Installation
3 Frontend
4 Backend
5 Inhalte erstellen und verändern
6 Eine erste Webseite
7 Das Website-Design
8 Benutzer und Bereiche
9 Module, Plug-ins, Komponenten
10 Pflege der Webseite
11 Eine Site aufbauen
12 Was macht ein Template aus?
13 Tools zur Template-Erstellung
14 Barrierefreiheit
15 Aus der Trickkiste
16 Joomla! als professionelle Geschäftsplattform
17 Online-Shop: VirtueMart
18 Formulare: BreezingForms und ChronoForms
19 Dokumentenverwaltung: Docman und Attachments
20 Kalender: JEvent und iWebCal
21 Bildergalerien: Zoom Media Gallery und JoomGallery
22 Joomla! als Community-Treff
23 Weblogs: IDoBlog und MMS Blog
24 Wiki: JoomlaWiki
25 Forum: FireBoard
26 Gästebücher
27 Noch mehr Kommunikation
28 Installation beim Webhost
29 Backup und Upgrade
30 Tools
31 Standard-Erweiterungen
32 Mehrsprachigkeit
33 Suchmaschinenoptimierung
34 Statistik
35 Performance
36 Datentransfer und FTP-Modus
37 Sicherheit
38 Troubleshooting
39 Mein erstes Modul
40 Die Joomla!-API
41 Plug-ins erstellen
42 Eine eigene Komponente
A Parameter der unterschiedlichen Menütypen
B Die Joomla!-API
C Glossar
D Inhalt der DVD
Stichwort
Ihre Meinung?

Spacer
<< zurück
Joomla! 1.5 von Anja Ebersbach, Markus Glaser, Radovan Kubani
Das umfassende Handbuch
Buch: Joomla! 1.5

Joomla! 1.5
geb., mit DVD
820 S., 34,90 Euro
Rheinwerk Computing
ISBN 978-3-89842-881-1
Pfeil B Die Joomla!-API
Pfeil B.1 Funktionen
Pfeil B.2 Konstanten
Pfeil B.3 Objekte
Pfeil B.4 Details zu einzelnen Objekten
Pfeil B.4.1 JApplication
Pfeil B.4.2 JDatabase
Pfeil B.4.3 JFactory
Pfeil B.4.4 JHTML
Pfeil B.4.5 JParameter
Pfeil B.4.6 JRequest
Pfeil B.4.7 JToolbarHelper
Pfeil B.4.8 JUser


Rheinwerk Computing - Zum Seitenanfang

B.4 Details zu einzelnen Objekten Zur nächsten ÜberschriftZur vorigen Überschrift


Rheinwerk Computing - Zum Seitenanfang

B.4.1 JApplication Zur nächsten ÜberschriftZur vorigen Überschrift

Liefert viele wichtige Funktionen der API.

Laufzeitvariable

$mainframe

Zugriff

JFactory::getApplication();

Methoden


Tabelle B.4 Die Methoden des »JApplication«-Objekts

Methode Beschreibung

addCustomHeadTag (string $html)

Fügt dem Head-Bereich der HTML-Ausgabe ein neues Tag hinzu.
$html: Das neue HTML-Tag.

addMetaTag ( string $name, string $content)

Fügt ein neues Meta-Tag in den HTML-Header ein.
$name: Inhalt des Name-Attributs.
$content: Inhalt des Content-Attributs.

appendMetaTag ( string $name, string $content)

Erweitert ein bereits existierendes Meta-Tag im HTML-Header.
$name: Name des zu erweiternden Tags.
$content: Inhalt, der an den bestehenden Inhalt angehängt werden soll.

getPageTitle ()

Gibt den Titel der Seite zurück.

getPath(mixed $varname)

Gibt eine zuvor gespeicherte Pfadvariable zurück, beispielsweise, um die verschiedenen Teile einer Komponente aufzurufen.
$varname: Der Name der Pfadvariablen.

getUser ()

Liefert ein Objekt vom Typ JUser zurück, das die Daten des aktuell eingeloggten Benutzers enthält.

login ( mixed $username, mixed $passwd)

Versucht, einen bestimmten Benutzer im System anzumelden.
$username: Der Benutzername des Users.
$passwd: Das Passwort des Benutzers.

logout ()

Beendet die aktuelle Session und loggt den Benutzer aus.

setPageTitle (string $title)

Setzt den Seitentitel auf den angegebenen Wert.
$title: Der neue Seitentitel.



Rheinwerk Computing - Zum Seitenanfang

B.4.2 JDatabase Zur nächsten ÜberschriftZur vorigen Überschrift

Ermöglicht den Zugriff auf die Datenbank.

Zugriff

JFactory::getDBO();

Methoden


Tabelle B.5 Die Methoden des »JDatabase«-Objekts

Methode Beschreibung

getErrorMsg()

Liefert im Fehlerfall die Fehlermeldung.

getErrorNum()

Liefert im Fehlerfall die Fehlernummer.

getNumRows()

Die Anzahl der Ergebnisse der letzten Abfrage.

loadObjectList()

Liefert das Abfrageergebnis als Array von Objekten.

loadResult()

Liefert das erste Feld des ersten Ergebnisses der Abfrage.

query()

Führt die Abfrage aus. Gibt eine Datenbankressource zurück, wenn die Abfrage erfolgreich war, ansonsten false.

setQuery(string $sql)

Setzt das SQL-Statement für die Datenbankabfrage fest.
$sql: Das SQL-Statement.



Rheinwerk Computing - Zum Seitenanfang

B.4.3 JFactory Zur nächsten ÜberschriftZur vorigen Überschrift

Stellt den Zugriff auf die Laufzeitobjekte von Joomla! her.

Methoden


Tabelle B.6 Die Methoden von »JFactory«

Methode Beschreibung

getApplication()

Liefert das Rahmen-Objekt der aktuellen Anwendung: JApplication.

getConfig()

Zugriff auf die Einstellungen von Joomla!: JRegistry.

getDate()

Die aktuelle Uhrzeit: JDate.

getDBO()

Zentraler Zugriff auf die Datenbank: JDatabase.

getDocument()

Daten der eben erstellten Seite: JDocument.

getMailer()

Ein Objekt zum Versenden von E–Mails: JMail.

getTemplate()

Zugriff auf das aktuelle Template: JTemplate.

getURI()

URL, mit der die Seite aufgerufen wurde: JURI.

getUser()

Daten zum aktuellen Benutzer: JUser.



Rheinwerk Computing - Zum Seitenanfang

B.4.4 JHTML Zur nächsten ÜberschriftZur vorigen Überschrift

Stellt Standard-HTML-Elemente von Joomla! zur Verfügung.

Methoden


Tabelle B.7 Methoden des JHTML-Objekts

Methode Beschreibung

calendar ( string $value, string $name string $id, [string $format] )

Gibt einen Kalender aus.

$value: Der Datumswert.
$name: Der Name des erzeugten Elements.
$id: Die ID des erzeugten Elements.
$format: Das Datumsformat, in dem das Ergebnis ausgegeben wird. Grundlage ist hier die Datumsformatierung von PHP.

date ( string $date, [string $format] )

Gibt ein formatiertes Datum zurück.

$date: Das Datum in einem amerikanischen Format.
$format: Das Datumsformat, in dem das Ergebnis ausgegeben wird. Grundlage ist hier die Datumsformatierung von PHP.

iframe ( string $url, string $name, [array $attribs] )

Gibt einen IFrame aus.

$url: Die Internetadresse, die im IFrame angezeigt werden soll.
$name: Der Name des erzeugten Elements.
$attribs: Ein assoziatives Array mit weiteren Attributen für das IFrame-Tag. Als Schlüssel des Arrays ist jeweils der Name des Attributs zu verwenden; im Wert steht der Wert des Attributs.

image ( string $url, string $alt )

Gibt ein Bild aus.

$url: Die Adresse des Bildes, das angezeigt werden soll.
$alt: Eine zusätzliche Bildbeschriftung.

tooltip ( string $tooltip, [string $title], [string $image], [string $text], [string $href], [string $link] )

Gibt den HTML-Code für ein Tooltip und das zugehörige Icon aus.

$tooltip: Text der Anzeige.
$title: Text im Titelfeld.
$image: Icon, das angezeigt werden soll. Der Pfad muss relativ zu /includes/js/ThemeOffice sein. Wenn der Parameter $text einen Wert hat, wird kein Bild angezeigt.
$text: Text, der als Basis für das Tooltip dient.
$href: Adresse, die angezeigt werden soll, wenn auf die Tooltip-Basis geklickt wird.
$link: Gibt an, ob die Basis verlinkt werden soll.


Rheinwerk Computing - Zum Seitenanfang

B.4.5 JParameter Zur nächsten ÜberschriftZur vorigen Überschrift

Stellt den Zugriff auf die Parameter der Einstellungsseite einer Erweiterung her.

Laufzeitvariable

$params

Methoden


Tabelle B.8 Methoden des JParameters-Objekts

Methode Beschreibung

def ( string $key, string $value)

Setzt einen Wert, der noch nicht registriert ist.

$key: Name des neuen Parameters.
$value: Wert, der gesetzt werden soll.

get ( string $key, [mixed $default])

Liefert den Wert eines bestimmten Parameters zurück.

$key. Name des Parameters.
$default. Standardwert, falls der Parameter nicht gefunden wird.

set ( string $key, string $value)

Setzt den Wert eines bestimmten Parameters.

$key. Name des Parameters.
$value. Wert, der gesetzt werden soll.


Rheinwerk Computing - Zum Seitenanfang

B.4.6 JRequest Zur nächsten ÜberschriftZur vorigen Überschrift

Stellt den Zugriff auf die per URL übergebenen Parameter her. Diese Funktionsparameter tauchen dabei besonders häufig auf:

  • $hash: Der Übergabebereich, aus dem ausgelesen werden soll. Mögliche Werte sind:
    • post: Daten, die mittels Post aus einem Formular übermittelt werden.
    • get: Daten, die mittels GET per URL übertragen werden.
    • files: Dateien, die hochgeladen wurden.
    • env: Informationen aus der Systemumgebung.
    • server: Informationen, die der Webserver liefert.
  • $name: Der Name der Variablen, die gelesen werden soll.
  • $default: Ein Standardwert, der zurückgegeben wird, wenn die entsprechende Variable nicht gefunden wird.

Methoden


Methode Beschreibung

get ( string $hash )

Liefert die Werte eines Bereichs als Array zurück.

getBool ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters als Boolean-Variable zurück. Mögliche Ergebnisse sind also nur true und false.

getCmd ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters im Command-Format zurück. Dieses Format erlaubt nur Buchstaben, Zahlen und die Zeichen .-_ . Achtung: Umlaute werden hier nicht übergeben.

getFloat ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters im Fließkomma-Format zurück.



Rheinwerk Computing - Zum Seitenanfang

B.4.7 JToolbarHelper Zur nächsten ÜberschriftZur vorigen Überschrift

Dieses Objekt stellt die Funktionalität für Ausgaben in der Toolbar zur Verfügung. Zwei Parameter tauchen dabei besonders häufig auf:

  • $task: Der Name der Funktion, die ausgeführt werden soll.
  • $alt: Der Text für das alt-Attribut des Bildes.

Methoden


Tabelle B.9 Die Methoden des »JToolBarHelper«-Objekts

Methode Beschreibung

addNew ( string $task, [string $alt])

Gibt das Neu-Symbol aus.

addNewX ( string $task, [string $alt])

Gibt das Neu-Symbol aus und versteckt das Menü.

apply ( string $task, [string $alt])

Gibt das Anwenden-Symbol aus.

archiveList ( string $task, [string $alt])

Gibt das Archivieren-Symbol aus.

assign ( string $task, [string $alt])

Gibt das Zuweisen-Symbol aus.

back( [mixed $alt], [mixed $href])

Gibt das Zurück-Symbol aus.

$href: Zieladresse beim Zurückspringen.

cancel ( string $task, [string $alt])

Gibt das Abbrechen-Symbol aus.

custom ( string $task, string $icon, [string $iconOver], [string $alt], [bool $listSelect], [bool $x] )

Gibt ein benutzerdefiniertes Symbol aus.

$task: Die Aufgabe, die ausgeführt werden soll.
$icon: Das Bild des Symbols.
$iconOver: Das Bild, wenn mit der Maus darübergezogen wird.
$alt: Ein Text, der angezeigt wird, wenn man mit der Maus darüberzieht.
$listSelect: Wenn true, muss mindestens ein Element aus der Liste ausgewählt werden.
$x: Wenn true, wird das Menü abgeschaltet.

customX ( string $task, string $icon, [string $iconOver], [string $alt], [bool $listSelect] )

Gibt ein benutzerdefiniertes Symbol aus und deaktiviert das Menü bei Klick.

$task: Die Aufgabe, die ausgeführt werden soll.
$icon: Das Bild des Symbols.
$iconOver: Das Bild, wenn mit der Maus darübergezogen wird.
$alt: Ein Text, der angezeigt wird, wenn man mit der Maus darüberzieht.
$listSelect: Wenn true, muss mindestens ein Element aus der Liste ausgewählt werden.

deleteList( [string $msg], [string $task], [string $alt])

Gibt das Löschen-Symbol aus.

$msg: Meldung, die ausgegeben wird, bevor gelöscht wird.

deleteListX( [string $msg], [string $task], [string $alt])

Gibt das Löschen-Symbol aus und versteckt das Menü.

$msg: Meldung, die ausgegeben wird, bevor gelöscht wird.

divider()

Gibt ein Trennzeichen zwischen zwei Symbolen aus.

editCss ( string $task, [string $alt])

Gibt das Symbol zum Bearbeiten von CSS aus.

editCssX ( string $task, [string $alt])

Gibt das Symbol zum Bearbeiten von CSS aus und deaktiviert das Menü.

editHtml ( string $task, [string $alt])

Gibt das Symbol zum Bearbeiten von HTML aus.

editHtmlX ( string $task, [string $alt])

Gibt das Symbol zum Bearbeiten von HTML aus und deaktiviert das Menü.

editList ( string $task, [string $alt])

Gibt das Bearbeiten-Symbol aus.

editListX ( string $task, [string $alt])

Gibt das Bearbeiten-Symbol aus und deaktiviert das Menü.

help ( string $ref, [bool $com] )

Gibt das Hilfe-Symbol aus. Bei einem Klick öffnet sich ein neues Fenster.

$ref: Der Name der Datei, die angezeigt werden soll.
$com: Wenn true, wird die Hilfedatei aus dem Komponentenverzeichnis genommen.

makeDefault ( string $task, [string $alt])

Gibt das Als Standard-Symbol aus.

media_manager ( string $directory, [string $alt])

Gibt das Medienverwaltung-Symbol aus.

$directory: Das Verzeichnis, das in der Medienverwaltung aufgerufen werden soll.

preferences ( string $component, [int $height], [int $width], [string $alt])

Gibt das Einstellungen-Symbol aus.

$component: Der Name der Komponente, für die die Einstellungen gelten sollen.
$height: Die Höhe des Popup-Fensters.
$widthv Die Breite des Popup-Fensters.

preview ( string $url )

Gibt das Vorschau-Symbol aus.

$url: Die Adresse der Datei, die im Popup-Fenster angezeigt werden soll.

publish ( string $task, [string $alt])

Gibt das Veröffentlichen-Symbol aus.

publishList ( string $task, [string $alt])

Gibt das Veröffentlichen-Symbol für eine Liste von Datensätzen aus.

save ( string $task, [string $alt])

Gibt das Speichern-Symbol aus.

spacer ( string $width )

Gibt eine leere Zelle aus.

$width: Die Breite der Zelle.

title ( string $title, [string $icon] )

Gibt den Titel neben den Symbolen aus.

$title: Der Text des Titels.
$icon: Das Bild, das vor dem Titel ausgegeben wird.

trash ( string $task, [string $alt])

Gibt das Papierkorb-Symbol aus.

unarchiveList ( string $task, [string $alt])

Gibt das Symbol zum Zurückholen einer Liste von Datensätzen aus dem Archiv aus.

unpublish ( string $task, [string $alt])

Gibt das Verstecken-Symbol aus.

unpublishList (

string $task,

[string $alt])

Gibt das Verstecken-Symbol für eine Liste von Datensätzen aus.



Tabelle B.10 Methoden des »JRequest«-Objekts

getInt ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters im Integer-Format zurück, also nur ganze Zahlen.

getString ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters als Zeichenkette zurück. HTML-Code wird unter Umständen gefiltert.

getVar ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters zurück.

getWord ( string $name, string $default, string $hash)

Gibt den Wert eines bestimmten Parameters im Word-Format zurück. Dieses Format erlaubt nur Buchstaben, Zahlen und den Unterstrich. Achtung: Umlaute werden hier nicht übergeben.



Rheinwerk Computing - Zum Seitenanfang

B.4.8 JUser topZur vorigen Überschrift

Enthält Informationen über einen bestimmten Benutzer.

Laufzeitvariable

$my

Zugriff

JFactory::getUser();

Variablen


Tabelle B.11 Variablen des »JUser«-Objekts

Name Inhalt

id

Die ID des Benutzers.

name

Der echte Name des Benutzers.

username

Der Benutzername.

usertype

Der Name der Gruppe, zu der der Benutzer gehört.




Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen. >> Zum Feedback-Formular
<< zurück
  Zum Katalog
Zum Katalog: Joomla! 1.5 - Das umfassende Handbuch





Joomla! 1.5 -
Das umfassende Handbuch

Jetzt bestellen


 Ihre Meinung?
Wie hat Ihnen das <openbook> gefallen?
Ihre Meinung

 Buchtipps
Zum Katalog: Joomla! 3.5






 Joomla! 3.5


Zum Katalog: Top-Rankings bei Google und Co






 Top-Rankings bei
 Google und Co


Zum Katalog: Erfolgreiche Websites






 Erfolgreiche Websites


Zum Katalog: WordPress 4






 WordPress 4


Zum Katalog: Webseiten erstellen für Einsteiger






 Webseiten erstellen
 für Einsteiger


 Shopping
Versandkostenfrei bestellen in Deutschland und Österreich
InfoInfo




Copyright © Rheinwerk Verlag GmbH 2009
Für Ihren privaten Gebrauch dürfen Sie die Online-Version natürlich ausdrucken. Ansonsten unterliegt das <openbook> denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.


[Rheinwerk Computing]

Rheinwerk Verlag GmbH, Rheinwerkallee 4, 53227 Bonn, Tel.: 0228.42150.0, Fax 0228.42150.77, service@rheinwerk-verlag.de