zfcampus / zf-composer-autoloading
2.1.0
2018-05-03 22:00 UTC
Requires
- php: ^5.6 || ^7.0
- zendframework/zend-stdlib: ^3.1
Requires (Dev)
- mikey179/vfsstream: ^1.6.4
- mockery/mockery: ^1.0
- php-mock/php-mock-phpunit: ^1.1.2 || ^2.0
- phpunit/phpunit: ^5.7.27 || ^6.5.8 || ^7.1.5
- zendframework/zend-coding-standard: ~1.0.0
README
仓库废弃于2019年12月31日
此仓库已迁移至 laminas/laminas-composer-autoloading。
简介
zf-composer-autoloading
包提供了一个供应商的二进制文件,即zf-composer-autoloading
,它提供以下命令
enable
- 将命名的模块添加到在composer.json
中定义的项目自动加载规则中,disable
- 从composer.json
中移除模块的自动加载规则
这两个命令在完成后还会输出自动加载规则。
升级
如果您之前使用的是此组件的v1系列,之前公开的脚本为
autoload-module-via-composer
。该脚本现已被重命名为zf-composer-autoloading
。
安装
运行以下composer
命令
$ composer require --dev "zfcampus/zf-composer-autoloading"
注意--dev
标志;此工具仅适用于开发使用。
用法
$ ./vendor/bin/zf-composer-autoloading \ > enable|disable \ > [help|--help|-h] \ > [--composer|-c <composer path>] \ > [--type|-t <psr0|psr4>] \ > [--modules-path|-p <path>] \ > modulename
命令
enable
- 启用模块的Composer自动加载。disable
- 禁用模块的Composer自动加载。
参数
help
、--help
和-h
都会显示脚本的帮助信息。--composer
和-c
允许您指定Composer二进制文件的路径,如果它不在您的$PATH
中。--type
和-t
允许您指定自动加载类型,它应该是psr-0
或psr-4
之一;如果没有提供,脚本将尝试根据模块的目录结构自动确定该值。--modules-path
和-p
允许您指定模块目录的路径;默认为module
。modulename
是要设置Composer自动加载的模块的名称。
注意
- 假设模块具有一个
src/
目录。如果没有,生成的自动加载将是不正确的。 - 如果不能确定自动加载类型,则假定PSR-0。
- 在启用自动加载时,如果模块的
Module
类文件在模块根目录中,它将被移动到模块的src/
目录(仅限zend-mvc应用程序)。
示例
-
自动检测模块的自动加载类型,并为"Status"模块生成Composer自动加载条目。
$ ./vendor/bin/zf-composer-autoloading enable Status
-
自动检测模块的自动加载类型,并删除"Status"模块的Composer自动加载条目。
$ ./vendor/bin/zf-composer-autoloading disable Status
-
指定模块类型为PSR-0,并为"Status"模块生成Composer自动加载条目。
$ ./vendor/bin/zf-composer-autoloading enable --type psr0 Status
-
指定模块类型为PSR-4,并为"Status"模块生成Composer自动加载条目。
$ ./vendor/bin/zf-composer-autoloading enable --type psr4 Status
-
生成"Status"模块的自动加载条目时,指定composer二进制文件的路径。
$ ./vendor/bin/zf-composer-autoloading enable -c composer.phar Status
-
指定模块目录的路径,并为"Status"模块生成Composer自动加载条目。
$ ./vendor/bin/zf-composer-autoloading enable -p src Status