Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 401]

(no description)

File Size: 94 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

InsertManyResult:: (4 methods):
  __construct()
  getInsertedCount()
  getInsertedIds()
  isAcknowledged()


Class: InsertManyResult  - X-Ref

Result class for a multi-document insert operation.

__construct(WriteResult $writeResult, array $insertedIds)   X-Ref

param: WriteResult $writeResult
param: mixed[]     $insertedIds

getInsertedCount()   X-Ref
Return the number of documents that were inserted.

This method should only be called if the write was acknowledged.

return: integer

getInsertedIds()   X-Ref
Return a map of the inserted documents' IDs.

The index of each ID in the map corresponds to each document's position
in the bulk operation. If a document had an ID prior to inserting (i.e.
the driver did not generate an ID), the index will contain its "_id"
field value. Any driver-generated ID will be a MongoDB\BSON\ObjectId
instance.

return: mixed[]

isAcknowledged()   X-Ref
Return whether this insert result was acknowledged by the server.

If the insert was not acknowledged, other fields from the WriteResult
(e.g. insertedCount) will be undefined.

return: boolean