oxid-esales / module-generator
为新的OXID eShop模块生成文件夹结构、空类和元数据。
dev-master
2021-11-09 09:03 UTC
This package is auto-updated.
Last update: 2024-09-09 15:11:07 UTC
README
为新的OXID eShop模块生成文件夹结构、空类和元数据。
只关注功能 - 让OXID模块骨架生成器创建其余所有内容!
- 在模块设置中输入您的版权信息
- 打开易于使用的模块生成器向导
- 输入新模块名称和可选组件
- 按下“生成新模块”按钮,完成 - 新模块现在准备好激活并填充功能了!
OXID模块骨架生成器功能
- 为创建新模块提供完全可配置的供应商/作者参数
- 自动创建供应商文件夹和供应商元数据
- 创建标准模块文件夹结构
- 生成完全填充的模块元数据文件
- 基于供应商数据和模块名称命名
- 创建的模块遵循OXID标准
- 自动创建预填充的README文件
- 生成带有所有供应商和模块数据的PHP文件注释
- 每个生成的模块都包含主模块类
- 它包含激活/停用事件
- 支持在事件上自动执行SQL语句
- 该类“了解”其模块并提供有用的方法
- 生成骨架文件用于...
- 重载(扩展)类
- 新控制器(也创建模板)
- 模型类
- 列表模型类(与项目模型类相关联)
- 小部件(也包含模板)
- 生成Smarty块元数据和模板
- 生成模块设置元数据和翻译
- 创建翻译文件
- 模块版本
- 自动检出测试文件夹
- 并为每个新模块类生成预填充的测试类
- 可配置的GIT仓库URL,以从该URL获取测试文件夹
- 学习模式
- 在生成的文件中创建提示和待办事项,以帮助进行开发
- 生成示例源代码,提示每个类可能/应该包含的内容
- 生成的模块立即可用
- 激活它,事件、设置、块、控制器等。将已启动!
安装
- 将
copy_this/
文件夹的内容复制到OXID eShop根目录 - 在管理区域激活模块
- 在生成新模块时设置eShop
modules/
文件夹可写
使用方法
- 确保eShop
modules/
文件夹(以及您的供应商子文件夹,如果存在)是可写的 - 登录到eShop管理区域
- (首次运行时)转到扩展 -> 模块 -> OXID模块骨架生成器 -> 设置 -> 供应商和版权设置并输入您的供应商、版权和作者数据
- 打开模块生成器 -> 向导(如果模块激活后未出现,请刷新页面)
- 以“UpperCamelCase”格式输入新模块的名称,例如“MyModule”
- (可选)输入新模块中需要的其他选项(有关更多信息,请参阅帮助提示)
- 按下“生成新模块”按钮
- 模块骨架源代码现在可在您的供应商子文件夹中找到
- 并且该模块已在扩展 -> 模块中激活
未来版本将要做和希望拥有的功能
- 重构较长的类以将某些方法移到其他地方
- 扩展块定义验证和块模板命名
- 编辑模式功能:对于现有模块,生成/添加额外内容
- 创建具有JS/AJAX事件的漂亮生成表单,以验证和帮助输入正确的值(自动完成)
- 生成管理界面预设,包括menu.xml
- 生成带有实际模块名称的PNG文本叠加图片
- PHPStorm样式方案(或某些代码美化器)集成 - 生成后进行代码格式化
- 不要复制所有文件夹,只需复制所需的文件夹(通过提供"复制场景"数组来重构copyDir)
- 在现实项目的多店铺和多语言环境中,dbEvent会失败 - 需要基于PHP的数据库安装