Estructura de un módulo de prestashop
- User
Estructura de un módulo de prestashop
Assistant
Aquí tienes una explicación detallada de la estructura de un módulo en PrestaShop, incluyendo sus componentes clave y cómo organizarlos:
1. Estructura básica de un módulo
Un módulo en PrestaShop se organiza en una carpeta con un nombre único, dentro de la carpeta
modules/de tu instalación de PrestaShop. La estructura típica es:tu_modulo/ ├── admin/ │ ├── controllers/ │ ├── views/ │ │ ├── templates/ │ │ │ ├── configure.tpl # Plantilla de configuración │ │ │ └── ... │ └── ... ├── classes/ │ └── TuClase.php # Clases personalizadas (opcional) ├── config/ │ └── ps.php # Configuración de compatibilidad con PrestaShop ├── langs/ │ └── es.php # Archivo de traducciones (ejemplo para español) ├── views/ │ └── templates/ │ └── hook/ │ └── displayTuHook.tpl # Plantilla para hooks front-end ├── tu_modulo.php # Archivo principal del módulo └── module.xml # Archivo de manifiesto del módulo
2. Componentes clave de un módulo
a. Archivo principal del módulo (
tu_modulo.php)Este es el corazón del módulo. Debe extender la clase
Modulede PrestaShop y definir su funcionalidad.Ejemplo básico:
<?php if (!defined('_PS_VERSION_')) { exit; } class TuModulo extends Module { public function __construct() { $this->name = 'tumodulo'; // Nombre del módulo (en minúsculas y sin espacios) $this->tab = 'front_office_features'; // Categoría en la que aparecerá en el back-office $this->version = '1.0.0'; $this->author = 'Tu nombre'; $this->need_instance = 0; // 1 si el módulo requiere instanciación $this->ps_versions_compliancy = ['min' => '1.7.0', 'max' => _PS_VERSION_]; // Versión de PrestaShop compatible $this->bootstrap = true; // Usa Bootstrap 3/4/5 parent::__construct(); $this->displayName = $this->l('Nombre del Módulo'); $this->description = $this->l('Descripción del módulo'); } // Método para instalar el módulo public function install() { return parent::install() && $this->registerHook('displayHeader') // Registra un hook && $this->registerHook('displayFooter'); } // Método para desinstalar el módulo public function uninstall() { return parent::uninstall(); } // Método para mostrar el contenido de la configuración en el back-office public function getContent() { $output = ''; if (Tools::isSubmit('submitTuModulo')) { // Procesar formulario de configuración $this->postProcess(); $output .= $this->displayConfirmation($this->l('Configuración guardada')); } return $output . $this->renderForm(); } // Método para renderizar el formulario de configuración protected function renderForm() { $fields_form = array( 'form' => array( 'legend' => array( 'title' => $this->l('Configuración'), ), 'input' => array( array( 'type' => 'text', 'label' => $this->l('Texto de ejemplo'), 'name' => 'TUMODULO_TEXT', 'size' => 20, 'required' => true, ), ), 'submit' => array( 'title' => $this->l('Guardar'), 'class' => 'btn btn-default pull-right', ), ), ); $helper = new HelperForm(); $helper->show_toolbar = false; $helper->table = $this->table; $helper->module = $this; $helper->default_form_language = $this->context->language->id; $helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG', 0); $helper->identifier = $this->identifier; $helper->submit_action = 'submitTuModulo'; $helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false) . '&configure=' . $this->name . '&tab_module=' . $this->tab . '&module_name=' . $this->name; $helper->token = Tools::getAdminTokenLite('AdminModules'); $helper->fields_value['TUMODULO_TEXT'] = Configuration::get('TUMODULO_TEXT'); return $helper->generateForm(array($fields_form)); } // Método para procesar el formulario de configuración protected function postProcess() { Configuration::updateValue('TUMODULO_TEXT', Tools::getValue('TUMODULO_TEXT')); } // Método para el hook displayHeader public function hookDisplayHeader() { // Agregar CSS o JavaScript al header del sitio $this->context->controller->addCSS($this->_path . 'views/css/estilos.css'); } // Método para el hook displayFooter public function hookDisplayFooter() { // Mostrar contenido en el footer return $this->fetch('module:tumodulo/views/templates/hook/displayFooter.tpl'); } }
b. Archivo de manifiesto (
module.xml)Este archivo define metadatos del módulo y su compatibilidad con PrestaShop.
Ejemplo:
<?xml version="1.0" encoding="UTF-8"?> <module> <name>tumodulo</name> <displayName><![CDATA[Nombre del Módulo]]></displayName> <version>1.0.0</version> <author>Tu nombre</author> <description><![CDATA[Descripción del módulo]]></description> <compatibility> <version_from>1.7.0.0</version_from> <version_to>1.7.99.99</version_to> </compatibility> <is_configurable>true</is_configurable> <need_instance>false</need_instance> <tab>front_office_features</tab> <ps_type>official</ps_type> <display_name><![CDATA[Nombre del Módulo]]></display_name> </module>
c. Plantillas (Templates)
- Back-office: Archivos
.tplenadmin/views/templates/para la interfaz de configuración. - Front-office: Archivos
.tplenviews/templates/hook/para contenido mostrado en la tienda (ej: banners, formularios).
Ejemplo de plantilla (
displayFooter.tpl):<div class="tu-modulo"> <p>¡Hola desde el módulo!</p> </div>
d. Configuración del módulo
- Variables de configuración: Usar
Configuration::updateValue()yConfiguration::get()para almacenar/recuperar datos. - Archivos de traducción: En
langs/, por ejemploes.phppara español:<?php return array( 'TUMODULO_TEXT' => 'Texto por defecto', 'Nombre del Módulo' => 'Nombre del Módulo', 'Descripción del módulo' => 'Descripción del módulo', );
e. Hooks
Los hooks permiten al módulo interactuar con PrestaShop. Ejemplos de hooks comunes:
displayHeader: Agregar CSS/JS.displayFooter: Mostrar contenido en el footer.actionOrderStatusPostUpdate: Ejecutar acciones al actualizar el estado de un pedido.displayProductAdditionalInfo: Mostrar información adicional en la ficha de producto.
Para registrar un hook, usa:
$this->registerHook('nombre_del_hook');
f. Base de datos
Si el módulo requiere tablas personalizadas, crea un método
install()que las cree:public function install() { return parent::install() && $this->registerHook('displayHeader') && $this->createTable(); } protected function createTable() { return Db::getInstance()->execute( 'CREATE TABLE IF NOT EXISTS `'._DB_PREFIX_.'tu_modulo` ( `id` INT(11) NOT NULL AUTO_INCREMENT, `nombre` VARCHAR(255) NOT NULL, PRIMARY KEY (`id`) ) ENGINE='._MYSQL_ENGINE_.' DEFAULT CHARSET=utf8;' ); }
3. Pasos para crear un módulo
- Crear la carpeta del módulo en
modules/tu_modulo/. - Crear el archivo principal
tu_modulo.phpcon la clase del módulo. - Registrar hooks en el método
install(). - Crear plantillas para el front-office/back-office.
- Traducir el módulo en el archivo
module.xmly enlangs/*.php. - Probar el módulo en PrestaShop:
- Ir a Módulos > Buscar módulos y activar el módulo.
- Configurarlo en Módulos > Configurar módulo.
4. Recursos adicionales
- Documentación oficial: PrestaShop Module Development.
- Guías de hooks: Lista de hooks disponibles.
- Ejemplos de código: Revisa módulos de la tienda de PrestaShop o repositorios como PrestaShop Modules.
5. Consejos importantes
- Seguridad: Sanitiza las entradas y usa
Tools::getValue()para obtener datos. - Mejoras de rendimiento: Evita consultas repetidas y usa caché si es necesario.
- Pruebas: Usa herramientas como PHPUnit para testear tu módulo.
- Actualizaciones: Asegúrate de que el módulo sea compatible con futuras versiones de PrestaShop.
Si necesitas más detalles sobre algún componente específico, ¡avísame! 😊
- Back-office: Archivos
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.