PHP Percentages 项目使用教程

原创于 2024-09-08 08:28:17 发布 · 1k 阅读

CC 4.0 BY-SA版权

PHP Percentages 项目使用教程

php-percentagesA clean interface to calculate percentages in PHP: changes between values, percentage increases, partial values, ...项目地址:https://gitcode.com/gh_mirrors/ph/php-percentages

1. 项目目录结构及介绍

php-percentages/
├── src/
│   ├── Percentage.php
│   └── ...
├── tests/
│   ├── PercentageTest.php
│   └── ...
├── github/workflows/
│   └── ...
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .php_cs
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── composer.json
└── phpunit.xml.dist

目录结构说明

src/: 包含项目的主要源代码文件，其中 Percentage.php 是核心文件，提供了百分比计算的功能。
tests/: 包含项目的测试文件，用于确保代码的正确性和稳定性。
github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化测试和部署。
.editorconfig: 编辑器配置文件，用于统一代码风格。
.gitattributes: Git 属性配置文件，用于指定文件的属性。
.gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
.php_cs: PHP-CS-Fixer 配置文件，用于自动格式化 PHP 代码。
CHANGELOG.md: 项目更新日志文件，记录每次版本更新的内容。
CONTRIBUTING.md: 贡献指南文件，指导开发者如何为项目贡献代码。
LICENSE.md: 项目许可证文件，说明项目的开源许可证类型。
README.md: 项目说明文件，介绍项目的基本信息和使用方法。
composer.json: Composer 配置文件，用于管理项目的依赖关系。
phpunit.xml.dist: PHPUnit 配置文件，用于配置测试环境。

2. 项目启动文件介绍

项目的启动文件主要是 src/Percentage.php，该文件定义了百分比计算的核心功能。以下是该文件的主要内容：

namespace Mattiasgeniar\Percentage;

class Percentage
{
    // 计算两个数值之间的百分比变化
    public static function differenceBetween($start, $end)
    {
        return (($end - $start) / $start) * 100;
    }

    // 计算两个数值之间的绝对百分比变化
    public static function absoluteDifferenceBetween($start, $end)
    {
        return abs(self::differenceBetween($start, $end));
    }

    // 计算一个数值相对于另一个数值的百分比
    public static function calculate($value, $total)
    {
        return ($value / $total) * 100;
    }

    // 计算某个百分比对应的数值
    public static function of($percentage, $total)
    {
        return ($percentage / 100) * $total;
    }

    // 计算百分比扩展
    public static function extension($percentage, $start, $end)
    {
        return ($percentage / 100) * ($end - $start) + $start;
    }
}

主要功能介绍

differenceBetween: 计算两个数值之间的百分比变化。
absoluteDifferenceBetween: 计算两个数值之间的绝对百分比变化。
calculate: 计算一个数值相对于另一个数值的百分比。
of: 计算某个百分比对应的数值。
extension: 计算百分比扩展。

3. 项目配置文件介绍

composer.json

composer.json 文件用于管理项目的依赖关系和配置信息。以下是该文件的主要内容：

{
    "name": "mattiasgeniar/php-percentages",
    "description": "A clean interface to calculate percentages in PHP",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "Mattias Geniar",
            "email": "m@ttias.be"
        }
    ],
    "require": {
        "php": ">=7.2"
    },
    "autoload": {
        "psr-4": {
            "Mattiasgeniar\\Percentage\\": "src/"
        }
    },
    "require-dev": {
        "phpunit/phpunit": "^9.0"
    }
}

主要配置项说明

name: 项目名称。
description: 项目描述。
type: 项目类型，这里是 library，表示这是一个 PHP 库。
license: 项目许可证类型，这里是 MIT 许可证。
authors: 项目作者信息。
require: 项目依赖的 PHP 版本。
autoload: 自动加载配置，指定命名空间和对应的路径。
require-dev: 开发依赖，这里指定了 PHPUnit 作为测试工具。

phpunit.xml.dist

phpunit.xml.dist 文件用于配置 PHPUnit 测试环境。以下是该文件的主要内容：

<phpunit bootstrap="vendor/autoload.php">
    <testsuites>
        <testsuite name="Percentage Tests">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
</phpunit>