J3.x

Desarrollo de un Componente MVC/Utilizando la base de datos

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
Tutorial
Desarrollo de un Componente MVC


Esta es una serie multi-artículos de tutoriales sobre cómo desarrollar un Componente Modelo-Vista-Controlador para Joomla! VersiónJoomla 3.x.

Comenzar con la Introducción, y navegar por los artículos de esta serie usando el botón de navegación en la parte inferior o en el cuadro de la derecha (los "Artículos de esta serie").



Introducción

Este artículo es parte del tutorial Desarrollo de un Componente MVC para Joomla! 3.3. Te invitamos a leer las partes anteriores del tutorial antes de leer esto. Además, al leer esta parte, también te recomendamos que leas más, sobre consultas de bases de datos, selección de datos de una tabla de base de datos y el recupero en varios formatos aquí.

También hay 3 videos (en inglés) asociados con este paso del tutorial, que cubren la configuración de la base de datos, Mostrar el mensaje (usando JTable) y Selección del mensaje de administración (y JDatabase).

Utilizando la base de datos

Los componentes suelen administrar su contenido utilizando la base de datos. Durante la fase instalar/desinstalar/actualizar de un componente, puede ejecutar consultas SQL mediante el uso de archivos de texto SQL.

Con tu administrador y editor de archivos favoritos crea dos archivos llamados admin/sql/install.mysql.utf8.sql y admin/sql/updates/mysql/0.0.6.sql. Ambos deben tener el mismo contenido, de la siguiente manera:

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

Nota. Hoy en día, Joomla recomienda especificar

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

en lugar de lo que está arriba. InnoDB es el motor de base de datos MySQL más moderno (y ahora predeterminado), que reemplaza a MyISAM, y utf8mb4 admite una gama más amplia de juegos de caracteres, incluidos los emojis. Sin embargo, no he probado todos los pasos en el tutorial con esta configuración, por lo que si lo usas y sigues la serie completa de tutoriales y no encuentras problemas, considera actualizar este archivo y dónde se encuentra en otros pasos del tutorial.

También ten en cuenta que si observas una base de datos Joomla, muchas de las tablas de la base de datos clave tienen un campo llamado "title" para el tipo de información que estamos almacenando en nuestro campo "saludo". En general, es recomendable seguir el patrón de Joomla y usar 'title' como nombre de campo, ya que cuando intentamos usar una funcionalidad más compleja (como ACL y asociaciones), algunas de las rutinas de JavaScript de Joomla que queremos reutilizar esperan que este presente un campo 'title'. (Algo a considerar cambiar cuando esta serie de tutoriales se actualice a futuro).

A menudo, encontrarás que la tabla de la base de datos tiene un campo para realizar un seguimiento del estado publicado/no publicado de un elemento. No se recomienda usar el nombre 'state' dentro de Joomla ya que puede generar conflictos, en lugar de eso, se usa el nombre 'published'.
Nota: ¿Cómo decirle a Joomla que almacene el valor del campo de formulario publicado en un campo de base de datos de nombre diferente? Hacemos esto usando el método setColumnAlias() (desde 3.4.0).

El archivo install.mysql.utf8.sql se ejecuta cuando se instala este componente. El archivo 0.0.6.sql se ejecuta cuando se realiza una actualización.

Este es el archivo de instalación. Será ejecutado si pones una orden apropiada en el archivo helloworld.xml.

Nota importante: A la hora de guardar los archivos de SQL en utf8, asegúrate de guardar como utf8 SIN BOM o la consulta producirá el error MySQL #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>

Hacer lo mismo para el archivo de desinstalación:

Con tu administrador y editor de archivos favoritos coloca un archivo admin/sql/uninstall.mysql.utf8.sql que contenga:

admin/sql/uninstall.mysql.utf8.sql

DROP TABLE IF EXISTS `#__helloworld`;

Esquema de Numeración

Tu componente tiene un número de versión (que se especifica dentro de la etiqueta version> en tu archivo de manifiesto helloword.xml) y el esquema de la base de datos de tu componente tiene su propio número de versión (que se basa en los nombres de archivo de los archivos de actualización sql).

Joomla! realiza un seguimiento del esquema de versiones de la base de datos de tu componente a través de un registro en su tabla #__schemas. Entonces, cuando instalas un componente por primera vez, si hay un archivo llamado, digamos, admin/sql/updates/mysql/0.0.6.sql, entonces Joomla! almacenará el valor 0.0.6 es su registro de esquemas.

