The MongoDB\BSON\Persistable interface

- « MongoDB\BSON\Type

- MongoDB\BSON\Persistable::bsonSerialize »

- PHP Manual
- MongoDB\BSON
- The MongoDB\BSON\Persistable interface

# The MongoDB\BSON\Persistable interface

(mongodb >=1.0.0)

## Introduction

Classes may implement this interface to take advantage of automatic ODM (object document mapping) behavior in the driver. During serialization, the driver will inject a __pclass property containing the PHP class name into the data returned by MongoDB\BSON\Serializable::bsonSerialize(). During unserialization, the same __pclass property will then be used to infer the PHP class (independent of any type map configuration) to be constructed before MongoDB\BSON\Unserializable::bsonUnserialize() is invoked. See Persisting Data for additional information.

> Note: Even if MongoDB\BSON\Serializable::bsonSerialize() would return a sequential array, injection of the __pclass property will cause the object to be serialized as a BSON document.

## Interface synopsis

class MongoDB\BSON\Persistable implements MongoDB\BSON\Unserializable, MongoDB\BSON\Serializable {
/* Methods */
abstract public bsonSerialize(): array|stdClass|MongoDB\BSON\Document
/* Inherited methods */
abstract public MongoDB\BSON\Serializable::bsonSerialize(): array|stdClass|MongoDB\BSON\Document|MongoDB\BSON\PackedArray
abstract public MongoDB\BSON\Unserializable::bsonUnserialize(array `$data`): void
}

## Table of Contents

- MongoDB\BSON\Persistable::bsonSerialize — Provides an array or document to serialize as BSON