README

这是mongoyii的PHP7版本，专为与新的MongoDB驱动程序一起工作而设计

关于本文档

这不是对旧文档的完全重写，而是仅详细说明PHP7扩展背后的新功能/想法。

如果您是mongoyii的新用户，请先阅读旧文档。.

测试应用程序

为此扩展提供了新的测试应用程序，这是对旧测试应用程序的重新编写。

您可以在以下位置找到它.

运行内置测试与之前相同。

问题/错误 & 问题

请使用新的Github问题跟踪器处理您所有的问题和错误报告。如果您在论坛中发布，请将其链接到Github问题跟踪器。

您可以通过以下链接访问Github问题跟踪器.

版本控制

此扩展，如之前一样，使用语义版本控制2.0.0。

许可

此扩展的许可也保持不变，BSD 3条款。简单来说：您可以随意使用它。

关于变更的说明

在介绍此扩展中发生了哪些变化之前，值得注意的是，许多更改并非因为我想要这样做，而是因为MongoDB驱动程序和PHPLib它们已发布的新版本与旧驱动程序相比发生了巨大的变化，我被迫遵守这种新的工作标准。

您可能喜欢驱动程序和其PHPLib的一些部分，而其他部分您可能绝对不喜欢。

安装

所有安装现在都通过composer完成。我不推荐手动安装，因为此扩展需要MongoDB发布的驱动程序和PHPLib（这些也仅在composer上提供）。

要安装，请执行（对于 dev-master）

composer require sammaye/mongoyii-php7:*

您可以在以下位置找到packagist仓库.

命名空间

此扩展完全命名空间为

sammaye\mongoyii

不要担心！这不会给旧应用程序带来太多变化。我花了大约3个小时来重新编写我的测试应用程序。

例如，以下是如何在测试应用程序中声明一个新模型（取自我的测试应用程序）

use MongoDB\BSON\ObjectID;
use MongoDB\BSON\UTCDateTime;

use sammaye\mongoyii\Document;

/**
 * Represents the article itself, and all of its data
 */
class Article extends Document
{
}

这将为您提供与之前相同的所有内容。

现在让我向您展示如何在您的 main.php 中配置 session 和 cache 组件（同样取自我的测试应用程序）

'session' => array(
	'class' => 'sammaye\mongoyii\util\Session',
),
'cache' => array(
	'class' => 'sammaye\mongoyii\util\Cache',
),

所以您可以看到命名空间的使用非常容易上手。

作为最后的例子，让我们看看一个行为

public function behaviors()
{
	return [
		'TimestampBehavior' => [
			'class' => 'sammaye\mongoyii\behaviors\TimestampBehavior' 
			// adds a nice create_time and update_time Mongodate to our docs
		]
	];
}

所以，您可以看到：在此扩展中使用命名空间非常简单。如果您有任何疑问，不知道使用哪个命名空间，请查找您项目中的文件，查看第一行，其中提到类似于

namespace sammaye\mongoyii\validators;

将类名添加到那里，您就有了命名空间类。

声明扩展

这部分的变化最大。首先，为什么不展示一个我使用的例子

'mongodb' => [
	'class' => 'sammaye\mongoyii\Client',
	'uri' => 'mongodb://sam:blah@localhost:27017/admin',
	'options' => [],
	'driverOptions' => [],
	'db' => [
		'super_test' => [
			'writeConcern' => new WriteConcern(1),
			'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
		]
	],
	'enableProfiling' => true
],

现在，让我们来分解一下

• 我声明类为 sammaye\mongoyii\Client。这是必需的，且不会是可变的。
• uri 是我的服务器连接字符串，遵循 PHP 文档 中规定的标准
• options 直接与 PHP 文档 中的 uri 选项相关，也允许连接副本集等
• 同样，驱动器选项也在 PHP 文档 中
• enableProfiling 允许您像以前一样分析查询
• db 现在已改为按要连接的数据库名称进行索引的数组。每个索引的值是 PHPLib Database 对象 的选项

基本上就是这样。写入关注、读取关注以及其他属性现在按数据库完成，而不是在客户端级别。

如果您在配置中还有其他数据库，并且想将特定数据库设置为默认值，可以添加如下的 active 选项

'super_test' => [
	'writeConcern' => new WriteConcern(1),
	'readPreference' => new ReadPreference(ReadPreference::RP_PRIMARY),
	'active' => true
]

客户端 __get 只获取数据库吗？

是的，这是新旧驱动器之间最大的变化。

客户端、数据库和集合之间现在有一个明确的分离。

因此，要获取数据库，为获取集合做准备，您现在需要这样做

Yii::$app->mongodb->selectDatabase()

身份验证

