README

欢迎使用CarbonPHP

我们的完整文档可在我们的GitHub Wiki或Carbonorm.dev上的可运行示例中找到。

安装

composer require carbonorm/carbonphp

此命令将使用Composer安装CarbonPHP的最新版本。如果您尚未安装Composer，可以按照getcomposer.org上的说明进行安装。Composer是PHP的包管理器，使用CarbonPHP需要它。《a href="https://packagist.org.cn/packages/carbonorm/carbonphp" rel="nofollow noindex noopener external ugc">Packagist是Composer包的官方存储库，下载统计信息是从这里收集的。旧的存储库位置composer require richardtmiles/carbonphp仍然可以通过composer/packagist使用，但建议迁移到新位置。上面显示的总下载次数#是重复的，以反映通过composer的两种下载方式。

Wordpress

或者，您可以安装CarbonPHP作为WordPress插件。这将允许您通过引导用户界面使用CarbonPHP的功能。

CarbonPHP工具包和性能库

CarbonPHP已经发展成为CarbonORM公共组织。在那里您可以找到有关使用ORM的前端过程文档。C6现在指的是任何Carbon*前缀的CarbonORM包。

CarbonORM.dev

CarbonPHP通过PHPUnit测试和GitHub Actions达到了其自身特征的稳定信任水平，但仍处于积极开发中。CarbonPHP在生产环境中使用。任何尝试使用此代码的个人或团队将在GitHub通过问题和论坛获得支持。我们通常期望您可能遇到的问题都是小的。如果您编辑代码库，请考虑在GitHub上提交这些更改！C6使用语义版本控制2.0.0。通常：MAJOR版本在您进行不兼容的API更改时使用，MINOR版本在以向后兼容的方式添加功能时使用，PATCH版本在您进行向后兼容的错误修复时使用。功能/类等更改将在每次次要版本中在变更日志中列出。请仔细阅读变更日志或代码更改，在更新时。请参阅carbonphp.com上的指南。

简介 - { MySQL ORM ∪ WebSockets ∪ $_SESSION管理 ∪ PDO数据库管理 }

CarbonPHP 是一个 PHP 8.2+ 库，用于简化自定义动态 Web 应用程序的开发。其主要目标是使 Web 应用程序运行速度极快，性能和可扩展性是绝对最高优先级。CarbonPHP 拥有令人印象深刻的统计数据，有时可以将处理 MySQL 热门网站的轻量级服务器的流量翻倍。C6 可以作为您开发需求的独立骨干，或与其他流行的框架（如 WordPress 或 Laravel）一起使用。

CarbonPHP 的其他目标包括便携性；允许您的 Web 应用程序安装在不同操作系统（Windows、Mac 和 Linux 支持的服务器）上。提供完整的 MySQL ORM REST 生成器和围绕 MySQL 设计的 PHP 编写的数据库工具。Windows PHP 目前缺少一个能够进行分叉的库。如果您的开发需要在 Windows 电脑上进行，请查看 WSL。我希望能够贡献一个用 C（PHP是用 C 编写的）编写的 PHP 库以支持这项任务，但时间是一个因素。如果您想帮助实现这个目标，请通过 Richard@Miles.Systems 联系我。请参阅 Carbonphp.com 上的文档以获取更多信息。对于其他生活在 Windows 地狱之外的人，C6 具有用于标准使用和 WordPress 使用的 Websocket 库类。

快速开始

现有项目

composer require carbonorm/carbonphp

标准

C6 应遵循以下 PHP 标准建议。

PSR-4

PSR-12

SEMVAR

要求

CarbonPHP 目前需要 PHP 8.2 或更高版本。我们努力保持与 PHP 的支持版本保持最新。它使用返回类型对象表示法，不应移植到更早的 PHP 版本。CarbonPHP 将始终努力保持与最新版本的 PHP 保持同步。强烈建议使用 XCache 等代码缓存，因为与代码缓存搭配使用时，Carbon 能够完全不需要 stat() 调用。还建议（但不是必需的）使用 memcached 等内存缓存引擎。如果 PHP8 未得到支持，将随着 C6 的第一个向后兼容版本获得支持。计划在 2022 年夏季取消对 7.4 的支持。

文档

所有函数都应该在代码中使用 PHPDoc 风格的文档。《CarbonPHP.com》也提供了代码库的完整说明。请确保您的命名空间映射正确！";

RESTFUL ORM

