PrestaShop 1.7模块类间数据共享问题：单例无法持久化

我正在开发一个PrestaShop模块，希望在actionValidateOrder动作钩子中执行逻辑并临时存储结果，以便在displayHeader展示钩子中使用。

我在主模块类中将单例模式的CustomStore实例赋值给属性$customStore，并传递给钩子处理类：

class PrestashopCustomModule extends Module
{

  public function __construct()
  {

    /* ... */

    parent::__construct();

    $this->customStore = CustomStore::getInstance();

    /* ... */

  }

  /* ... */

  public function hookActionValidateOrder($params)
  {
      $hook = new HookActionValidateOrder($this, $this->context);
      $hook->setParams($params);

      return $hook->run();
  }

  public function hookDisplayHeader($params)
  {
      $hook = new HookDisplayHeader($this, $this->context);
      $hook->setParams($params);

      return $hook->run();
  }

}

Store类的单例实现代码如下：

class Store
{

    private static $instance = null;
    private $store = [];

    private function __construct()
    {
    }

    public static function getInstance()
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }

        return self::$instance;
    }

    public function push($code)
    {
      $this->store[] = $code;
      return;
    }

    public function get()
    {
      return $this->store;
    }
}

但实际测试中，在actionValidateOrder钩子中调用$this->module->customStore->push('something')后，displayHeader钩子调用$this->module->customStore->get()时返回的数组为空。明明用了单例模式，为什么数据无法在两次钩子调用间持久化？

问题根源 #

单例模式的作用范围是当前HTTP请求的内存空间，而PrestaShop中actionValidateOrder和displayHeader属于两个完全独立的请求：

• actionValidateOrder触发于用户提交订单的POST请求（比如点击"确认订单"时）
• displayHeader触发于订单提交成功后跳转页面的GET请求

当第一个请求结束时，PHP会销毁所有内存中的对象（包括单例实例），第二个请求会重新初始化模块类并创建新的单例实例，自然拿不到之前存储的数据。

可行解决方案 #

方案1：使用PrestaShop Cookie上下文（推荐） #

利用PrestaShop的$context->cookie存储用户级临时数据，数据会关联到用户会话，跨请求可用。

步骤：

1. 在模块安装时注册自定义Cookie字段，避免被PrestaShop自动清理：

public function install()
{
    return parent::install() 
        && $this->registerHook('actionValidateOrder') 
        && $this->registerHook('displayHeader') 
        && $this->registerCustomCookie();
}

private function registerCustomCookie()
{
    if (!isset(Cookie::$cookie_vars['custom_order_data'])) {
        Cookie::$cookie_vars['custom_order_data'] = [
            'type' => 'array', // 支持存储数组类型
            'public' => false, // 设为false避免前端读取
        ];
    }
    return true;
}

2. 在actionValidateOrder中存储数据：

// 在HookActionValidateOrder类的run方法中
$this->module->context->cookie->custom_order_data = ['something'];
// 强制保存Cookie
$this->module->context->cookie->write();

3. 在displayHeader中读取并清理数据：

// 在HookDisplayHeader类的run方法中
$storedData = $this->module->context->cookie->custom_order_data ?? [];
// 使用数据后清空，避免后续请求重复读取
unset($this->module->context->cookie->custom_order_data);
$this->module->context->cookie->write();

方案2：数据库临时存储 #

如果数据需要和订单绑定而非用户绑定，可以创建临时数据表存储数据，后续在展示钩子中读取并清理。

示例：

1. 在模块安装时创建临时表：

public function install()
{
    if (!parent::install()) return false;
    
    $sql = "CREATE TABLE IF NOT EXISTS `"._DB_PREFIX_."custom_order_temp` (
        `id_temp` INT UNSIGNED NOT NULL AUTO_INCREMENT,
        `id_order` INT UNSIGNED NOT NULL,
        `data` TEXT NOT NULL,
        `date_add` DATETIME NOT NULL,
        PRIMARY KEY (`id_temp`),
        KEY `id_order` (`id_order`)
    ) ENGINE=". _MYSQL_ENGINE_ ." DEFAULT CHARSET=utf8;";
    
    return Db::getInstance()->execute($sql) 
        && $this->registerHook('actionValidateOrder') 
        && $this->registerHook('displayHeader');
}

2. 在actionValidateOrder中存储数据：

$idOrder = $params['id_order'];
$data = json_encode(['something']);
Db::getInstance()->insert('custom_order_temp', [
    'id_order' => (int)$idOrder,
    'data' => pSQL($data),
    'date_add' => date('Y-m-d H:i:s')
]);

3. 在displayHeader中读取并清理：

// 从模板变量获取当前订单ID（假设是订单成功页）
$idOrder = $this->module->context->smarty->getTemplateVars('id_order');
if ($idOrder) {
    $result = Db::getInstance()->getRow("SELECT * FROM `"._DB_PREFIX_."custom_order_temp` WHERE id_order = ".(int)$idOrder);
    if ($result) {
        $storedData = json_decode($result['data'], true);
        // 使用数据
        // 清理临时数据
        Db::getInstance()->delete('custom_order_temp', 'id_temp = '.(int)$result['id_temp']);
    }
}

方案3：使用缓存 #

利用PrestaShop的缓存系统存储带过期时间的临时数据，适合不需要长期保留的场景。

示例：

1. 在actionValidateOrder中存储：

$cacheKey = 'custom_order_data_'.$params['id_order'];
Cache::set($cacheKey, ['something'], 3600); // 1小时后自动过期

2. 在displayHeader中读取：

$idOrder = $this->module->context->smarty->getTemplateVars('id_order');
$cacheKey = 'custom_order_data_'.$idOrder;
$storedData = Cache::get($cacheKey);
if ($storedData) {
    // 使用数据
    Cache::delete($cacheKey);
}

内容的提问来源于stack exchange，提问作者Kuba Serafinowski