技术文档 - MongoDB 简易文档操作库 ActiveMongo 使用指南

1. 安装指南

ActiveMongo 是一个遵循文档激活模式的 MongoDB 抽象库。在开始使用之前，请确保您的环境中已经安装了 MongoDB，并且 PHP 环境配置正确。

PHP 环境要求

• PHP 5.3 或更高版本
• 已安装 MongoDB 扩展

安装步骤

1. 从 GitHub 下载 ActiveMongo 源代码。
2. 将下载的源代码放入项目的合适位置。
3. 在您的 PHP 项目中引入 ActiveMongo 的自动加载文件。

require 'path/to/ActiveMongo/autoload.php';

4. 确保您的 MongoDB 服务正在运行。

2. 项目使用说明

ActiveMongo 提供了简单且高效的 MongoDB 操作方式。以下是主要功能的使用说明：

连接 MongoDB

ActiveMongo 会在需要时自动连接 MongoDB。

定义集合

将每个集合定义为一个类，类名通常与集合名对应。

class User extends Document {
    protected static $collection = 'users';
}

数据集迭代

ActiveMongo 支持对数据集进行迭代。

foreach ($users as $user) {
    echo $user->username;
}

保存文档

ActiveMongo 提供了高效的保存方法，用于创建或更新文档。

$user = new User();
$user->username = 'example';
$user->save();

查询接口

ActiveMongo 提供了简单的查询接口，并允许在子类中获取 MongoCollection 进行复杂查询。

$users = User::find(['username' => 'example']);

删除文档

ActiveMongo 支持删除当前对象或整个集合。

$user->delete();
User::drop();

属性过滤

ActiveMongo 支持按属性进行过滤。

$users = User::find(['age' => ['$gte' => 18]]);

嵌套文档更新

ActiveMongo 支持嵌套文档的高效更新。

$user->profile->age = 29;
$user->save();

钩子支持

ActiveMongo 支持在关键操作前后的钩子。

class User extends Document {
    protected static function pre_save($operation, &$document) {
        // 钩子逻辑
    }
}

集合安装

ActiveMongo 提供了简单的集合安装方法，用于创建索引和分片键。

User::install();

引用文档

ActiveMongo 支持引用其他文档，并提供了一种高效的方式来加载它们。

$profile = $user->profile->load();

动态引用

ActiveMongo 允许保存一个查询以供以后执行。

$dynamicQuery = User::query(['username' => 'example']);

3. 项目 API 使用文档

ActiveMongo 的 API 文档提供了每个类和方法的具体使用说明。以下是部分 API 的简要概述：

• Document: 所有文档类的基类，提供了基础文档操作方法。
• Collection: 代表一个 MongoDB 集合，提供了集合操作方法。
• Query: 用于构建和执行查询。

具体 API 使用方法，请参考项目代码注释或官方文档。

4. 项目安装方式

如前所述，ActiveMongo 可以通过从 GitHub 下载源代码的方式进行安装。此外，您也可以使用 Composer 这样的依赖管理工具来安装。

使用 Composer 的方式如下：

composer require crodasorg/activemongo

确保在 composer.json 文件中已经配置了 MongoDB 的依赖。

以上就是 ActiveMongo 的技术文档，希望对您使用该库有所帮助。