README

注意：此项目已废弃

由于Neos/Flow与TYPO3社区分离，我们不再支持此包。如果您想进行更新，请通过blueduck@gmx.net联系我。

此标准包含来自TYPO3SniffPool的子集嗅探器，并实现了TYPO3 Flow的编码规范。

它仅包含一个ruleset.xml文件，其中我们引用了来自PHP_CodeSniffer和TYPO3SniffPool的嗅探器。

如果您尚未安装TYPO3SniffPool或PHP_CodeSniffer，没有问题。这些包被标记为此标准的依赖项，并会自动安装。

有几种方式可以获取此标准，我将现在描述。没有正确或错误的方式。您选择哪种方式取决于您的偏好和至少是您的要求。

我们支持Composer，一个PHP的依赖项管理器。

在您项目的根目录中创建一个composer.json文件或扩展现有的文件，并将此包声明为依赖项

{
    "minimum-stability": "alpha",
    "require": {
        "typo3-ci/typo3flow": "dev-master"
    }
}

由于此包由Packagist管理，这也就足够了。

这将把PHP_CodeSniffer和TYPO3SniffPool安装到您项目的vendor/目录中。有关Composer的更多信息，请参阅他们的文档。

对于系统范围内的安装，您可以使用

composer global require "typo3-ci/typo3flow=dev-master"

请确保~/.composer/vendor/bin/在您的路径中。

第二种方式是从github克隆仓库。在这种情况下，您必须自己处理依赖项。

$ git clone https://github.com/typo3-ci/TYPO3Flow.git
$ git clone https://github.com/typo3-ci/TYPO3SniffPool.git

安装方法多种多样，使用方法也多种多样。

切换到您的项目文件夹，并从那里调用PHP_CodeSniffer

$ cd myproject
$ php vendor/squizlabs/php_codesniffer/scripts/phpcs --standard=TYPO3Flow /path/to/folder

也可以使用全局安装的PHP_CodeSniffer（例如通过PEAR）来调用此标准。

$ cd myproject
$ phpcs --standard=vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/TYPO3Flow/ruleset.xml /path/to/folder

在克隆了标准和其依赖项之后，使用方法与上面几乎相同。主要有两种方法。

请参阅专门的wiki页面以获取有关如何您可以为此项目做出贡献的信息。