J3.x: Entwicklung einer MVC Komponente/Verwendung der Datenbank

This page is a translated version of the page J3.x:Developing an MVC Component/Using the database and the translation is 86% complete.

Other languages:

Deutsch • ‎English • ‎Nederlands • ‎español • ‎français • ‎italiano • ‎العربية • ‎中文（台灣）‎

Joomla!

3.x

Tutorial

Entwicklung einer MVC Komponente

Artikel in dieser Serie

Hinzufügen eines Views zum Seitenbereich

Hinzufügen eines Menütyps zum Seitenbereich

Hinzufügen eines Models zum Seitenbereich

Hinzufügen einer variablen Anfrage zum Menütyp

Benutzung der Datenbank

Backend-Grundlagen

Hinzufügen von Sprachen

Hinzufügen von Aktionen im Backend

Hinzufügen von Dekorationen zum Backend

Hinzufügen von Validierungen

Hinzufügen von Kategorien

Hinzufügen einer Konfiguration

Hinzufügen von ACL

Hinzufügen eines Installations-/Deinstallations-/Aktualisierungs-Skriptes

Hinzufügen eines Formulars im Frontend

Benutzung des Sprachenfilters

Hinzufügen eines Aktualisierungs-Servers

Dies ist eine Artikel-Serie mit Tutorials über die Entwicklung einer Modal-View-Controller Komponente für Joomla! Version.

Beginne mit der Einführung und navigiere durch die Artikel dieser Serie mit Hilfe des Buttons am Ende der Seite oder der Box auf der rechten Seite ("Artikel in dieser Serie").

Einleitung

Dieses Tutorial ist ein Teil der Artikelserie mit Tutorials über Developing an MVC Component for Joomla! 3.3. Es wird empfohlen die vorherigen Teile des Tutorials zu lesen, bevor dieser Teil gelesen wird. Es wird auch empfohlen weitere Quellen über über Datenbankabfragen, die Auswahl von Daten aus einer Datenbanktabelle und das Abrufen von Daten in verschiedenen Formaten zu lesen.

Zu diesem Teil gibt es auch drei Videos: - Setup der Datenbank the Database Setup - Anzeigen der Nachricht (unter Verwendung von JTable) Displaying the message (using JTable) - Auswahl der Nachricht im Admin-Bereich (unter Verwendung von JDatabase) Admin message selection (and JDatabase).

Verwendung der Datenbank

Komponenten verwalten ihren Inhalt in der Regel über die Datenbank. Während der Installations-/Deinstallations-/Aktualisierungsphase einer Komponente können SQL-Abfragen mithilfe von SQL-Textdateien ausgeführt werden.

Mit dem bevorzugten Dateimanager und Editor sollen zwei Dateien erstellt werden: - admin/sql/install.mysql.utf8.sql - admin/sql/updates/mysql/0.0.6.sql Beide sollen den gleichen, folgenden Inhalt haben:

admin/sql/install.mysql.utf8.sql and admin/sql/updates/mysql/0.0.6.sql

DROP TABLE IF EXISTS `#__helloworld`;

CREATE TABLE `#__helloworld` (
	`id`       INT(11)     NOT NULL AUTO_INCREMENT,
	`greeting` VARCHAR(25) NOT NULL,
	`published` tinyint(4) NOT NULL DEFAULT '1',
	PRIMARY KEY (`id`)
)
	ENGINE =MyISAM
	AUTO_INCREMENT =0
	DEFAULT CHARSET =utf8;

INSERT INTO `#__helloworld` (`greeting`) VALUES
('Hello World!'),
('Good bye World!');

""Anmerkung."" Für die aktuell verwendete Datenbankstruktur wird folgende Angabe empfohlen:

ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 DEFAULT COLLATE=utf8mb4_unicode_ci;

anstelle der oben genannten. InnoDB ist die modernere (und jetzt standardmäßige) MySQL-Datenbank-Engine, die MyISAM ersetzt, und mit dem Format utf8mb4 eine breitere Palette von Zeichensätzen einschließlich Emojis unterstützt. Es wurden jedoch nicht alle Teile des Tutorials mit dieser Einstellung getestet. Wenn die weiteren Teile der Tutorial-Serie durchgearbeitet und InnoDB verwendet wird, dann wird empfohlen diese Datei auch in den anderen Teilen des Tutorials zu aktualisieren.

