README

提供 Symfony PSR CodeSniffer 规则集

• PSR-1 & PSR-2
• Symfony 标准
• Symfony 命名约定

强烈受到 OpenSky Symfony2 编码标准（派生自 InterfaceSuffixSniff）的启发。然而，此规则集依赖于 CodeSniffer PSR-1 & 2 检查和添加 Symfony 标准 & 命名约定。它还允许链式调用（流畅接口）。

安装

1. 安装 phpcs

    pear install PHP_CodeSniffer
   

2. 找到您的 PEAR 目录

    pear config-show | grep php_dir
   

3. 将此存储库复制、符号链接或检出到 phpcs Standards 目录中的名为 Symfony 的文件夹

    cd /path/to/pear/PHP/CodeSniffer/Standards
    git clone git://github.com/xalopp/symfony-coding-standard.git Symfony
   

4. 选择 Symfony 规则集作为默认编码标准

    phpcs --config-set default_standard Symfony
   

5. 成功

    phpcs path/to/my/file.php
   

实用主义且具有偏见的自定义

允许流畅接口链式调用语法

<?php

    $this
        ->getFoo()
            ->getBar()
            ->getBar()
    ; // This is allowed

    $this->getFoo()  ; // This is a violation

?>

已知限制

• 当前不强制执行函数

贡献

如果您为这些嗅探器贡献代码，请确保它符合 PEAR 编码标准，并且单元测试仍然通过。

要检查编码标准，请从 Symfony-coding-standard 源根运行

    phpcs --ignore=Tests --standard=PEAR . -n

单元测试在 PHP_CodeSniffer 目录内运行

• 获取 CodeSniffer 存储库
• 在 CodeSniffer 存储库根目录中符号链接、复制或克隆此存储库到 CodeSniffer/Standard/Symfony
• 从 CodeSniffer 存储库根目录运行 phpunit --filter Symfony_ tests/AllTests.php

致谢

OpenSky 为 Symfony2 编码标准

问题

如果您发现任何缺失的标准/约定并且不想贡献，请提交一个问题。它至少会被添加到此说明书中。

许可

版权所有 (c) 2013 Ludovic Fleury

特此授予任何获得此软件及其相关文档文件（“软件”）副本的任何人，在不受限制的情况下处理该软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许向软件提供者提供软件的人这样做，前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何形式的保证，无论是明示还是暗示，包括但不限于适销性、适用于特定目的和非侵权性。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任承担责任，无论该责任源于合同、侵权或其他原因，与软件或其使用或以其他方式与软件相关的活动无关。