Tabla de contenidos

...

Creación de un módulo de PrestaShop

...

Quizás el interés principal de un módulo es agregar funciones a PrestaShop sin tener que editar sus archivos principales, haciéndolo más fácil para realizar una actualización sin necesidad de transponer todos los cambios fundamentales.

Esa es la forma en que deben debe tratar de mantenerse alejado de los archivos centrales cuando construya un módulo, aunque esto puede resultar difícil de realizar en algunas situaciones...

...

El archivo mymodule.php debe comenzar con la siguiente prueba:

if ( !defined( '_PS_VERSION_' ) )
  exit;

Esto comprueba la existencia de una constante de PHP, y si no existe, abandona. El único propósito de esta prueba es evitar que los visitantes cargauen carguen este archivo directamente.

...

Esa clase debe tener el mismo nombre que el módulo y su carpeta, en CamelCase: MyModule.
Por otra parte, la clase debe extender la clase Module y por lo tanto hereda todos los métodos y atributos. Esta puede igualmente extender cualquier clase derivada del Module: PaymentModule, ModuleGridEngine, ModuleGraph...

<?php
if ( !defined( '_PS_VERSION_' ) )
  exit;

class MyModule extends Module
  {
  public function __construct()
    {
    $this->name = 'mymodule';
    $this->tab = 'Test';
    $this->version = 1.0;
    $this->author = 'Firstname Lastname';
    $this->need_instance = 0;

    parent::__construct();

    $this->displayName = $this->l( 'My module' );
    $this->description = $this->l( 'Description of my module.' );
    }

  public function install()
    {
    if ( parent::install() == false )
      return false;
    return true;
    }
  }
?>

Vamos a examinar cada línea de nuestro objeto MyModule...

public function __construct()

Define el constructor de clase.

$this->name = 'mymodule';
$this->tab = 'Test';
$this->version = 1.0;
$this->author = 'PrestaShop';

En esta Esta sección asigna unos cuantos atributos de la instancia de clase (this):

• Un atributo 'name'. Este es un identificador interno, así que hágalo único, sin caracteres especiales o espacios, y en minúsculas.
• Un atributo 'tab'. Este es el título del cuadro que deberá contener este módulo en la lista de módulos del back office de PrestaShop. Usted puede utilizar un nombre ya existente, como Products, Blocks or Stats, o uno personalizado, como lo hicimos aquí. En este último caso, un nuevo cuadro se ha creado con su título.
• Número Un número de versión para el módulo, aparece en la lista de módulos.
• Un atributo 'author'. Este se muestra en la lista de módulos de PrestaShop.

$this->need_instance = 0;

La bandera need_instance indica si se debe cargar la clase del módulo cuando se muestran los "Módulos", en la el back-office. Si se establece en 0, el módulo no cargará, por lo tanto gastará menos recursos para generar el módulo de página. Si sus módulos necesitan mostrar un mensaje de advertencia en la página "Módulos", entonces debe establecer este atributo en 1.

parent::__construct();

Llamar al constructor del padre. Esto se debe realizar antes de cualquier uso del método $this->l() y después de la creación de $this->name.

$this->displayName = $this->l( 'My module' );

Asignar un nombre público para el módulo, el cual será mostrado en la lista de módulos de back-office.
El método l() es parte de las herramientas de traducción de PrestaShop, y se explica más adelante.

$this->description = $this->l( 'Description of my module.' );

Asignación de una descripción pública para el módulo, la cual se mostrará en la lista de módulos del back-office.

public function install()
  {
  return ( parent::install() );
  }

En esta primera encarnación extremadamente simple, este método no es útil, ya que lo único que realiza es comprobar el valor devuelto por el método install() class de Módulo. Además, si no hubiéramos creado este método, el método superclase hubiera sido llamado en su lugar de todas formas, logrando que el resultado final sea idéntico.
Sin embargo, debemos mencionar que este método , ya que será muy útil una vez que tengamos que realizar las pruebas y acciones durante el proceso de instalación del módulo: crear cuadros tablas de SQL, copiar archivos, crear variables de configuración, etc.

Asimismo, el módulo debe contener un método uninstall() para contar con un proceso de desinstalación personalizado. Este método podría realizarse algo así como:

public function uninstall()
  {
  if ( !parent::uninstall() )
    Db::getInstance()->Execute( 'DELETE FROM `' . _DB_PREFIX_ . 'mymodule`' );
  parent::uninstall();
  }

Para poner "el toque final" a este módulo básico, podemos agregar un icono, que se mostrará junto al nombre del módulo en la lista de módulos de back-office.
El archivo de icono debe respetar los siguientes requisitos:

• imágenes 16*16.
• llamado nombrado logo.gif.
• colocado en la carpeta principal del módulo.

Puede encontrar un excelente conjunto de iconos gratuitus para elegir en el sitio web de FamFamFam..