在新 PHP 驱动器中，没有 auth() 函数。您必须在 mongodb 组件的 uri 中进行身份验证。您将决定如何最好地处理您的身份验证数据库，但我决定将所有用户放入 admin 数据库。这使得在一个数据库中进行身份验证然后按需切换变得非常容易。

使用多个数据库

如您所见，此扩展考虑了多个数据库。

如果您正在使用身份验证，请确保您以某种方式布置用户，以便您只需要一个套接字连接（像我上面那样），或者为每次需要身份验证创建一个新组件。您不能再在连接后进行身份验证。

至于重新编码 Document 的 getDbConnection()，您现在使用 getCollection() 如此（由于我提到的分离）

public function getCollection()
{
	return $this
		->getDbConnection()
		->selectDatabase('my_other_db_not_default')
		->{$this->collectionName()};
}

您就完成了...

如果您确实知道自己在做什么，您实际上可以设置一个数据库为 active，使其成为一系列过程中的默认数据库

Yii::$app->mongodb->selectDatabase('my_other_db', ['active' => true]);

但这仅适用于高级用户！

查询

这是与 Yii1 最大的不同之处。其他一切保持不变，无需记录。

基本上，由于新驱动器不再使用游标，而是使用流，我已经将 EMongoDBCriteria 对象重新编码为 Query（如 Yii2），并且它甚至与 Yii2 中的用法相似。

然而，值得注意的是，find() 和 findOne() 的 Document 函数返回与正常 Yii1 相同的结果。那里没有变化。

值得注意的是，查询的方式已经改变，这与驱动器一致

Article::find(
	[
		'title' => 'Test'
	],  
	[
		'sort' => ['date_created' => -1],
		'limit' => 2
		// etc
	]
)

这是由于 MongoDB 使用贪婪加载的流。因此，整个查询必须在形成 PHP "游标" 对象之前定义。

了解如何使用新驱动器进行查询的一个好方法是查看 MongoDB PHPLib 的 GitHub 文档。

作用域

由于EMongoCriteria的变更，您可能需要重新编写模型作用域以使其正常工作。一个很好的例子是

[
	'condition' => ['deleted' => 0],
	'select' => ['_id' => 1],
	'sort' => ['date' => -1],
	'limit' => 2
	'skip' => 1
]

公开的变化并不多，最大的变化是我不再在SQL的SELECT中使用project这个词。MongoDB仍然使用，但我不再使用了。

为什么没有EMongoCriteria？

这是出于产生干净和可工作的查询的需求而提出的决策。

最后，我决定使我的查询更像Yii2。这实际上意味着您现在可以这样做

$docs = new Query([
	'from' => 'colllection',
	'condition' => ['what' => 'ever'],
	'limit' => 1
])->all()

因此，这是一个从Yii1到Yii2的突破，但这是一个很好的突破。

查询日志

查询日志现在更加广泛。它不仅会在模型中记录查询，还会记录所有查询，这得益于一个小小的重写，这个重写本应该包含在原始扩展中。

现在，每次您从配置中的MongoDB组件获取集合时，它将返回我自己的自定义Collection类，该类具有内置的日志记录功能。

希望这可以减少构建应用程序时的猜测工作。

关于怪癖的说明

子文档

MongoDB的PHPLib将子文档作为ArrayObject返回。这意味着在使用它们进行显示和表单等之前，您需要首先通过(array)$subdoc进行类型转换。

BSON序列化

请确保您不要将ObjectID用作yii会话ID。这是因为这个问题^{[1](https://jira.mongodb.org/browse/PHPC-460)}，您不能序列化BSON对象。

以下是一个潜在的UserIdentity authenticate()方法示例，您可以使用它（也来自我的示例应用程序）

public function authenticate()
{
	$record=User::model()->findOne(array('username' => $this->username));
	if ($record === null) {
		$this->errorCode = self::ERROR_USERNAME_INVALID;
	} else if ($record->password !== crypt($this->password, $record->password)) { // check crypted password against the one provided
		$this->errorCode = self::ERROR_PASSWORD_INVALID;
	} else {
		$this->_id = (String)$record->_id;
		$this->errorCode = self::ERROR_NONE;
	}
	return !$this->errorCode;
}

请注意这一行：$this->_id = (String)$record->_id;它非常重要，否则将无法正常工作！

DBRef已弃用

是的，它已经弃用了。如果您正在使用它，您在使用此扩展之前需要将其删除。在新的驱动程序中根本没有任何处理它的功能。

未完成的事情

GridFS

这不是我的错。实际上，在PHPLib中还没有！

所以我们...完成了！

这就结束了。其他一切都差不多，酷吧？

请让我知道如果您遗漏了什么或需要更好地解释某些内容。