J3.x

J3.x:تطوير مكون MVC/استخدام قواعد البيانات

< 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 45% complete.

Outdated translations are marked like this.
Other languages:
العربية • ‎English • ‎español • ‎français • ‎Nederlands
Joomla! 
3.x
درس
تطوير مكون MVC


هذه سلسلة من عدة مقالات من الدروس حول كيفية تطوير موديل-عرض-موجه مكون لنسخة Joomla! Joomla 3.x.

تبدأ مع مقدمة, وتستعرض المقالات في هذه السلسلة باستخدام زر التنقل في الأسفل أو الصندوق الأيمن ("المقالات في هذه السلسلة").



مقدمة

هذا الدرس هو جزء من درس تطوير مكون MVC لـ Joomla! 3.3 . نشجعك على قراءة الجزء السابق من الدرس قبل قراءة هذا الدرس.

There are also 3 videos associated with this step in the tutorial, covering the Database Setup, Displaying the message (using JTable) and Admin message selection (and JDatabase).

استخدام قواعد البيانات

المكونات عادة ما يديرون المحتويات الخاصة بهم باستخدام قواعد البيانات. خلال مراحل التثبيت/فك التثبيت/التحديث للمكون، يمكنك تنفيذ استعلامات SQL من خلال استخدام ملفات SQL نصية .

باستخدام مدير ملف والمحرر المفضل لديك انشئ ملفين باسم admin/sql/install.mysql.utf8.sql و admin/sql/updates/mysql/0.0.6.sql. يجب أن يكون الملفان بنفس المحتوى كالتالي:

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

الملف install.mysql.utf8.sql سينفذ عند تثبيت هذا المكون. الملف 0.0.6.sql سينفذ عندما تقوم بتحديث.

ملاحظة مهمة: عندما يتم تثبيت المكون, الملفات في فهرس تحديث SQL (على سبيل المثال, admin/sql/updates/mysql) يتم قرائتها واسم آخر ملف بشكل أبجدي يستخدم لينشيء رقم نسخة المكون في جدول #__schemas. هذه القيمة يجب أن تكون في هذا الجدول لكي يقوم التحديث التلقائي بتنفيذ ملفات تحديث SQL للنسخ المقبلة . For this reason, it is good practice to create a SQLولهذا السبب، فإنه استعمال جيد أن تنشئ ملف تحديث SQL لكل نسخة (حتى لو كانت فارغة أو فيها تعليق). وبهذه الطريقة سيتطابق دوما #__schemas مع نسخة المكون.

ملاحظة مهمة: عند حفظ ملفات SQL بـ utf8 تأكد أن تحفظهم كـ utf8 NOT BOM وإلا سيفشل الاستعلام مع رسالة MySQL error #1064.

هذا هو ملف التثبيت. سيتم تنفيذه إذا وضعت الترتيب المناسب في ملف helloworld.xml

helloworld.xml

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

	<name>Hello World!</name>
	<!-- The following elements are optional and free of formatting constraints -->
	<creationDate>January 2014</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>

افعل نفس الشيء مع ملف فك التثبيت

مع مدير ملف و المحرر المفضل لديك ضع ملف admin/sql/uninstall.mysql.utf8.sql يحتوي:

admin/sql/uninstall.mysql.utf8.sql

DROP TABLE IF EXISTS `#__helloworld`;

اضافة نوع حقل جديد

الى الآن، استخدمنا hard coded field type for messages. نريد استعمال قاعدة بياناتنا لاختيار الرسالة.

عدل ملف site/views/helloworld/tmpl/default.xml وضع هذه السطور

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>

ستقدم نوع حقل جديد وتخبر Joomla! أن تبحث عن تعريف الحقل في فهرس /administrator/components/com_helloworld/models/fields

باستخدام مدير الملف المفضل لديك والمحرر ضع ملف admin/models/fields/helloworld.php يحتوي :

نوع الحقل الجديد يعرض لائحة منسدلة من الرسائل لتختار منها. يمكنك رؤية النتيجة لهذه التغييرات في قسم مدير القائمة لعنصر helloworld

admin/models/fields/helloworld.php

<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2015 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;
	}
}

عرض الرسالة المختارة

عندما يتم انشاء أو تعديل عنصر القائمة لهذا المكون، ستحفظ Joomla! معرف هذه الرسالة. على الموديل HelloWorldModelHelloWorld الآن حساب الرسالة تبعا لهذا المعرف وستحفظ البيانات في قاعدة البيانات.

تعديل ملف site/models/helloworld.php :

يسأل الموديل الآن TableHelloWorld لأخذ الرسالة. وصنف الجدول هذا يجب أن يحدد في ملف admin/tables/helloworld.php

site/models/helloworld.php

<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2015 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];
	}
}

يجب أن لا ترى اختلافا، ولكن لو دخلت الى قاعدة البيانات فسترى جدول باسم jos_helloworld بعمودين: id و greeting. وادخالين: Hello World! و Good bye World.

admin/tables/helloworld.php

<?php
/**
 * @package     Joomla.Administrator
 * @subpackage  com_helloworld
 *
 * @copyright   Copyright (C) 2005 - 2015 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);
	}
}

حزم المكون

محتوياات فهرس الشفرة الخاص بك

انشئ ملف مضغوط عن هذا الفهرس أو حمل مباشرة من archive وثبته باستخدام مدير الملحقات في Joomla!. بامكانك اضافة عنصر قائمة لهذا المكون باستخدام مدير القائمة في الخلفية.

الرجاء انشاء طلب سحب أو مشكلة على https://github.com/joomla/Joomla-3.2-Hello-World-Component لأي اختلافات في الكود أو أي تعديل في شفرة المصدر على هذه الصفحة.

Info non-talk.png
General Information

السابق: اضافة طلب متغير في نوع القائمة

Contributors

Advertisement