README

PHP代码生成器。

安装

Composer

本项目使用Composer作为依赖管理器，它可以通过遵循项目官方文档中的说明进行安装。

要使用此包管理器安装包jf/php-generator，需要执行以下命令

composer require jf/php-generator

依赖

当项目被安装时，以下依赖项也将被安装

包	版本
jf/assert	^3.1
jf/base	^4.0
jf/collection	^2.0
psr/log	^3.0

版本控制

本项目可以使用git安装。首先需要克隆项目，然后安装依赖项。

git clone https://www.gitlab.com/jfphp/jfPhpGenerator.git
cd jfPhpGenerator
composer install

可用文件

类

名称	描述
jf\php\generator\ABase	项目其余类的基类。
jf\php\generator\Attribute	表示PHP的属性。
jf\php\generator\ClassObject	生成一个类。
jf\php\generator\Classname	渲染表示类名的每个项目。
jf\php\generator\EnumObject	生成一个枚举。
jf\php\generator\Exception	应用程序抛出的异常。
jf\php\generator\File	用于操作文件的类。
jf\php\generator\Formatter	包含处理文本的实用工具的类。
jf\php\generator\FunctionItem	生成一个PHP函数。
jf\php\generator\Generator	用于操作文件的类。
jf\php\generator\Helpers	包含执行各种操作的帮助方法的类。
jf\php\generator\InterfaceObject	生成一个接口。
jf\php\generator\Method	类的成员方法。
jf\php\generator\Param	方法的参数。
jf\php\generator\Property	类的属性。
jf\php\generator\Tag	表示用于文档化元素的标签。
jf\php\generator\Tags	表示用于文档化元素的标签组。
jf\php\generator\TraitItem	渲染表示trait的每个项目，并在类定义中生成`use XXXX;`语句。
jf\php\generator\TraitMethod	表示在trait中使用并需要重命名以避免冲突的方法。
jf\php\generator\TraitObject	生成一个trait。
jf\php\generator\Variable	表示PHP变量。
jf\php\generator\collection\ACollection	集合的基类。
jf\php\generator\collection\Attributes	属性集合。
jf\php\generator\collection\Classes	类集合。
jf\php\generator\collection\Classnames	类名集合。
jf\php\generator\collection\Functions	函数集合。
jf\php\generator\collection\Methods	类的方法集合。
jf\php\generator\collection\Params	方法或函数的参数集合。
jf\php\generator\collection\Properties	类的属性集合。
jf\php\generator\collection\TraitItems	添加到元素的traits集合。
jf\php\generator\collection\TraitMethods	添加到类或trait的traits集合。

枚举

名称	描述
jf\php\generator\ObjectType	枚举可以创建的元素类型。

接口

名称	描述
jf\php\generator\IAttributes	为需要管理属性的类提供的接口。
jf\php\generator\IExtends	用于管理扩展类或接口元素的管理接口。
jf\php\generator\IGenerator	用于生成代码的元素接口，如类、枚举、接口和 traits。
jf\php\generator\IImplements	用于管理类实现的元素的管理接口。
jf\php\generator\IMethods	用于管理类的方法的管理接口。
jf\php\generator\IParams	用于管理方法参数的管理接口。
jf\php\generator\IProperties	用于管理类的属性的管理接口。
jf\php\generator\ITraits	用于管理类的 traits 的管理接口。
jf\php\generator\IUses	用于管理可能引用其他命名空间中元素的类的接口。

traits

名称	描述
jf\php\generator\TAttributes	管理元素的属性。
jf\php\generator\TCollectionItem	用于通过集合管理元素的 trait。
jf\php\generator\TDescription	管理元素的描述。
jf\php\generator\TDocDescription	通过添加描述来文档化元素。
jf\php\generator\TDocTags	管理元素的 PHPDoc 标签。
jf\php\generator\TDocType	文档化元素的数据类型。
jf\php\generator\TExtends	管理元素所扩展的类或接口的元素。
jf\php\generator\TFile	用于操作文件的 trait。
jf\php\generator\TGenerator	用于生成代码元素的类，如类、枚举、接口和 traits 的 trait。
jf\php\generator\TImplements	管理元素实现的元素的元素。
jf\php\generator\TMethods	管理元素的元素的元素。
jf\php\generator\TModifiers	元素修饰符。
jf\php\generator\TName	管理可能属于命名空间并具有别名的名称。
jf\php\generator\TParams	管理元素方法的元素的元素。
jf\php\generator\TProperties	管理元素的元素的元素。
jf\php\generator\TTags	管理元素的 PHPDoc 标签。
jf\php\generator\TTraits	管理元素的元素的元素。
jf\php\generator\TTranslations	管理文本翻译的 trait。
jf\php\generator\TType	管理变量、属性或参数的类型。
jf\php\generator\TUses	管理要导入的元素。
jf\php\generator\TValue	管理元素值的 trait。
jf\php\generator\collection\TType	为某些集合的元素添加默认类型的 trait。

脚本

scripts/_common.php

用于其他脚本的常用函数。

查看文件 scripts/_common.php。

scripts/add-to-generator.php

将配置添加到 generator.yaml 文件。

查看文件 scripts/add-to-generator.php。

scripts/build-config.php

通过分析目录中的类来构建 generator.yaml 文件，如果尚未创建。

查看文件 scripts/build-config.php。

scripts/coverage

使用视器的 -p 选项显示未达到 100% 覆盖率的类的覆盖率。

查看文件 scripts/coverage。

scripts/create-test

从类分析中生成基本测试。

查看文件 scripts/create-test。

scripts/generate

生成 src 目录内所有文件的代码源。

查看文件 scripts/generate。

scripts/tests

进行全面测试，覆盖100%的代码。最完整的测试是生成所有存储库文件的代码，并将结果与当前文件的内容进行比较。

查看文件 scripts/tests。

jf / php-generator

维护者

详细信息