J3.x

Het ontwikkelen van een MVC component - De database gebruiken

From Joomla! Documentation

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

Other languages:
العربية • ‎English • ‎español • ‎français • ‎Nederlands
Joomla! 
3.x
Handleiding
Het ontwikkelen van een MVC component


Dit is een reeks van artikelen met handleidingen over het ontwikkelen van een Model-View-Controller Component voor Joomla! versieJoomla 3.x.

Begin met de Introductie en navigeer door de artikelen van de reeks door middel van de navigatieknop onderaan of het vak rechts (Artikelen in deze reeks).



Inleiding

Deze handleiding is een onderdeel van de Het ontwikkelen van een MVC Component voor Joomla! 3.3 uitleg. Het is aan te raden om de vorige delen van deze handleiding te lezen voordat u dit onderdeel leest. Het wordt ook aanbevolen om meer te lezen over database queries, data selecteren uit een database tabel en het opvragen in verschillende formaten hiervan.

Er zijn ook 3 videos gerelateerd aan deze stap in de handleiding, handelend over de database opzet, weergeven van het bericht (gebruikmakend van JTable) en Admin bericht selectie (en JDatabase).

De database gebruiken

Componenten beheren gewoonlijk hun inhoud met behulp van de database. Tijdens de installatie/de-installatie fase van een component, kunt u SQL query's uitvoeren met behulp van SQL-tekstbestanden.

Maak met uw voorkeur editor twee bestanden aan genaamd admin/sql/install.mysql.utf8.sql en admin/sql/updates/mysql/0.0.6.sql. Ze moeten beide dezelfde inhoud heb:

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!');

Het bestand install.mysql.utf8.sql zal worden uitgevoerd als u deze component installeert. Het bestand 0.0.6.sql wordt uitgevoerd als u een update doet.

Dit is het installatie bestand. Het wordt uitgevoerd als er een juist commando in het helloworld.xml bestand staat.

Belangrijke opmerking: Verzeker u ervan dat u de SQL-bestanden opslaat als utf8 NOT BOM, anders mislukt de query met MySQL error #1064.

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>

Doe hetzelfde voor het deinstallatie bestand:

Plaats met uw favoriete editor een bestand admin/sql/uninstall.mysql.utf8.sql dat bevat:

admin/sql/uninstall.mysql.utf8.sql

DROP TABLE IF EXISTS `#__helloworld`;

Schema nummering

Uw component heeft een versienummer (die gespecificeerd wordt in de <version> tag in uw helloword.xml manifest bestand), en uw component's database schema heeft zijn eigen versienummer (die gebaseerd is op de bestandnamen van de sql update bestanden).

Joomla houdt de database schema versie van uw component bij door middel van een record in de #__schemas tabel. Dus wanneer u voor het eerst een component installeert, en er een bestand is dat bijvoorbeeld genaamd is admin/sql/updates/mysql/0.0.6.sql, dan zal Joomla de waarde 0.0.6 in het schemas record bewaren.

Wanneer u vervolgens een nieuwe versie installeert van dit component - het hoeft niet de volgende versie te zijn, u kunt versies overslaan - zal Joomla het volgende doen:

  • het zal de laatste database schema versie ophalen van de #__schemas tabel - dus het zal in ons voorbeeld de waarde 0.0.6 vinden.
  • het zal de bestandsnamen van alle bestanden in de admin/sql/updates/mysql/ map ophalen en die in numerieke oplopende volgorde zetten.
  • het zal de updatebestanden, die numerieke bestandsnamen hebben volgend op het huidige schema versie, in volgorde verwerken - dus het zou bestanden kunnen vinden genaamd 0.0.7.sql, 0.0.9.sql en 0.0.10.sql, en ze in die volgorde verwerken.
  • het zal de schemas record updaten naar het nummer van het laatste updatebestand dat verwerkt is - bijv. 0.0.10.

Indien u al versies uitgegeven hebt van uw component voordat gebruik van de database geïntroduceerd werd, zoals we dat in deze handleiding hebben gedaan, dan moet uw eerste updatebestand precies dezelfde inhoud hebben als het installatiebestand. Wanneer dat niet het geval is dan moet het leeg zijn.

Hoewel het een goed idee is om beide versienummers gelijk te houden is dit niet perse noodzakelijk. Joomla neemt de schema versie over van de naam van het laatste numerieke updatebestand. Daarom is het ook aanbevolen dat er een initieel updatebestand aanwezig is, zelfs wanneer het leeg is. Als u de updatenummers gelijk wilt houden met de component versienummers wanneer u uw code update maar het database schema niet, voegt u eenvoudig een updatebestand toe die gelijk is aan het nieuwe versienummer van de component, dat updatebestand zal dan ook leeg zijn.

Voor de opeenvolgende vrijgaves van uw component moet het database installatiebestand altijd het volledige schema bevatten en de updatebestanden hoeven alleen de wijzigingen te bevatten sinds de laatste update.

Het toevoegen van een nieuw veldtype

We hebben tot nu toe een hard gecodeerd veldtype voor berichten gebruikt. We moeten onze database gebruiken om het bericht te kiezen, en hiervoor moeten we een custom field type defeniëren (die we helloworld noemen hieronder) zoals hier. beschreven.

Wijzig het site/views/helloworld/tmpl/default.xml bestand en plaats deze regels

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>

Het introduceert een nieuw veldtype en vertelt Joomla naar de velddefinitie te kijken in de /administrator/components/com_helloworld/models/fields map.

Om meer over database queries te leren, het selecteren van data uit een database tabel en het verkrijgen in diverse formats klik hier. Plaats, met uw favoriete editor een bestand admin/models/fields/helloworld.php dat bevat:

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;
	}
}

Het nieuwe veldtype toont een drop-down lijst met berichten waaruit gekozen kan worden. U kunt het resultaat van deze wijziging zien in de menubeheer sectie van het helloworld item.

Toon het gekozen bericht

Wanneer een menu-item van dit component wordt gemaakt/bijgewerkt bewaart Joomla de identifier van het bericht. De HelloWorldModelHelloWorld model moet nu het bericht overeenkomend met de identifier en de data die is bewaard in de database berekenen. Om dit te doen gebruikt het de JTable functionaliteit, hetgeen een alternatief is van JDatabase als alleen CRUD handelingen op enkelvoudige records vereist zijn.

Wijzig het site/models/helloworld.php bestand:

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];
	}
}

Het model vraagt de TableHelloWorld nu om het bericht op te halen. Deze tabel class moet gedefinieerd zijn in het admin/tables/helloworld.php bestand

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);
	}
}

U zou geen verschillen moeten zien, maar als u de database bekijkt zou u een tabel moeten zien genaamd jos_helloworld met twee kolommen: id en greeting. En twee items: Hello World! en Good bye World.

Inpakken van de component

De inhoud van uw code map

Maak een gecomprimeerd bestand aan van deze map of download direct het archief en installeer het via Extensiebeheer van Joomla. U kunt een menu-item aanmaken voor deze component met behulp van het menubeheer in het beheergedeelte.

Info non-talk.png
General Information

Maak alstublieft een pull request of issue aan op https://github.com/joomla/Joomla-3.2-Hello-World-Component voor enige foute code of een wijziging van de broncode op deze pagina.

Bijdragers