Es ist im Allgemeinen ratsam, dem Design-Muster von Joomla zu folgen. Dies ist von Vorteil bei der Wiederverwendung von zentralen Joomla-Javascript-Routinen, so auch bei der Verwendung von komplexeren Funktionalitäten, wie z.B. ACL (Access Control LIst - Zugriffskontrolliste) oder Verknüpfungen. Siehe hierzu auch weitere Folge dieses Tutorials (https://docs.joomla.org/Special:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL, https://docs.joomla.org/J3.x:Developing_an_MVC_Component/Adding_Associations). [Die Übersetzung dieses Absatzes wurde verallgemeinert, da die im Original beschriebene Datenbankstruktur so nicht mehr verwendet wird.]

Oft gibt es in der Datenbanktabelle ein Feld, in dem der Veröffentlichungs- bzw. Nichtveröffentlichungsstatus eines Eintrags festgehalten wird. Die Verwendung des Namens 'state' innerhalb von Joomla wird nicht empfohlen, da dies zu Konflikten führen kann, stattdessen wird der Name 'published' verwendet.
Hinweis: Wie kann man Joomla anweisen den Wert des veröffentlichten Formularfeldes in einem Datenbankfeld mit einem anderen Namen zu speichern? Dies kann durch die Verwendung der Methode setColumnAlias() erreicht werden (gültig seit Joomla 3.4.0).

Die Datei install.mysql.utf8.sql wird ausgeführt, wenn diese Komponente installiert wird. Die Datei updates/mysql/0.0.6.sql wird ausgeführt, wenn ein Update durchgeführt wird.

Damit die Installation bzw. das Update durchgeührt werden kann, müssen die entsprechenden Dateien in der Datei helloworld.xml angegeben werden.

Wichtiger Hinweis: Wenn die SQL-Dateien in utf8 gespeichert wird, dann muss sichergestellt werden, dass sie als utf8 NOT BOM gespeichert wird, ansonsten wird die Abfrage mit dem MySQL-Fehler #1064 fehlschlagen.

helloworld.xml

<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.0" method="upgrade">

	<name>Hello World!</name>
	<!-- The following elements are optional and free of formatting constraints -->
	<creationDate>January 2018</creationDate>
	<author>John Doe</author>
	<authorEmail>john.doe@example.org</authorEmail>
	<authorUrl>http://www.example.org</authorUrl>
	<copyright>Copyright Info</copyright>
	<license>License Info</license>
	<!--  The version string is recorded in the components table -->
	<version>0.0.6</version>
	<!-- The description is optional and defaults to the name -->
	<description>Description of the Hello World component ...</description>

	<install> <!-- Runs on install -->
		<sql>
			<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
		</sql>
	</install>
	<uninstall> <!-- Runs on uninstall -->
		<sql>
			<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
		</sql>
	</uninstall>
	<update> <!-- Runs on update; New since J2.5 -->
		<schemas>
			<schemapath type="mysql">sql/updates/mysql</schemapath>
		</schemas>
	</update>

	<!-- Site Main File Copy Section -->
	<!-- Note the folder attribute: This attribute describes the folder
		to copy FROM in the package to install therefore files copied
		in this section are copied from /site/ in the package -->
	<files folder="site">
		<filename>index.html</filename>
		<filename>helloworld.php</filename>
		<filename>controller.php</filename>
		<folder>views</folder>
		<folder>models</folder>
	</files>

	<administration>
		<!-- Administration Menu Section -->
		<menu link='index.php?option=com_helloworld'>Hello World!</menu>
		<!-- Administration Main File Copy Section -->
		<!-- Note the folder attribute: This attribute describes the folder
			to copy FROM in the package to install therefore files copied
			in this section are copied from /admin/ in the package -->
		<files folder="admin">
			<!-- Admin Main File Copy Section -->
			<filename>index.html</filename>
			<filename>helloworld.php</filename>
			<!-- SQL files section -->
			<folder>sql</folder>
			<!-- tables files section -->
			<folder>tables</folder>
			<!-- models files section -->
			<folder>models</folder>
		</files>
	</administration>

</extension>

Mit der Datei zur Deinstallation wird genau so verfahren:

Mit dem bevorzugten Dateimanager und Editor soll die Datei admin/sql/uninstall.mysql.utf8.sql erstellt werden, die folgenden Inhalt enthält:

admin/sql/uninstall.mysql.utf8.sql

DROP TABLE IF EXISTS `#__helloworld`;

Schematische Nummerierung

Die Komponente besitzt eine Versionsnummer (diese ist innerhalb des Tags <version> in der Manifestdatei helloword.xml angegeben). Das Schema der Datenbank der Komponente besitzt eine eigene Versionsnummer (diese basiert auf den Dateinamen der Sql-Update-Dateien).

Joomla speichert die Version des Datenbankschemas der jeweiligen Komponente durch einen Datensatz in der Tabelle #__schemas wenn eine Komponente erstmalig installiert wird. Liegt z.B. eine Datei namens admin/sql/updates/mysql/0.0.6.sql vor, dann wird Joomla den Wert 0.0.6 in der Datenbank als Version speichern.

Wenn eine neuere Version dieser Komponente installiert wird - es muss nicht unbedingt die nächst höhere Version sein, es können Versionen übersprungen werden - Joomla wird folgede Schritte ausführen:

Aus der Tabelle #__schemas wird die aktuelle Version des Datenbankschemas der Komponente gelesen - in unserem Beispiel entspricht diese dem Wert 0.0.6.
Es werden die Dateinamen aller Dateien in dem Verzeichnis admin/sql/updates/mysql/ gelesen und in numerisch aufsteigender Reihenfolge sortiert.
Es werden die Aktualisierungsdateien der Dateinamen ausgeführt, wenn diese für eine höhere Schemaversion als die aktuelle Version gelten - es könnten z.B. die Dateien "0.0.7.sql", "0.0.9.sql" und "0.0.10.sql" gefunden werden, welche in dieser Reihenfolge ausgeführt weden.
Es wird die Information über das Datenbankschema aktualisiert. Hierbei wird die Version der zuletzt ausgeführten Aktualisierungsdatei übernommen - z.B. 0.0.10.

Wenn bereits eine Versionen der Komponente ohne Datenbanknutzung veröffentlicht wurde, dann sollte folgender Hinweis beachtet werden: Mit der erstmaligen Nutzung der Datenbank durch die Komponente muss die Aktualisierungsdatei dann den gleichen Inhalt haben, wie die Installationsdatei.

Die Versionskennung für das Datenbankschema und die Versionskennung der Komponente müssen nicht identisch sein. Joomla übernimmt die Versionskennung für das Datenbankschema aus dem Namen der Aktualisierungsdatei mit der höchsten Versionskennung. Deshalb wird empfohlen, dass es immer eine Aktualisierungsdatei gibt, sebst dann, wenn sie keinen Inhalt hat. Wenn es erreicht werden soll, dass die Versionskennung für das Datenbankschema und die Versionskennung der Komponente immer identisch ist, dann kann folgende Vorgehensweise empfohlen werden: Soll der Code aktualisiert werden, dann kann eine Aktualisierungsdatei mit neuer Versionsnummer hinzugefügt werden, hier bei wird die Aktualisierungsdatei leer sein.

As you make subsequent releases of your component the database install file must always contain the full schema and the update files only need to contain any changes you have made to the schema since the last update.

Hinzufügen eines neuen Feldtyps

Bisher haben wir einen Feldtyp für die Nachricht verwendet, welcher statisch vorgegeben war, siehe [S:MyLanguage/J3.3:Developing an MVC Component/Adding a menu type to the site part]. Jetzt möchten wird die Datenbank verwenden, um die Nachricht auszuwählen und hierfür müssen wir einen benutzerspezifischen Feldtyp mit der Bezeichnung "helloworld" definieren, siehe hierzu [S:MyLanguage/Creating_a_custom_form_field_type].

Die Datei site/views/helloworld/tmpl/default.xml muss bearbeitet werden und um folgende Zeilen ergänzt werden:

site/views/helloworld/tmpl/default.xml

<?xml version="1.0" encoding="utf-8"?>
<metadata>
	<layout title="COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_TITLE">
		<message>COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_DESC</message>
	</layout>
	<fields
			name="request"
			addfieldpath="/administrator/components/com_helloworld/models/fields"
			>
		<fieldset name="request">
			<field
					name="id"
					type="helloworld"
					label="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL"
					description="COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC"
					/>
		</fieldset>
	</fields>
</metadata>

Dieser Code führt einen neuen Feldtyp ein und gibt Joomla die Anweisung die Definition des Feldes im Ordner /administrator/components/com_helloworld/models/fields zu verwenden.

Es gibt ein weiteres Tutorial, um mehr über Datenbankabfragen zu lernen. Hier wird erklärt wie Daten aus einer Datenbanktabelle in verschiedenen Formaten gelesen werden können: hier klicken. Mit dem bevorzugten Dateimanager und Editor soll die Datei admin/models/fields/helloworld.php erstellt werden, die folgenden Inhalt enthält:

admin/models/fields/helloworld.php

<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

JFormHelper::loadFieldClass('list');

/**
 * HelloWorld Form Field class for the HelloWorld component
 *
 * @since  0.0.1
 */
class JFormFieldHelloWorld extends JFormFieldList
{
	/**
	 * The field type.
	 *
	 * @var         string
	 */
	protected $type = 'HelloWorld';

	/**
	 * Method to get a list of options for a list input.
	 *
	 * @return  array  An array of JHtml options.
	 */
	protected function getOptions()
	{
		$db    = JFactory::getDBO();
		$query = $db->getQuery(true);
		$query->select('id,greeting');
		$query->from('#__helloworld');
		$db->setQuery((string) $query);
		$messages = $db->loadObjectList();
		$options  = array();

		if ($messages)
		{
			foreach ($messages as $message)
			{
				$options[] = JHtml::_('select.option', $message->id, $message->greeting);
			}
		}

		$options = array_merge(parent::getOptions(), $options);

		return $options;
	}
}

The new field type displays a drop-down list of messages to choose from. You can see the result of this change in the menu manager section for the helloworld item.

Anzeige der gewählten Nachricht

When a menu item of this component is created/updated, Joomla stores the identifier of the message. The HelloWorldModelHelloWorld model has now to compute the message according to this identifier and the data stored in the database. To do this is uses the JTable functionality, which is an alternative to JDatabase if only CRUD operations on single records are required.

Modify the site/models/helloworld.php file:

site/models/helloworld.php

<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
 * HelloWorld Model
 *
 * @since  0.0.1
 */
class HelloWorldModelHelloWorld extends JModelItem
{
	/**
	 * @var array messages
	 */
	protected $messages;

	/**
	 * Method to get a table object, load it if necessary.
	 *
	 * @param   string  $type    The table name. Optional.
	 * @param   string  $prefix  The class prefix. Optional.
	 * @param   array   $config  Configuration array for model. Optional.
	 *
	 * @return  JTable  A JTable object
	 *
	 * @since   1.6
	 */
	public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
	{
		return JTable::getInstance($type, $prefix, $config);
	}

	/**
	 * Get the message
	 *
	 * @param   integer  $id  Greeting Id
	 *
	 * @return  string        Fetched String from Table for relevant Id
	 */
	public function getMsg($id = 1)
	{
		if (!is_array($this->messages))
		{
			$this->messages = array();
		}

		if (!isset($this->messages[$id]))
		{
			// Request the selected id
			$jinput = JFactory::getApplication()->input;
			$id     = $jinput->get('id', 1, 'INT');

			// Get a TableHelloWorld instance
			$table = $this->getTable();

			// Load the message
			$table->load($id);

			// Assign the message
			$this->messages[$id] = $table->greeting;
		}

		return $this->messages[$id];
	}
}

The model now asks the TableHelloWorld to get the message. This table class has to be defined in admin/tables/helloworld.php file

admin/tables/helloworld.php

<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */
// No direct access
defined('_JEXEC') or die('Restricted access');

/**
 * Hello Table class
 *
 * @since  0.0.1
 */
class HelloWorldTableHelloWorld extends JTable
{
	/**
	 * Constructor
	 *
	 * @param   JDatabaseDriver  &$db  A database connector object
	 */
	function __construct(&$db)
	{
		parent::__construct('#__helloworld', 'id', $db);
	}
}

You shouldn't see any differences, but if you access the database you should see a table named jos_helloworld with two columns: id and greeting. And two entries: Hello World! and Good bye World.

Die Komponente zur Bereitstellung vorbereiten

Inhalt des Verzeichnisses mit dem Code

Es kann eine komprimierte Datei aus diesem Verzeichnis erstellt werden oder diese direkt von archive heruntergeladen werden. Die Datei kann dann über die Installation für Erweiterungen in Joomla installiert werden. Es kann dann ein Menüpunkt dieser Komponente über den Menümanager im Backend hinzugefügt werden.

General Information

Mitwirkende

Prev: Adding a variable request in the menu type

Next: Basic backend

J3.x

J3.x: Entwicklung einer MVC Komponente/Verwendung der Datenbank

From Joomla! Documentation

< J3.x:Developing an MVC Component

Contents