README

英语 | 俄语

EXCEPTIONS CSE BASE

此库为开发和生产环境提供了简单的异常处理。

项目仓库： https://github.com/cs-eliseev/base-exceptions

演示

try {
    ..
    $code = 0;
} catch (CseExceptions $e) {
    ...
} catch (Throwable $e) {
    $code = $e->getCode();
}
CseExceptions::getErrorMsg($code);
// Unknown error

简介

CSE BASE 是一组用 PHP 编写的库，专门用于扩展您的类。

一组用于创建类的基本方法，可以帮助您快速创建 Web 应用程序。EXCEPTIONS CSE BASE 允许您通过异常扩展类。

CSE BASE 是为了快速开发 Web 应用程序而创建的。

CSE Base 项目

• 异常 CSE 基础
• 单例 CSE 基础

以下是一些有关如何初始化库和执行常用命令的信息。

安装

您可以在以下链接找到此项目的最新版本：此处。

Composer

执行以下命令以获取包的最新版本：

composer require cse/base-exceptions

或者 composer.json 文件应包含以下内容：

{
    "require": {
        "cse/base-exceptions": "*"
    }
}

Git

在本地上克隆此存储库

git clone https://github.com/cs-eliseev/base-exceptions.git

下载

在此处下载最新版本.

使用方法

查看测试模型： ModelExceptions.php

查看示例： examples-exceptions.php

创建模型异常

示例

class ModelExceptions extends CseExceptions
{
    const ERROR_EXAMPLE_CODE_1 = 1;
    const ERROR_EXAMPLE_CODE_2 = 2;
    const ERROR_EXAMPLE_CODE_3 = 3;

    /**
     * @var array
     */
    protected static $errorsMsg = [
        self::ERROR_EXAMPLE_CODE_1 => 'Error code 1',
        self::ERROR_EXAMPLE_CODE_2 => 'Error code 2',
        self::ERROR_EXAMPLE_CODE_3 => 'Error code 3',
    ];
}

使用检查实例

示例

try {
    ...
    throw new ModelExceptions('CseExceptions');
} catch (CseExceptions $e) {
    $e->getMessage();
    // CseExceptions
} catch (Exception $e) {
    // Last Exception
} catch (Throwable $e) {
    // Last Throwable
}

通过代码错误抛出异常

示例

ModelExceptions::throwException(ModelExceptions::ERROR_EXAMPLE_CODE_1);
// Error code 1

向异常添加消息

ModelExceptions::throwException(ModelExceptions::ERROR_EXAMPLE_CODE_2, ' - msg test');
// Error code 2 - msg test

默认错误消息

ModelExceptions::throwException(4);
// Unknown error

通过代码错误获取错误消息

示例

ModelExceptions::getErrorMsg(ModelExceptions::ERROR_EXAMPLE_CODE_3);
// Error code 3

默认错误消息

ModelExceptions::getErrorMsg(4);
// Unknown error

测试 & 代码覆盖率

PHPUnit 用于单元测试。单元测试确保类和方法确实做了它应该做的事情。

PHPUnit 的通用文档可以在以下链接找到：https://phpunit.de/documentation.html。

要运行 PHPUnit 单元测试，请执行以下操作：

phpunit PATH/TO/PROJECT/tests/

如果您想要代码覆盖率报告，请使用以下命令：

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

使用 PHPUnit 默认配置

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

捐赠

您可以通过以下链接支持此项目：此处。您还可以通过为项目做出贡献、报告错误来帮助。即使是提出功能建议也是非常棒的。任何帮助都是受欢迎的。

许可

EXCEPTIONS CSE BASE 是一个开源的 PHP 库，许可协议为 MIT 协议。有关更多信息，请参阅许可文件。

GitHub @cs-eliseev