La próxima vez que instales una versión más nueva de este componente, no tiene que ser la siguiente versión, puedes omitir versiones, Joomla! hará lo siguiente:

  • Recuperará la última versión del esquema de la base de datos del componente desde su tabla #__schemas, por lo que podría encontrar como en nuestro ejemplo el valor 0.0.6.
  • obtendrá los nombres de archivo de todos los archivos en el directorio admin/sql/updates/mysql/, y los organizará en orden numérico creciente.
  • procesará en orden los archivos de actualización que tienen nombres de archivo numéricamente después de la versión del esquema actual, por lo que podría encontrar archivos llamados 0.0.7.sql, 0.0.9.sql y 0.0.10.sql, y procesarlos en orden.
  • actualizará el registro de esquemas para tener el número del último archivo de actualización que procesó, por ejemplo, 0.0.10.

Si ya has lanzado versiones de tu componente cuando se introduce el uso de la base de datos, como hemos simulado en esta serie de tutoriales, entonces tu primer archivo de actualización debe tener exactamente el mismo contenido que el archivo de instalación. Si no lo has hecho, entonces debería estar vacío.

Aunque puede ser una buena idea mantener los dos números de versión iguales, no es necesario. Joomla! toma la versión de esquema del nombre del último archivo numéricamente actualizado. Es por eso que se recomienda que haya un archivo de actualización inicial, incluso si está vacío. Si deseas mantener tus números de esquema en sintonía con los números de versión del componente cuando actualizas tu código pero no el esquema de la base de datos, simplemente incluye un archivo de actualización con el nuevo número de versión, y ese archivo de actualización también estará vacío .

A medida que realices versiones posteriores de tu componente, el archivo de instalación de la base de datos siempre debe contener el esquema completo y los archivos de actualización solo deben contener los cambios que hayas realizado en el esquema desde la última actualización.

La adición de un nuevo tipo de campo

Por el momento, hemos utilizado un tipo de campo codificado fijo para los mensajes. Necesitamos utilizar nuestra base de datos para elegir el mensaje, y para esto tenemos que definir un tipo de campo personalizado (que a continuación llamamos helloworld) como se describe aquí.

Modificar el archivo site/views/helloworld/tmpl/default.xml y colocar estas líneas

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>

Se introduce un nuevo tipo de campo y le dice a Joomla que busque la definición del campo en la carpeta /administrator/components/com_helloworld/models/fields.

Para obtener más información sobre las consultas de bases de datos, seleccionar datos de una tabla de base de datos y recuperarlos en varios formatos has clic aquí. Con tu administrador y editor de archivos favoritos coloca un archivo en admin/models/fields/helloworld.php que contenga:

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

El nuevo tipo de campo muestra una lista desplegable con los mensajes a elegir. Puedes ver el resultado de este cambio en el menú del administrador en la sección del elemento helloworld.

Mostrar el mensaje escogido

Cuando un elemento del menú de este componente se crea/actualiza, Joomla! almacena el identificador del mensaje. El modelo HelloWorldModelHelloWorld calcula ahora el mensaje de acuerdo a este identificador y los datos almacenados en la base de datos. Para hacerlo, utiliza la funcionalidad JTable, que es una alternativa a JDatabase si solo se requieren operaciones CRUD en registros individuales.

Modifica el archivo site/models/helloworld.php:

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

El modelo consulta ahora la TableHelloWorld para obtener el mensaje. Esta clase table tiene que ser definida en el archivo admin/tables/helloworld.php

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

No deberías ver ninguna diferencia, pero si tienes acceso a la base de datos deberías ver una tabla denominada jos_helloworld con dos columnas: id y greeting. Y dos entradas: Hello World! y Good bye World.

Empaquetado del componente

El contenido de tu directorio de código

Crea un archivo comprimido de este directorio o descarga directamente el archivo e instálalo con el gestor de extensiones de Joomla. Puedes agregar un elemento de menú de este componente usando el gestor de menús en el lado del servidor.

Info non-talk.png
General Information

Por favor, crea una petición o tema en https://github.com/joomla/Joomla-3.2-Hello-World-Component para cualquier discrepancia en el código o para la edición de cualquier parte del código fuente de esta página.

Colaboradores