Ahora que todos los fundamentos están en su lugar, coloque la carpeta del módulo en la carpeta /modules de su instalación de prueba de PrestaShop, abra PrestaShop, y en la pestaña "Módulos", bajo "Otros módulos", debería encontrar su módulo. Instálelo para ser capaz de manejarlo por el resto de esta guía.

...

Durante la instalación, PrestaShop también agrega una línea al cuadro de SQL ps_module.

Conexión de un módulo

...

a través de Hooks

Para que un módulo sea "atadoconectado" o "enganchado" a una ubicación en el front y back office, necesita ofrecerle acceso a uno de los hooks de PrestaShop, descritos anteriormente en esta guía.

En ese caso, cambiaremos el código del módulo, y agregaremos estas líneas:

public function install()
  {
  if ( parent::install() == false OR !$this->registerHook( 'leftColumn' ) )
    return false;
  return true;
  }

...

public function hookLeftColumn( $params )
  {
  global $smarty;
  return $this->display( __FILE__, 'mymodule.tpl' );
  }

public function hookRightColumn( $params )
  {
  return $this->hookLeftColumn( $params );
  }

Vamos a explorar estas nuevas líneas.

if ( parent::install() == false OR !$this->registerHook( 'leftColumn' ) )
  return false;
return true;

...

Por lo tanto, esta línea ahora se lee de esta manera: si la instalación o el “enganche” "enganche" fracasa, nosotros informamos informaremos a PrestaShop.

public function hookLeftColumn( $params )
  {
  global $smarty;
  return $this->display(__FILE__, 'mymodule.tpl');
  }

El método hookLeftColumn() hace posible que el módulo se “enganche” "enganche" en la columna izquierda del tema.
$smarty es la variable global para el sistema de plantillas Smarty, el cual utiliza PrestaShop y que tenemos que acceder.
El método display() devuelve el contenido del archivo de plantilla mymodule.tpl, si es que existe.

public function hookRightColumn( $params )
  {
  return $this->hookLeftColumn( $params );
  }

...

...

Por consiguiente, crearemos el archivo mymodule.tpl y le agregaremos algunas líneas de código.

<!-- Block mymodule -->
<div id="mymodule_block_left" class="block">
  <h4>Welcome!</h4>
  <div class="block_content">
    <ul>
      <li><a href="{$base_dir}modules/mymodule/mymodule_page.php" title="Click this link">Click me!</a></li>
    </ul>
  </div>
</div>
<!-- /Block mymodule -->

...

Welcome to my shop!

<?php
global $smarty;
include( '../../config/config.inc.php' );
include( '../../header.php' );

$smarty->display( dirname(__FILE__) . '/mymodule_page.tpl' );

include( '../../footer.php' );
?>

...

...

Por ejemplo, en nuestro mymodule_page.php, podemos crear una variable:

<?php
global $smarty;

include( '../../config/config.inc.php' );
include( '../../header.php' );

$mymodule = new MyModule();
$message = $mymodule->l( 'Welcome to my shop!' );
$smarty->assign( 'messageSmarty', $message ); // creation of our variable
$smarty->display( dirname(__FILE__) . '/mymodule_page.tpl' );

include( '../../footer.php' );
?>

A partir de ahí, podemos pedir a Smarty que muestre el contenido de esta variable en nuestro archivo TPL.

{$messageSmarty}

PrestaShop incluye una serie de variables. Por ejemplo, {$HOOK_LEFT_COLUMN} será remplazado por el contenido de la columna izquierda, es decir, el contenido de todos los módulos que han sido unidos al hook de la columna izquierda.

...

Si necesita que se muestren todas las páginas actuales de variables de Smarty, agregue la siguiente función:

{debug}

Los comentarios se basan en asterisco:

{* This string is commented out *}

{*
This string is too!
*}

...

Las cadenas en los archivos PHP necesitarán ser mostradas a través del método l(), de la clase abstracta Module.php.

...
$this->displayName = $this->l( 'My module' );
$this->description = $this->l( 'Description of my module.' );
...

Las cadenas en los archivos TPL tendrán que ser convertidas en contenido dinámico, que Smarty remplazará por la traducción del idioma elegido. En nuestro módulo de muestra, este archivo:

<li>
  <a href="{$base_dir}modules/mymodule/mymodule_page.php" title="Click this link">Click me!</a>
</li>

...se convierte en:

<li>
  <a href="{$base_dir}modules/mymodule/mymodule_page.php" title="{l s='Click this link' mod='mymodule'}">{l s='Click me!' mod='mymodule'}</a>
</li>

...

<h4>Welcome!</h4>
...
Click me!

...se convierte en:

<h4>{l s='Welcome!' mod='mymodule'}</h4>
...
{l s='Click me!' mod='mymodule'}

...