CarbonPHP 的最大特点是 MySQL ORM。通过运行可自定义的 CLI 命令，我们的程序将分析您的数据库模式并生成用于操作表的强大类。自动生成的文件可以与用于构建令人愉悦的 RESTFUL 语义结构的类结合使用。以下是使用 REST ORM 的示例。您可以在此处查看生成的源代码。

<?php

$id = Users::Post([
        Users::USER_TYPE => 'Athlete',
        Users::USER_IP => '127.0.0.1',
        Users::USER_SPORT => 'GOLF',
        Users::USER_EMAIL_CONFIRMED => 1,
        Users::USER_USERNAME => Config::ADMIN_USERNAME,
        Users::USER_PASSWORD => Config::ADMIN_PASSWORD,
        Users::USER_EMAIL => 'richard@miles.systems',
        Users::USER_FIRST_NAME => 'Richard',
        Users::USER_LAST_NAME => 'Miles',
        Users::USER_GENDER => 'Male'
    ]);

跨多张表连接。

Users::Get($user, $uid, [
    Users::SELECT => [
        Users::USER_USERNAME,
        Carbon_Locations::STATE
    ],
    Users::JOIN => [
        Users::INNER => [
            Carbon_Location_References::TABLE_NAME => [
                Users::USER_ID => Carbon_Location_References::ENTITY_REFERENCE
            ],
            Carbon_Locations::TABLE_NAME => [
                Carbon_Locations::ENTITY_ID => Carbon_Location_References::LOCATION_REFERENCE
            ]
        ]
    ],
    Users::PAGINATION => [
        Users::LIMIT => 1,
        Users::ORDER => [Users::USER_USERNAME => Users::ASC]
    ]
]);

从前端使用 ORM。此示例展示了多表连接以及聚合函数（GROUP_CONCAT）的使用。

    const {axios} = this.props;

axios.get('/rest/' + C6.carbon_users.TABLE_NAME, {
    params: {
        [C6.SELECT]: [
            C6.carbon_users.USER_USERNAME,
            C6.carbon_users.USER_FIRST_NAME,
            C6.carbon_users.USER_LAST_NAME,
            C6.carbon_users.USER_ID,
            [C6.GROUP_CONCAT, C6.carbon_features.FEATURE_CODE],
            [C6.GROUP_CONCAT, C6.carbon_groups.GROUP_NAME]
        ],
        [C6.JOIN]: {
            [C6.LEFT]: {
                [C6.carbon_user_groups.TABLE_NAME]: [
                    C6.carbon_users.USER_ID,
                    C6.carbon_user_groups.USER_ID
                ],
                [C6.carbon_groups.TABLE_NAME]: [
                    C6.carbon_user_groups.GROUP_ID,
                    C6.carbon_groups.ENTITY_ID
                ],
                [C6.carbon_feature_group_references.TABLE_NAME]: [
                    C6.carbon_groups.ENTITY_ID,
                    C6.carbon_feature_group_references.GROUP_ENTITY_ID
                ],
                [C6.carbon_features.TABLE_NAME]: [
                    C6.carbon_features.FEATURE_ENTITY_ID,
                    C6.carbon_feature_group_references.FEATURE_ENTITY_ID
                ]
            }
        },
        [C6.PAGINATION]: {
            [C6.LIMIT]: 100
        }
    }
}).then(response => this.setState({users: (response.data.rest || [])}));

内置命令行界面

与 Laravel 的 artisan 类似，任何从命令行调用 CarbonPHP 的文件都将执行 CLI 界面。我计划在 Beta 中建立一个用户命令的系统。使用以下命令查看所有可用的命令：

php index.php help

支持

CarbonPHP 的支持提供在 https://github.com/RichardTMiles/CarbonPHP。

法律

使用 CarbonPHP 即表示您同意其软件许可，该许可可在 LICENSE 文件中找到。此许可可能会随版本更新而更改，因此在升级到 C6 的新版本之前，请查看其许可。

致谢

CarbonPHP 由 BDFL Richard Tyler Miles 创建，并受到 Tom Frost 的 Hydrogen 的启发。

贡献者可在贡献者页面找到。

待办事项 - 在 apache 配置上加大力度

https://gist.github.com/RichardTMiles/ae5718aff63ab4633457b6285c825aa2 这将在 CarbonWordPress 中使用，并为 CarbonPHP 的通用使用进行修改。

carbonorm / carbonphp

维护者

详细信息