dartmoon / prestashop-module
Dartmoon的PrestaShop模块
v0.6.1
2023-09-01 15:36 UTC
Requires
- dartmoon/prestashop-hooks: ^0.3.0
- dartmoon/prestashop-tabmanager: ^0.1.2
Requires (Dev)
README
通过释放PHP包的力量简化PrestaShop模块的创建,无需担心包版本。
安装
- 使用这个模板创建一个新的模块。我们建议使用PHP 7.3(这是PrestaShop 8之前的最大版本)
composer create-project dartmoon/prestashop-module yourmodulename
这将触发自定义命令:只需回答问题即可!
对于模块名称,我们建议不要使用连字符或其他“单词分隔”字符。
- 在PrestaShop中安装模块(从您的PrestaShop安装根目录执行以下命令)
php bin/console prestashop:module install yourmodulename
完成!
用法
像以前一样编写您的模块!
安装PHP包
与您通常所做的没有区别!
composer require namespace/package
安装完成后,将开始前缀处理过程。它将扫描供应商目录,并使用您在composer.json文件中配置的前缀对所有的类进行前缀处理。
请注意,并非所有经过前缀处理的包都能很好地工作(尽管大多数都能),因此您可以遵循下一步,并决定从前缀处理过程中排除一些文件夹。
防止某些包的前缀处理
如果您的安装包在经过前缀处理后工作不正常,您可以将其从前缀处理过程中排除。
为此,您需要编辑scooper.inc.php文件。
在幕后,我们使用PHP-Scoper,因此您可以参考他们的文档进行配置。
构建
完成您的包后,是时候构建它了。
要这样做,只需执行
composer build-module
构建过程将在模块根目录中创建一个zip文件,其中包含所有生产代码。这就是您的编译模块。
更改版权声明
在您的模块根目录中,您将找到一个名为copyright.txt的文件,其中包含应用于模块每个文件头部的版权声明。
要更改它,只需编辑该文件。
从构建中排除文件
有时您的模块中包含一些您不想包含在构建中的开发文件。要排除它们,您只需编辑excludes.txt文件。
我们已经使用一些敏感的默认值编译了它!
许可证
本项目采用MIT许可证 - 有关详细信息,请参阅LICENSE.md文件