README

此包包含了一组针对kohana PHP框架的编码标准测试。
原始测试由Matthew Turland编写，更多详情请参阅他的github仓库。

这些测试旨在作为指南，可能并非100%准确。如果您发现错误，请在kohana问题跟踪器上报告。

需求

这些测试是为与PHP Codesniffer一起使用而构建的。

安装 - Composer

将包添加到项目composer.json中的开发依赖中

{
    "require-dev": {
        "kohana/coding-standards": "*",
    }
}

运行composer --dev update以更新您的composer.lock文件并安装包。嗅探器将被安装在项目根目录下的vendor/kohana/coding-standards中，phpcs命令将被安装到bin/phpcs。

安装 - 手动或使用PEAR

如果您希望标准可以在系统范围内使用，可以将它们像这样链接到代码嗅探器目录中

git clone https://github.com/kohana/coding-standards.git kohana-coding-standards
cd kohana-coding-standards
sudo ln -sfn `pwd`/Kohana `pear config-get php_dir`/PHP/CodeSniffer/Standards/Kohana 
sudo ln -sfn `pwd`/test/PHP_CodeSniffer/CodeSniffer/Standards/Kohana `pear config-get test_dir`/PHP_CodeSniffer/CodeSniffer/Standards/Kohana

运行

如果您使用Composer安装，请从您的供应商目录引用标准

bin/phpcs --standard=vendor/kohana/coding-standards/Kohana modules/

或者，从原始克隆中，您可以简单地引用本地副本

phpcs --standard=path/to/coding-standards/Kohana kohana/core

如果您全局安装（链接到PEAR），您可以像这样引用标准

phpcs --standard=Kohana application/

自定义项目标准

也可以扩展项目中使用的规则，或者包含部分而不是全部的Kohana标准（例如，如果您正在开发的东西不是作为Kohana模块）。您可以通过将coding_standard.xml添加到项目根目录来完成此操作，该文件指定要包含的规则并自定义任何变量。有关更多详细信息，请参阅PHP_CodeSniffer文档。

测试

与所有代码相关的事物一样，嗅探器需要经过测试！要运行测试，它们需要位于代码嗅探器目录中（即，您应该运行上面的命令来链接嗅探器/测试），并且您需要修补phpcs的AllSniffs.php。

然后只需像这样运行测试

phpunit --bootstrap=`pear config-get php_dir`/PHP/CodeSniffer.php `pear config-get test_dir`/PHP_CodeSniffer/CodeSniffer/Standards/AllSniffs.php

已知问题

• 三元运算符中的表达式存在问题

请将任何新问题报告给K3错误跟踪器，并在“PHPCS编码标准”下提交