Las traducciones se guardan en un archivo nuevo, es.php (o languageCode.php, el cual es generado por PrestaShop y luce así:

<?php

global $_MODULE;
$_MODULE = array();
$_MODULE['<{mymodule}prestashop>mymodule_2ddddc2a736e4128ce1cdfd22b041e7f'] = 'Mon module';
$_MODULE['<{mymodule}prestashop>mymodule_d6968577f69f08c93c209bd8b6b3d4d5'] = 'Description de mon module';
$_MODULE['<{mymodule}prestashop>mymodule_c66b10fbf9cb6526d0f7d7a602a09b75'] = 'Cliquez sur ce lien';
$_MODULE['<{mymodule}prestashop>mymodule_f42c5e677c97b2167e7e6b1e0028ec6d'] = 'Cliquez-moi \!';
$_MODULE['<{mymodule}prestashop>mymodule_page_c0d7cffa0105851272f83d5c1fe63a1c'] = 'Bienvenue dans ma boutique \!';

...

Y podrán ser traducidas al español cuando el Back Office está se encuentre en español.

...

En esta sección usted aprenderá cómo ofrecer a su módulo, su propia pestaña o sub-pestaña en cuestión de minutos.

...

1. Agregar un nuevo cuadro a su base de datos de PrestaShop, llamado ps_test. Dele Ofrézcale dos campos:
   • id_test (INT 11)
   • test (VARCHAR 32)
2. Crear un archivo en blanco llamado Test.php en la carpeta /classes de PrestaShop.
3. Agregar las siguientes líneas a este archivo:

<?php
class Test extends ObjectModel
  {
  /** @var string Name */
  public $test;

  protected $fieldsRequired = array( 'test' );
  protected $fieldsSize = array( 'test' => 64 );
  protected $fieldsValidate = array( 'test' => 'isGenericName' );
  protected $table = 'test';
  protected $identifier = 'id_test';

  public function getFields()
    {
    parent::validateFields();
    $fields[ 'test' ] = pSQL( $this->test );
    return $fields;
    }
  }
?>

1. Crear un archivo en blanco llamado AdminTest.php en /admin/tabs de PrestaShop.
2. Agregar las siguientes líneas a este archivo:

<?php
include_once( PS_ADMIN_DIR . '/../classes/AdminTab.php' );

class AdminTest extends AdminTab
  {
  public function __construct()
    {
    $this->table = 'test';
    $this->className = 'Test';
    $this->lang = false;
    $this->edit = true;
    $this->delete = true;
    $this->fieldsDisplay = array(
      'id_test' => array(
        'title' => $this->l( 'ID' ),
        'align' => 'center',
        'width' => 25 ),
      'test' => array(
        'title' => $this->l( 'Name' ),
        'width' => 200 )
    );

    $this->identifier = 'id_test';

    parent::__construct();
    }

  public function displayForm()
    {
    global $currentIndex;

    $defaultLanguage = intval( Configuration::get( 'PS_LANG_DEFAULT' ) );
    $languages = Language::getLanguages();
    $obj = $this->loadObject( true );

    echo '
      <script type="text/javascript">
        id_language = Number('.$defaultLanguage.');
      </script>';

    echo '
      <form action="' . $currentIndex . '&submitAdd' .  $this->table . '=1&token=' . $this->token . '" method="post" class="width3">
        ' . ($obj->id ? '<input type="hidden" name="id_' . $this->table . '" value="' . $obj->id . '" />' : '').'
        <fieldset><legend><img src="../img/admin/profiles.png" />' . $this->l( 'Profiles' ) . '</legend>
          <label>'.$this->l( 'Name:' ).' </label>
          <div class="margin-form">';
    foreach ( $languages as $language )
      echo '
          <div id="name_' . $language['id_lang'|'id_lang'] . '" style="display: ' . ($language['id_lang'|'id_lang'] == $defaultLanguage ? 'block' : 'none') . '; float: left;">
            <input size="33" type="text" name="name_' . $language['id_lang'|'id_lang'] . '" value="' . htmlentities( $this->getFieldValue( $obj, 'name', intval( $language['id_lang'|'id_lang'] ) ), ENT_COMPAT, 'UTF-8' ) . '" /><sup>*</sup>
          </div>';
    $this->displayFlags( $languages, $defaultLanguage, 'name', 'name' );
    echo '
          <div class="clear"></div>
        </div>
        <div class="margin-form">
          <input type="submit" value="' . $this->l( ' Save ' ) . '" name="submitAdd' . $this->table . '" class="button" />
        </div>
        <div class="small"><sup>*</sup> ' . $this->l( 'Required field' ) . '</div>
      </fieldset>
    </form> ';
    }
  }
?>

...

He aquí un resumen de la arquitectura del módulo de PrestaShop:

Image Modified

Cuando una de las páginas del sitio es cargada, el motor de PrestaShop revisa los módulos que deben ser invocados para a cada uno de los hooks que conforman la página.

...

...

Ficha de Producto

...

Devoluciones de Mercancías

...

Productos

...

...

Si resulta que su problema se debe a un error de PrestaShop en lugar de su código, envíe el problema al “bug-tracker” de PrestaShop: http://forge.prestashop.com/ (es necesario registrarse). Esto le permite discutir el problema directamente con los desarrolladores de PrestaShop.

...