ovimughal / lamirator
用于配置您的Laminas应用以使用Lamirest包并轻松创建模块的工具
1.0.1
2023-02-07 13:44 UTC
Requires
- php: ^8.1
- symfony/console: ^6.2.5
README
使用一条控制台命令创建Laminas、Lamirest模块(oRest、oapi)
安装
- 打开终端
- 进入您的根目录
cd /path/of/your/application (e.g cd /var/www/Laminas-App)
- 运行以下composer命令
composer require ovimughal/lamirator
开始使用
从应用根目录输入
./vendor/bin/lamirator create:module -m <Your-Module-Name>
为简化起见(可选)
- 在应用根目录中创建一个PHP文件(例如 lamirator.php)
- 在您的文本编辑器中打开它
- 粘贴以下行
<?php require __DIR__.'/vendor/ovimughal/lamirator/app/console.php';
并保存。现在,从您的终端简单地输入
php lamirator.php create:module -m <Your-Module-Name>
现在您的Laminas模块就可以使用了
选项
-m <Module-Name>
(默认为SkeletonModule
)-t <Type>
(类型可以是zf3
、oapi
或oRest
,默认为zf3
,除oapi
或oRest
以外的任何类型都将视为zf3
)
注意
zf3
是默认的Laminas模块,因为没有提供自动生成此模块的机制,如ZF2 Eclipse PDT或Zend Studio中提供的机制,因此我保留了此选项。
oapi
是基于Laminas的AbrstractRestfulController
的模块,其中我们可以轻松处理REST。
oRest
是基于Laminas的AbstractActionController
的出色模块。易于使用且您所爱的基于Action
的方法。
通过安装Lamirest
模块,您将获得JWT-Token
、AccessControlList(ACL)
、Doctrine
、异常处理
、ApiValidation
、多租户SAAS
、加密
、干净的架构
以及更多开箱即用的功能。
- 在浏览器中测试
http://hostname:port/yourapp/yourmodule
,无需配置。 - 享受吧 :)
针对Lamirest
模块用户
- 关于安装 Lamirest
- 安装完成后,从您的根目录在终端中输入以下命令
./vendor/bin/lamirator lamirest:serve
这将启动Lamirest模块并自动进行所有必要的配置
还将为您生成一些配置文件。 - 为了使
doctrine
正常工作,我们需要告诉它实体的位置
将以下内容粘贴到任何module\<module-name>\config\module.config.php
的返回数组中
'doctrine' => [ 'driver' => [ __NAMESPACE__ . '_driver' => [ 'class' => \Doctrine\ORM\Mapping\Driver\AnnotationDriver::class, 'cache' => 'array', 'paths' => [__DIR__ . '/../src/Entity'] ], 'orm_default' => [ 'drivers' => [ __NAMESPACE__ . '\Entity' => __NAMESPACE__ . '_driver' ], ], ], ],
- 您完成了 :)