カスタムデータ型

注意

このチュートリアルでは、 MongoDB\BSON\Persistable を使用してカスタムデータ型を実装する説明を説明しますインターフェース（MongoDB 拡張機能）。MongoDB 永続化ロジックをビジネスロジックから分離するには、代わりにコーデックの使用を検討してください。例については、コーデックのチュートリアルを参照してください。

MongoDB PHP 拡張機能とライブラリは、直列化と逆直列化中にカスタムクラスをサポートします。 PHP の DateTimeIn Mutable のクラスは特定の時点で保存されます。

拡張機能は、サーバーと通信するときにオブジェクトを含む PHP 変数を BSON に直列化し、サーバーからデータを受信するときに BSON を PHP 変数に逆直列化します。

MongoDB\BSON\Persistable を実装することで動作に影響を与えることができますインターフェースを使用します。クラスがこのインターフェースを実装すると、直列化時に bsonSerialize メソッドが呼び出されます。このメソッドは、BSON に変換してデータベースに保存する配列または stdClass オブジェクトを返すのを担当します。そのデータは、後でデータベースから読み取りを行う際にオブジェクトを再構築するために使用されます。

例として、 LocalDateTimeクラスを示します。このクラスは MongoDB\BSON\UTCDateTime をラップしますデータ型とタイムゾーン。

<?php
/* Custom document class that stores a UTCDateTime and time zone and also
 * implements the UTCDateTime interface for portability. */
class LocalDateTime implements \MongoDB\BSON\Persistable, \MongoDB\BSON\UTCDateTimeInterface
{
    private $utc;
    private $tz;
    public function __construct($milliseconds = null, \DateTimeZone $timezone = null)
    {
        $this->utc = new \MongoDB\BSON\UTCDateTime($milliseconds);
        if ($timezone === null) {
            $timezone = new \DateTimeZone(date_default_timezone_get());
        }
        $this->tz = $timezone;
    }
?>

MongoDB\BSON\Perstable インターフェースに設定されている場合、 bsonSerialize を実装するにはクラスが必要です。 bsonUnserialize 使用して複数のドキュメントを挿入できます。bsonSerialize 内メソッドとして、永続化する必要がある 2 つの値である配列が返されます。これは、 MongoDB\BSON\UTCDateTime で表される、UNIXエポックからのミリ秒単位の点です。オブジェクトと、 Olson タイムゾーン識別子を含む string 。

<?php
    public function bsonSerialize()
    {
        return [
            'utc' => $this->utc,
            'tz' => $this->tz->getName(),
        ];
    }
?>

この拡張機能により、ドキュメントに__pclassフィールドが追加され、それもデータベースに保存されます。このフィールドには PHP クラス名が含まれているため、逆直列化時に拡張機能は保存されたオブジェクトの再作成に使用するクラスを認識できます。

ドキュメントがデータベースから読み取られると、拡張機能はフィールドの有無を検出し、__pclass MongoDB\BSON\Persistable::bsonUnserialize を実行しますオブジェクトの元の状態を復元する役割を持つメソッド。

以下のコードでは、フィールドとutc tzフィールドのデータが正しいタイミングであることを確認し、その値を 2 つのプライベートプロパティに割り当てます。

<?php
    public function bsonUnserialize(array $data)
    {
        if ( ! isset($data['utc']) || ! $data['utc'] instanceof \MongoDB\BSON\UTCDateTime) {
            throw new Exception('Expected "utc" field to be a UTCDateTime');
        }
        if ( ! isset($data['tz']) || ! is_string($data['tz'])) {
            throw new Exception('Expected "tz" field to be a string');
        }
        $this->utc = $data['utc'];
        $this->tz = new \DateTimeZone($data['tz']);
    }
?>

クラスが MongoDB\BSON\UTCDateTimeInterface も実装していることに注意してください。インターフェースを使用します。このインターフェースは、 MongoDB\BSON\UTCDateTime の 2 つの非コンストラクターメソッドを定義します。クラス。

既存の BSON クラスを囲むラッパーは、それぞれのインターフェース（ MongoDB\BSON\UTCDateTimeInterface ）。これにより、ラッパーオブジェクトは元のラップされていないバージョンと同じコンテキストで使用できます。また、インターフェースに対して常に型ヒント（ MongoDB\BSON\UTCDateTimeInterface ）で、具象クラス（MongoDB\BSON\UTCDateTime ）、ラップされたオブジェクトがメソッドに受け入れられなくなるためです。

新しいtoDateTime メソッドでは、 DateTime が返されます MongoDB\BSON\UTCDateTime に関する UTC タイムゾーンではなく、ローカルタイムゾーンが設定されたオブジェクトは通常、戻り値でを使用します。

<?php
    public function toDateTime()
    {
        return $this->utc->toDateTime()->setTimezone($this->tz);
    }
    public function __toString()
    {
        return (string) $this->utc;
    }
}
?>

クラスが定義されたため、ドキュメント内で使用できるようになりました。以下のスニペットは、 LocalDateTimeオブジェクトから BSON に、 LocalDateTimeに戻るラウンドトリップを示しています。

<?php
$bson = MongoDB\BSON\Document::fromPHP(['date' => new LocalDateTime]);
$document = $bson->toPHP();
var_dump($document);
var_dump($document->date->toDateTime());
?>

その出力は次のとおりです。

object(stdClass)#1 (1) {
  ["date"]=>
  object(LocalDateTime)#2 (2) {
    ["utc":"LocalDateTime":private]=>
    object(MongoDB\BSON\UTCDateTime)#3 (1) {
      ["milliseconds"]=>
      string(13) "1533042443716"
    }
    ["tz":"LocalDateTime":private]=>
    object(DateTimeZone)#4 (2) {
      ["timezone_type"]=>
      int(3)
      ["timezone"]=>
      string(13) "Europe/London"
    }
  }
}
object(DateTime)#5 (3) {
  ["date"]=>
  string(26) "2018-07-31 14:07:23.716000"
  ["timezone_type"]=>
  int(3)
  ["timezone"]=>
  string(13) "Europe/London"
}

Olson タイムゾーン識別子を別のフィールドに保存することも MongoDB の集計フレームワークと連携し、特定のタイムゾーンに応じて日付操作、形式、クエリが可能になります。

戻る

特殊データ形式

コーデック