README

警告

开发已迁移至 claroline/Distribution。此存储库不再维护。

收集对 Claroline 开发有用的工具、库和命令的捆绑包。

工具和库

PHPUnit

单元测试框架。

PHP-CS-Fixer

检测并修复编码标准违规。此捆绑包中包含的配置依赖于 PSR-* 和 Symfony 编码标准（见 [https://symfony.ac.cn/doc/master/contributing/code/standards.html] (https://symfony.ac.cn/doc/master/contributing/code/standards.html))。

vfsStream

创建虚拟文件系统（在单元测试中模拟真实系统非常有用）。

Travis CI

提供用于构建和测试托管在 github 上的项目的持续集成服务。

此捆绑包提供了一些脚本和资源，用于在 Travis 上设置 Claroline 捆绑包的工作环境。基本来说，以下描述的步骤将重现最小应用程序结构，包括测试数据库和您的捆绑包所需的所有依赖项。

以下是启动步骤

1. 为您的捆绑包的 github 存储库启用 Travis（只需遵循 http://travis-ci.org 上的说明）。

2. 确保您有一个位于您的捆绑包根目录的 phpunit.xml 文件。如果没有，您可以复制此捆绑包提供的[默认配置文件] (https://github.com/claroline/DevBundle/tree/master/Resources/travis/phpunit.xml)。

3. 将此捆绑包包含在您的捆绑包的 dev 依赖项中

   "require-dev": {
       "claroline/dev-bundle": "dev-master"
   }

4. 将此 .travis.yml 放在您的捆绑包的根目录中。

5. 提交并推送/PR，您应该会看到 Travis 构建开始。

命令

claroline:debug:service OWNER SERVICE_NAME METHOD_NAME PARAMETERS [-a]

此命令调用一个服务的函数。它允许您实时查看日志，特别方便使用 -a 参数（显示 doctrine 刷新）进行 doctrine 调试。

• OWNER：执行操作的用户的用户名（它被注入到 symfony2 令牌存储服务中）。
• SERVICE_NAME：您想要执行的服务的名称。
• METHOD_NAME：您想要触发的函数。
• PARAMETERS：您的函数需要的参数列表。它目前仅支持 'simple' 类型（即：字符串、整数、布尔值）。如果参数是实体，您可以传递其 ID，并将检索该对象。
• [-a]：显示 doctrine 日志。

php app/console claroline:debug:service root claroline.manager.workspace_manager createWorkspaceFromModel 2 1 lh lh -a -vvv

claroline:debug:translation LANGUAGE [--domain=] [--main_lang=] [--fqcn=] [-f]

此命令将允许您重新排序翻译并添加外文语言文件中缺失的键。它将在控制台中显示缺失的翻译（翻译键等于翻译的键）。

• LOCALE：您想要检查的语言。
• [--domain=]：翻译域（默认：platform）
• [--main_lang]=：包含所有翻译的语言文件（默认：fr）
• [--fqcn]=：您想要检查翻译的捆绑包（默认：ClarolineCoreBundle）
• [-f]：更新翻译文件（重新排序并注入缺失的键）。

php app/console claroline:debug:translation en --domain=forum --main_lang=fr --fqcn=ClarolineForumBundle -f

claroline:tool [tool [bundle]]

启动给定捆绑包的可用的工具脚本之一（位于 ./Resources/scripts/tools）。

此命令可以用于交互式操作（例如，查看可用工具列表）

php app/console claroline:tool

可用工具

• cs：将PHP-CS-fixer应用于包
• cs-dry：将PHP-CS-fixer diff（无更改，仅预览）应用于包