README

Hoa 是一套 模块化、可扩展 和 结构化 的 PHP 库。
此外，Hoa 致力于成为工业界和研究界之间的桥梁。

Hoa\Protocol

这个库提供了 hoa:// 协议，它是一种抽象资源访问的方法。

了解更多.

安装

使用 Composer，要将此库包含在依赖项中，您需要要求 hoa/protocol

$ composer require hoa/protocol '~2.0'

有关更多安装程序，请参阅源代码页面。

测试

在运行测试套件之前，必须安装开发依赖项

$ composer install

然后，运行所有测试套件

$ vendor/bin/hoa test:run

有关更多信息，请参阅贡献者指南。

快速使用

我们提出了一种快速概述，说明如何列出当前协议的树结构，如何解析一个 hoa:// 路径，最后如何在此树中添加一个新节点。

探索资源

首先，要获取 hoa:// 协议的实例，您应该在代表协议树根的 Hoa\Protocol\Protocol 类上使用静态 getInstance 方法

echo Hoa\Protocol\Protocol::getInstance();

/**
 * Might output:
 *   Application
 *     Public
 *   Data
 *     Etc
 *       Configuration
 *       Locale
 *     Lost+found
 *     Temporary
 *     Variable
 *       Cache
 *       Database
 *       Log
 *       Private
 *       Run
 *       Test
 *   Library
 */

我们看到有 3 个“子根”

1. Application，表示应用程序的资源，如公共文件（在 Public 节点中）、模型、资源等，与应用程序相关的一切
2. Data，表示应用程序所需的数据，如配置文件、区域设置、数据库、测试等。
3. Library，表示 Hoa 的所有库。

因此，hoa://Library/Protocol/README.md 表示指向此实际文件的抽象路径。无论你在磁盘上的哪个位置，此路径始终有效，并指向此文件。这在需要访问配置文件（如 hoa://Data/Etc/Configuration/Foo.php）的应用程序中很有用：也许 Data 目录不存在，也许 Etc 或 Configuration 目录也不存在，但 hoa:// 树中的每个节点都会解析为一个包含您的 Foo.php 配置文件的合法目录。这是一个 资源的抽象路径。

解析路径

我们可以通过使用全局 resolve 函数或 Hoa\Protocol\Protocol::resolve 方法来解析路径

var_dump(
    resolve('hoa://Library/Protocol/README.md')
);

/**
 * Might output:
 *     string(37) "/usr/local/lib/Hoa/Protocol/README.md"
 */

在树中注册新节点

hoa:// 协议是一个树。因此，要在树中添加一个新的“组件”/“目录”，我们必须创建一个节点并将其注册为现有节点的子节点。因此，在下面的示例中，我们将创建一个指向 /Volumes 目录的 Usb 节点，并将其添加为新的子根，即根的直接子节点

$protocol   = Hoa\Protocol\Protocol::getInstance();
$protocol[] = new Hoa\Protocol\Node('Usb', '/Volumes/');

现在我们做到了。现在，解析 hoa://Usb/StickA 可能会指向 /Volumes/StickA（如果存在）

var_dump(
    resolve('hoa://Usb/StickA')
);

/**
 * Might output:
 *     string(15) "/Volumes/StickA"
 */

文档

Hoa\Protocol 的黑客手册 包含有关如何使用此库及其工作方式的详细信息。

要本地生成文档，请执行以下命令

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

更多文档可以在项目的网站上找到： hoa-project.net。

获取帮助

主要有两种方式获取帮助

• 在#hoaproject IRC频道，
• 在users.hoa-project.net论坛。

贡献

你想贡献吗？谢谢！一份详细的贡献指南解释了你需要知道的一切。

许可证

Hoa遵循新的BSD许可证（BSD-3-Clause）。请参阅LICENSE以获取详细信息。