Het ontwikkelen van een MVC Component - Basis Beheergedeelte

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

Other languages:

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

Joomla!

3.x

Handleiding

Het ontwikkelen van een MVC component

Artikelen in deze reeks

Het toevoegen van een view aan de website

Het toevoegen van een menu aan de website

Het toevoegen van een model aan de website

Een 'variable request' toevoegen in het menu type

De database gebruiken

Basis beheergedeelte

Het toevoegen van taalbeheer

Het toevoegen van acties in het beheergedeelte

Het toevoegen van decoraties aan het beheergedeelte

Het toevoegen van controles

Het toevoegen van categorieën

Het toevoegen van configuratie

Het toevoegen van ACL

Het toevoegen van een installatie/deïnstallatie/update script-bestand

Een formulier op de website toevoegen

Het gebruik van de taal filterfunctie

Het toevoegen van een update-server

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

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.2 uitleg. Het is aan te raden om de vorige delen van deze handleiding te lezen voordat u dit onderdeel leest.

Er zijn 2 videos gerelateerd aan deze stap in de handleiding, handelend over MVC structuur en paginering, en HTML elementen en Javascript code.

Basis beheergedeelte

Om de interface van het beheergedeelte te ontwerpen moet er tenminste een Model-View-Controller trio gemaakt worden. We moeten het toegangspunt van de administrator bewerken van ons component, het admin/helloworld.php bestand.

admin/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');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$controller->execute(JFactory::getApplication()->input->get('task'));

// Redirect if set by the controller
$controller->redirect();

Maak de algemene controller

Het toegangspunt krijgt nu een instantie van een controller met het voorvoegsel HelloWorld. We maken een basis controller voor het administrator gedeelte:

admin/controller.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');

/**
 * General Controller of HelloWorld component
 *
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 * @since       0.0.7
 */
class HelloWorldController extends JControllerLegacy
{
	/**
	 * The default view for the display method.
	 *
	 * @var string
	 * @since 12.2
	 */
	protected $default_view = 'helloworlds';
}

Deze controller zal de 'HelloWorlds' view als standaard weergeven.

Maak de view

Maak met de bestandmanager en editor van uw voorkeur een bestand admin/views/helloworlds/view.html.php dat bevat:

admin/views/helloworlds/view.html.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');

/**
 * HelloWorlds View
 *
 * @since  0.0.1
 */
class HelloWorldViewHelloWorlds extends JViewLegacy
{
	/**
	 * Display the Hello World view
	 *
	 * @param   string  $tpl  The name of the template file to parse; automatically searches through the template paths.
	 *
	 * @return  void
	 */
	function display($tpl = null)
	{
		// Get data from the model
		$this->items		= $this->get('Items');
		$this->pagination	= $this->get('Pagination');

		// Check for errors.
		if (count($errors = $this->get('Errors')))
		{
			JError::raiseError(500, implode('<br />', $errors));

			return false;
		}

		// Display the template
		parent::display($tpl);
	}
}

In Joomla, geven views data weer met gebruik van layout. Maak met de bestandsmanager en editor van uw voorkeur een bestand admin/views/helloworlds/tmpl/default.php dat bevat

admin/views/helloworlds/tmpl/default.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');
?>
<form action="index.php?option=com_helloworld&view=helloworlds" method="post" id="adminForm" name="adminForm">
	<table class="table table-striped table-hover">
		<thead>
		<tr>
			<th width="1%"><?php echo JText::_('COM_HELLOWORLD_NUM'); ?></th>
			<th width="2%">
				<?php echo JHtml::_('grid.checkall'); ?>
			</th>
			<th width="90%">
				<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_NAME') ;?>
			</th>
			<th width="5%">
				<?php echo JText::_('COM_HELLOWORLD_PUBLISHED'); ?>
			</th>
			<th width="2%">
				<?php echo JText::_('COM_HELLOWORLD_ID'); ?>
			</th>
		</tr>
		</thead>
		<tfoot>
			<tr>
				<td colspan="5">
					<?php echo $this->pagination->getListFooter(); ?>
				</td>
			</tr>
		</tfoot>
		<tbody>
			<?php if (!empty($this->items)) : ?>
				<?php foreach ($this->items as $i => $row) : ?>

					<tr>
						<td>
							<?php echo $this->pagination->getRowOffset($i); ?>
						</td>
						<td>
							<?php echo JHtml::_('grid.id', $i, $row->id); ?>
						</td>
						<td>
							<?php echo $row->greeting; ?>
						</td>
						<td align="center">
							<?php echo JHtml::_('jgrid.published', $row->published, $i, 'helloworlds.', true, 'cb'); ?>
						</td>
						<td align="center">
							<?php echo $row->id; ?>
						</td>
					</tr>
				<?php endforeach; ?>
			<?php endif; ?>
		</tbody>
	</table>
</form>

COM_HELLOWORLD_HELLOWORLDS_NAME, COM_HELLOWORLD_ID en de andere zijn aanduidingen die later vervangen worden met taal-specifieke tekst. De JText::_ methode vertaalt een string naar de huidige taal.

checkAll is een javascript functie gedefinieerd in de Joomla core die alle items kan controleren.

JHtml::_ is een helper functie die allerlei HTML uitvoer kan weergeven. In dit geval zal het een selectievakje voor het item weergeven.

JPagination is een Joomla class die pagineringsobjecten kan beheren en weergeven.

Maak de model

De HelloWorlds view vraagt de model om data. In Joomla bestaat er een class die een lijst data kan beheren: JModelList. Class JModelList en onderliggende classes hebben slechts een methode nodig:

getListQuery die een SQL query bouwt

en twee verklaringen:

list.start voor het bepalen van het uitgangspunt van de lijst
list.limit voor het bepalen van de lengte van de lijst

De getItems en getPagination methodes zijn gedefinieerd in JModelList class. Ze hoeven niet gedefinieerd te worden in de HelloWorldModelHelloWorlds class.

admin/models/helloworlds.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');

/**
 * HelloWorldList Model
 *
 * @since  0.0.1
 */
class HelloWorldModelHelloWorlds extends JModelList
{
	/**
	 * Method to build an SQL query to load the list data.
	 *
	 * @return      string  An SQL query
	 */
	protected function getListQuery()
	{
		// Initialize variables.
		$db    = JFactory::getDbo();
		$query = $db->getQuery(true);

		// Create the base select statement.
		$query->select('*')
                ->from($db->quoteName('#__helloworld'));

		return $query;
	}
}

The _populateState methode wordt, standaard, automatisch aangeroepen wanneer een verklaring wordt gelezen door de getState methode.

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.

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.7</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>
			<filename>controller.php</filename>
			<!-- SQL files section -->
			<folder>sql</folder>
			<!-- tables files section -->
			<folder>tables</folder>
			<!-- models files section -->
			<folder>models</folder>
			<!-- views files section -->
			<folder>views</folder>
		</files>
	</administration>

</extension>

Nu kunt u in uw component hello-world een reeks zien met twee kolommen, twee rijen en twee selectievakjes. U kunt op de selectievakjes klikken om de verschillende opties te selecteren die u wilt.

General Information

Bijdragers

Vorige: De database gebruiken

Volgende: Toevoegen van taalbeheer

J3.x

Het ontwikkelen van een MVC Component - Basis Beheergedeelte

From Joomla! Documentation

< J3.x:Developing an MVC Component

Contents

Inleiding

Basis beheergedeelte

Maak de algemene controller

Maak de view

Maak de model

Inpakken van de component

Bijdragers