基于Symfony开发LMS时如何实现SCORM标准并获取SCORM值

前置逻辑说明 #

SCORM的核心交互是基于JavaScript API实现的：SCORM资源包是包含imsmanifest.xml清单文件的网页资源，加载时会自动在父窗口/顶层窗口查找规定的API对象，通过API对象完成和LMS的数据交互，不存在额外的复杂协议对接。

1. 对接前期准备 #

• 先实现SCORM包上传、解压、解析能力：Symfony侧可以用symfony/filesystem组件处理解压后的文件存储，解析包根目录的imsmanifest.xml文件，提取SCORM版本（1.2/2004两个版本API有差异）、资源入口地址、评分规则等元数据。
• 设计SCORM相关数据表，至少包含三类存储：SCORM包基础信息表、用户SCORM学习进度表、临时会话缓存表，核心存储字段需覆盖常用的SCORM数据模型字段，比如cmi.core.lesson_status（学习状态）、cmi.core.score.raw（得分）、cmi.core.total_time（学习时长）、cmi.suspend_data（SCORM内容自定义临时状态）等。

2. 核心API实现（对接关键） #

SCORM内容加载时会主动查找两个全局对象：SCORM 1.2版本找API对象，SCORM 2004版本找API_1484_11对象，你需要在加载SCORM内容的iframe父页面提前定义好对应对象，实现规范要求的所有方法即可：

// SCORM 1.2 API示例，放在SCORM iframe的父页面
window.API = {
  initialized: false,
  scormDataCache: {}, // 缓存当前用户的SCORM学习数据

  // 初始化会话，SCORM内容加载后自动调用
  LMSInitialize: function() {
    // 异步请求Symfony后端拉取当前用户对应当前SCORM包的历史进度，存入scormDataCache
    this.initialized = true;
    return "true";
  },

  // 从LMS获取SCORM值的核心入口，SCORM内容主动调用该方法取值
  LMSGetValue: function(field) {
    return this.scormDataCache[field] || "";
  },

  // SCORM内容向LMS存储数据的入口
  LMSSetValue: function(field, value) {
    this.scormDataCache[field] = value;
    return "true";
  },

  // 持久化存储SCORM数据到后端
  LMSCommit: function() {
    // 发请求到Symfony后端，将scormDataCache写入进度表
    fetch("/scorm/save-progress", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({
        scorm_id: currentScormId,
        user_id: currentUserId,
        progress: this.scormDataCache
      })
    });
    return "true";
  },

  // 结束会话，SCORM内容关闭前自动调用
  LMSFinish: function() {
    this.LMSCommit();
    this.initialized = false;
    return "true";
  },

  // 剩余错误处理类方法按SCORM规范补全即可
  LMSGetLastError: function() { return "0"; },
  LMSGetErrorString: function(code) { return ""; },
  LMSGetDiagnostic: function(code) { return ""; }
}

// 如需兼容SCORM 2004，同步定义API_1484_11对象，方法名替换为规范要求的Initialize/Terminate/GetValue/SetValue/Commit即可

3. Symfony后端配套逻辑 #

• 编写对应的路由处理SCORM进度查询、保存请求，需要校验当前登录用户和SCORM包的访问权限，避免越权修改他人学习数据。
• 可根据业务需求做字段映射，不需要存储所有SCORM数据模型字段，仅存储业务所需的核心字段即可减少存储压力。
• 如果LMS侧需要主动获取SCORM值做学习统计、进度展示，直接查询进度存储表的对应字段即可，无需额外调用其他接口。

注意事项 #

• SCORM内容必须用同域名的iframe加载，避免跨域导致SCORM内容找不到父窗口的API对象，如有跨域需求可通过postMessage实现跨域代理层。
• 可在父页面做定时自动Commit，比如每30秒自动调用一次LMSCommit方法，避免SCORM内容未主动提交导致数据丢失。
• 处理好用户会话超时问题，SCORM页面长时间停留时要做会话自动续期，避免进度提交失败。

内容的提问来源于stack exchange，提问作者Radofaniry Angelo RANDRIANONIM