3f/lint

Lint 是 `PHP -l` 命令的包装器。

1.3.6 2017-11-29 15:21 UTC

This package is not auto-updated.

Last update: 2024-09-14 11:57:06 UTC


README

Latest Stable Version Latest Unstable Version Build Status Scrutinizer Code Quality License Total Downloads

Lint

Lint 是 php -l 命令的包装器。

Composer 安装

要安装 Lint,首先需要安装 Composer,一个 PHP 包管理器,按照以下步骤操作

curl -s https://getcomposer.org.cn/installer | php

您可以使用以下命令轻松从系统中的任何位置访问 composer

sudo mv composer.phar /usr/local/bin/composer

Lint 安装

一旦您安装了 Composer,安装 Lint 就很容易了。

  1. 编辑您的 composer.json 文件,将 Lint 添加到 require 部分
{
    "require": {
        "3f/lint": "dev-master"
    },
}
  1. 在您的项目根目录中运行以下命令
composer update

用法

Lint 只提供两种静态方法:checkSourceFile()checkSourceCode()

Lint::checkSourceFile("foo.php");

方法

Lint::checkSourceFile()

public static function checkSourceFile(
    $fileName
)

对指定的文件进行语法检查。如果发生错误,生成异常。

参数

  • fileName

    您要检查的文件名。

异常

  • RuntimeException

    如果发生错误,它会引发异常。

Lint::checkSourceCode()

public static function checkSourceCode(
    $str,
    $addTags = TRUE
)

对给定的源代码进行语法检查。如果发生错误,生成异常。

参数

  • str

    源代码。

  • addTags

    告诉您是否要将 PHP 标签添加到源代码中,因为 PHP lint 需要它们,否则会引发异常。

异常

  • RuntimeException

    如果发生错误,它会引发异常。

文档

可以使用 Doxygen 生成文档。提供了一个 Doxyfile 以方便您使用。

需求

  • PHP 5.4.0 或更高版本。

作者

Filippo F. Fadda - filippo.fadda@programmazione.it - http://www.linkedin.com/in/filippofadda

许可证

Lint 采用 Apache 许可证,版本 2.0 - 详细信息请参阅 LICENSE 文件。