README

Paradox - 为 ArangoDB 设计的美丽 ODM (对象文档管理器)

主分支（稳定）：     开发分支（不稳定）：     覆盖率：

支持的 ArangoDB 版本

2.4.0

欢迎

Paradox 是一个优雅的对象文档管理器 (ODM)，适用于 ArangoDB 文档/图数据库服务器。它设计得简单且易于表达。我们更倾向于约定而非配置，并避免为每个方法传递大量的配置选项。Paradox 采用 AQL 而不是发明自己的查询语言。最后，Paradox 设计得易于学习和使用。

Paradox 受 RedBean 启发。

这是 Paradox 的工作方式的一个示例

$client = new Paradox\Client('tcp://localhost:8529', 'root', 'password');

$document = $client->dispense('people'); //Create a people document to be stored in the people collection
$document->set('name', 'john');
$document->set('age', 20);

$id = $client->store($document); //Save the document to the server

$document = $client->load('people', $id); //Load the document from the server

$client->delete($document); //Delete the document from the server

主要特性

• 事件系统，向监听器公开各种事件。
• 内置对模型的内置支持，用于建模领域对象。
• 一个调试器，可以快速调试请求和响应。
• 各种查找器，使查找文档、顶点和边变得极其简单。

安装

Paradox 可以使用 composer 或从 git 安装。

使用 composer

只需将 Paradox 添加到您的 composer.json

{
    "require": {
        "F21/Paradox": "dev-master"
    }
}

然后使用 composer 生成的自动加载器

require_once 'vendor/autoload.php';

从 git 克隆

首先，通过将其克隆到您的项目中安装 ArangoDB-PHP。然后，包括自动加载器

require_once '/path/to/ArangoDB-PHP/lib/triagens/ArangoDb/autoloader.php'
\triagens\ArangoDb\Autoloader::init();

只需将此存储库克隆到您的项目中并包括捆绑的自动加载器

require_once '/path/to/paradox/Paradox/Autoloader.php'
Paradox\Autoloader::init();

提示：由于 ArangoDB-PHP 和 Paradox 使用 PSR-0 对类文件进行组织，您可以使用自己的自动加载器。

使用 Paradox

如果您是 Paradox 的新用户，我们建议您阅读我们 wiki 上的文档。

版本控制

Paradox 跟踪 ArangoDB 的版本。例如，如果 Paradox 的版本为 1.2.x，则它预计将与 ArangoDB 的 1.2.x 版本一起工作。请注意，我们仅跟踪 ArangoDB 的大版本和小版本。补丁版本（最后一个数字）与 ArangoDB 独立，并针对 Paradox。

贡献

Paradox 是一个非常新的库，因此您的问题和拉取请求（PR）的贡献是受欢迎的 :)

在贡献时，请注意以下几点

• 代码应符合 psr-2 标准 + symfony。有关标准列表，请参阅 php-cs-fixer 页面上的列表。
• 如果您想使用 php-cs-fixer，请使用 php-cs-fixer fix /path/to/project --level=all 运行它。
• 在提交 PR 时，请确保还包含测试，以测试您添加的所有代码路径。

许可证

Paradox 根据 Apache2 许可证授权。