Joomla! Programmierung/Programmierung/Struktur einer Komponente

Übersicht

JRoot
administrator
components
com_KOMPONENTENNAME Administrator (Backend)
assets Optionaler Ordner z.B. für Bilder oder Javascript Dateien
controllers Optionaler Ordner für Subcontroller
SUBCONTROLLER.php Optionaler Subcontroller
help Optionaler Ordner für Hilfedateien (Toolbar Button)
de-DE Beispielverzeichnis bei deutsch als gewählte Sprache des Backends
KONTEXTA.html Kontext-spezifische Hilfedatei
KONTEXTB.html Weitere Hilfedatei
en-GB Beispielverzeichnis bei englisch als gewählte Sprache des Backends
CONTEXTA.html Kontext-spezifische Hilfedatei
CONTEXTB.html Weitere Hilfedatei
LÄNDERCODE Ländercode weiterer, installierter Sprachen
helpers Optionaler Ordner für Helperdateien
models Ordner für Modelklassen die automatisch geladen werden
KOMPONENTENNAME.php Das Standardmodel
tables Ordner für Tableklassen die automatisch geladen werden
table.php Die Standardtabelle
views Ordner für Viewklassen die automatisch geladen werden
KOMPONENTENNAME Der Standardview
tmpl Ordner für Viewtemplates
default.php Das Standardtemplate
view.html.php Der Standardview
KOMPONENTENNAME.php Die Einstiegsdatei der Komponente
controller.php Der Standardcontroller
manifest.xml Das Installmanifest der Komponente
language Spachdateien für das Backend
de-DE Sprachdateien für die deutsche Sprache
de-DE.com_KOMPONENTENNAME.ini Deutsche Sprachdatei
de-DE.com_KOMPONENTENNAME.menu.ini Optionale Sprachdatei für das Administrator Menü
en-GB Sprachdateien für die englische Sprache
en-GB.com_KOMPONENTENNAME.ini Englische Sprachdatei
en-GB.com_KOMPONENTENNAME.menu.ini Optionale Sprachdatei für das Administrator Menü
components
com_KOMPONENTENNAME Site (Frontend)
assets Optionaler Ordner z.B. für Bilder oder Javascript Dateien
controllers Optionaler Ordner für Subcontroller
SUBCONTROLLER.php
helpers Optionaler Ordner für Helperdateien
models Ordner für Modelklassen die automatisch geladen werden
KOMPONENTENNAME.php Das Standardmodel
tables Ordner für Tableklassen die automatisch geladen werden
KOMPONENTENNAME.php Die Standardtabelle
views Ordner für Viewklassen die automatisch geladen werden
KOMPONENTENNAME Der Standardview
tmpl Ordner für Viewtemplates.
default.php Das Standardtemplate
view.html.php
KOMPONENTENNAME.php Die "Einstiegsdatei der Komponente
controller.php Der Standardcontroller
language Spachdateien für das Frontend
de-DE Sprachdateien für die deutsche Sprache
de-DE.com_KOMPONENTENNAME.ini Deutsche Sprachdatei
en-GB Sprachdateien für die englische Sprache
en-GB.com_KOMPONENTENNAME.ini Englische Sprachdatei
...

---

Administrator (Backend)

Controllers

 administrator/components/com_KOMPONENTENNAME/controllers/

 SUBCONTROLLER.php - Optionale Subcontroller.

jimport('joomla.application.component.controller');
 
class 'KOMPONENTENNAME'Controller'SUBCONTROLLER' extends 'KOMPONENTENNAME'Controller
{
    function __construct()
    {
        parent::__construct();
    }//function
}//class

Models

 administrator/components/com_KOMPONENTENNAME/models/

 KOMPONENTENNAME.php - Das Standardmodel

jimport('joomla.application.component.model');
 
class 'KOMPONENTENNAME'Model'KOMPONENTENNAME' extends JModel
{
    function __construct()
    {
        parent::__construct();
    }//function
}//class

Tables

 administrator/components/com_KOMPONENTENNAME/tables/

 KOMPONENTENNAME.php - Die Standardtabelle

jimport('joomla.tables.table');
 
class 'KOMPONENTENNAME' extends JTable
{
    function __construct(& $db)
    {
        parent::__construct('#__KOMPONENTENNAME', 'id', $db);
    }//function
 
}//class

Views

 administrator/components/com_KOMPONENTENNAME/views/KOMPONENTENNAME

 view.html.php - Der Standardview

jimport('joomla.application.component.view');
 
class 'KOMPONENTENNAME'View'KOMPONENTENNAME' extends JView
{
    function display($tpl = null)
    {
        parent::display($tpl);
    }//function
}//class

Template

 administrator/components/com_KOMPONENTENNAME/views/KOMPONENTENNAME/tmpl/

 default.php - Das Standardtemplate

Base

KOMPONENTENNAME.php

 administrator/components/com_KOMPONENTENNAME/

 KOMPONENTENNAME.php - Die Einstiegsdatei

