README

此仓库已被归档。请使用 asispts/ptscs。

基于 PSR-12 的 PHP 编程规范

基于 PSR-12 的 PHP 编程规范，包含一些例外和补充。

• 基于 PSR-12 的 PHP 编程规范
  • 已弃用
  • 安装
  • 使用
  • 编码风格
  • 许可

已弃用

请使用 asispts/ptscs

安装

使用 composer 安装

composer require --dev pattisahusiwa/coding-standard

使用

安装后，在项目的根目录下创建 phpcs.xml 或 phpcs.xml.dist 文件，并添加以下代码：

<?xml version="1.0" encoding="UTF-8"?>
<ruleset>
    <arg name="colors"/>
    <arg name="parallel" value="8"/>
    <arg value="psv"/>
    <arg name="extensions" value="php"/>

  <file>src</file>
  <file>tests</file>

  <exclude-pattern>vendor</exclude-pattern>

  <rule ref="ptscs"/>
</ruleset>

运行 phpcs 验证您的源代码风格，运行 phpcbf 修复违规。

编码风格

所有编码风格的示例可以在 /tests/**/_data/*.php.fixed 中找到。以下是一个类声明的示例。

<?php declare(strict_types=1);

namespace Ptscs\Tests;

use ParentClass;
use SomeInterface;

final class Classes extends ParentClass implements SomeInterface
{
    use sometrait;

    /**
     * @var object
     */
    private $obj1;

    /**
     * @var object
     */
    private $obj2;

    /**
     * @var string[]
     */
    private $data = [];

    // Example of multiline function arguments
    public function __construct(
        object $obj1,
        object $obj2
    ) {
        $this->obj1 = $obj1;
        $this->obj2 = $obj2;
    }

    public function setData(string $key, string $value): void
    {
        $this->data[$key] = $value;
    }

    public function getData(string $key): string
    {
        if (array_key_exists($key, $this->data) === true) {
            return $this->data[$key];
        }

        return '';
    }
}

许可

在 MIT 许可证 下发布。请参阅 LICENSE 文件。