The MongoDB\BSON\Serializable interface

- « MongoDB\BSON\Persistable::bsonSerialize

- MongoDB\BSON\Serializable::bsonSerialize »

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

# The MongoDB\BSON\Serializable interface

(mongodb >=1.0.0)

## Introduction

Classes that implement this interface may return data to be serialized as a BSON array or document in lieu of the object's public properties.

## Interface synopsis

class MongoDB\BSON\Serializable implements MongoDB\BSON\Type {
/* Methods */
abstract public bsonSerialize(): array|stdClass|MongoDB\BSON\Document|MongoDB\BSON\PackedArray
}

## Changelog

Version | Description
--- | ---
PECL mongodb 1.15.0 | Return types for methods are declared as tentative on PHP 8.0 and newer, triggering deprecation notices in code that implements this interface without declaring the appropriate return types. The `#[ReturnTypeWillChange]` attribute can be added to silence the deprecation notice.

## Table of Contents

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