require_once JPATH_COMPONENT.DS.'controller.php';
 
//-- Falls ein Subcontroller angefordert wurde wird dieser inkludiert
if($controller = JRequest::getCmd('controller'))
{
    $path = JPATH_COMPONENT.DS.'controllers'.DS.$controller.'.php';
 
    if(file_exists($path))
    {
        require_once $path;
    } else
    {
        $controller = '';
    }
}
 
//-- Ein Controllerobjekt erstellen
$classname = 'KOMPONENTENNAMEController'.$controller;
$controller = new $classname();
 
//-- Den angeforderten Task ausführen
$controller->execute(JRequest::getCmd('task'));
 
//-- Einen Redirect ausführen falls er vom Controller gesetzt wurde
$controller->redirect();

//-- Die Joomla! Controllerbibliothek importieren
jimport('joomla.application.component.controller');
 
//-- Eine Instanz des Controllers mit dem Präfix 'KOMPONENTENNAME' beziehen
$controller = JController::getInstance('KOMPONENTENNAME');
 
// Den 'task' der im Request übergeben wurde ausführen
$controller->execute(JRequest::getCmd('task'));
 
//-- Einen Redirect ausführen falls er vom Controller gesetzt wurde
$controller->redirect();

controller.php

 administrator/components/com_KOMPONENTENNAME/

 controller.php - Der Hauptcontroller

jimport('joomla.application.component.controller');
 
class 'KOMPONENTENNAME'Controller extends JController
{
    function display()
    {
        parent::display();
    }//function
}//class

manifest.xml

 administrator/components/com_KOMPONENTENNAME/

 manifest.xml

Siehe auch: Manifestdatei für Komponenten Manifestdatei für Komponenten

---

Site (Frontend)

Controllers

 components/com_KOMPONENTENNAME/controllers/

 SUBCONTROLLER.php - Optionale Subcontroller.

jimport('joomla.application.component.controller');
 
class 'KOMPONENTENNAME'Controller'SUBCONTROLLER' extends 'KOMPONENTENNAME'Controller
{
    function __construct()
    {
        parent::__construct();
    }//function
}//class

Models

 components/com_KOMPONENTENNAME/models/

 KOMPONENTENNAME.php - Das Standardmodel

jimport('joomla.application.component.model');
 
class 'KOMPONENTENNAME'Model'KOMPONENTENNAME' extends JModel
{
    function __construct()
    {
        parent::__construct();
    }//function
}//class

Tables

 components/com_KOMPONENTENNAME/tables/

 KOMPONENTENNAME.php - Die Standardtabelle

Standardmässig wird zuerst im Adminbereich nach einer Tabelle gesucht.

jimport('joomla.tables.table');
 
class 'KOMPONENTENNAME' extends JTable
{
    function __construct(& $db)
    {
        parent::__construct('#__KOMPONENTENNAME', 'id', $db);
    }//function
 
}//class

Views

 components/com_KOMPONENTENNAME/views/KOMPONENTENNAME/

 view.html.php - Der Standardview

jimport('joomla.application.component.view');
 
class 'KOMPONENTENNAME'View'KOMPONENTENNAME' extends JView
{
    function display($tpl = null)
    {
        parent::display($tpl);
    }//function
}//class

Template

 components/com_KOMPONENTENNAME/views/KOMPONENTENNAME/tmpl/

 default.php - Das Standardtemplate

Base

KOMPONENTENNAME.php

 components/com_KOMPONENTENNAME/

 KOMPONENTENNAME.php - Die Einstiegsdatei

require_once JPATH_COMPONENT.DS.'controller.php';
 
//-- Falls ein Subcontroller angefordert wurde wird dieser inkludiert
if($controller = JRequest::getCmd('controller'))
{
    $path = JPATH_COMPONENT.DS.'controllers'.DS.$controller.'.php';
 
    if(file_exists($path))
    {
        require_once $path;
    } else
    {
        $controller = '';
    }
}
 
//-- Ein Controllerobjekt erstellen
$classname = 'KOMPONENTENNAMEController'.$controller;
$controller = new $classname();
 
//-- Den angeforderten Task ausführen
$controller->execute(JRequest::getCmd('task'));
 
//-- Einen Redirect ausführen falls er vom Controller gesetzt wurde
$controller->redirect();

//-- Die Joomla! Controllerbibliothek importieren
jimport('joomla.application.component.controller');
 
//-- Eine Instanz des Controllers mit dem Präfix 'KOMPONENTENNAME' beziehen
$controller = JController::getInstance('KOMPONENTENNAME');
 
// Den 'task' der im Request übergeben wurde ausführen
$controller->execute(JRequest::getCmd('task'));
 
//-- Einen Redirect ausführen falls er vom Controller gesetzt wurde
$controller->redirect();

controller.php

 components/com_KOMPONENTENNAME/

 controller.php - Der Hauptcontroller

jimport('joomla.application.component.controller');
 
class 'KOMPONENTENNAME'Controller extends JController
{
    function display()
    {
        parent::display();
    }//function
}//class